WePay logo
      Nothing Found

Create a payout

post/payouts

Note: This method is a closed BETA and requires permission for use. The POST /payouts call allows your platform to create an on-demand payout. Payouts allow your merchants to receive their funds from your platform.

SecurityappIdAuth and appTokenAuth
Request
header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
required
string
Request Body schema: application/json
account_id
required
string

Merchant's account ID associated with the payout.

currency
required
string

ISO 4217 currency code. Possible values include: CAD & USD. Note: as of today, currency supports a single value.

Enum: Description
USD

United States Dollar

CAD

Canadian Dollar

… 1 more
object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

Array of objects or null

Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects.

reference_id
string or null [ 1 .. 255 ] characters

A custom reference ID for your platform to track the object. It can be any string.

statement_descriptor
string

A free-form string that appears on the merchant's bank statement. It is tied to a single payout.

Responses
201
Response Schema: application/json
id
required
string

ID of the payout, generated by WePay when the payout is created.

resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
payouts
path
required
string

Path of resource and resource ID.

required
object or null

Details the owner resource and owner path.

amount
integer

Amount in cents.

api_version
string
complete_time
integer or null <int64> >= 0

The time (in UNIX) the payout was completed.

create_time
integer <int64> >= 0

The time (in UNIX) when the payout was created.

currency
string

ISO 4217 currency code. Possible values include: CAD & USD. Note: as of today, currency supports a single value.

Enum: Description
USD

United States Dollar

CAD

Canadian Dollar

… 1 more
object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

object or null
object

Payout method associated with payouts.

Array of objects or null or null
Array of objects or null

Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects.

reference_id
string or null [ 1 .. 255 ] characters

A custom reference ID for your platform to track the object. It can be any string.

statement_descriptor
string

A free-form string that appears on the merchant's bank statement. It is tied to a single payout.

status
string
Enum: Description
pending

WePay is currently processing this payout. See the pending_reasons structure for additional information.

completed

WePay has finished processing this payout. Note: Other bank institutions must also process payouts to bank accounts before the merchant will see the deposit in their account.

… 1 more
object or null

When a non-payment resource (i.e. recoveries or payouts) fails to process, fetch this transaction record in order to maintain accurate accounting of the merchant's balance.

object or null

When a payout has occurred, fetch this transaction record to account for the debit from the merchant.

400

INVALID_PARAMS, ACCOUNT_CANNOT_PROCESS_PAYOUTS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "account_id": "e40882c5-1ba7-4cda-b3f1-a1eee08b8f1f",
  • "currency": "USD",
  • "statement_descriptor": "3223 Hanover St",
  • "reference_id": "unique_id_f40m_p4rtn3r",
  • "custom_data": {
    • "my_key": "my_value"
    },
  • "rbits": [
    • {
      • "address": {
        • "origin_address": {
          • "city": "Sunnyvale",
          • "country": "US",
          • "line1": "20 Main Street",
          • "postal_code": "94085",
          • "region": "CA"
          }
        },
      • "receive_time": 1367958263,
      • "source": "partner_database",
      • "type": "address"
      }
    ]
}
Response samples
application/json
{
  • "id": "00000000-0000-0000-0000-00000a51d642",
  • "path": "/payouts/00000000-0000-0000-0000-00000a51d642",
  • "currency": "USD",
  • "statement_descriptor": "3223 Hanover St",
  • "owner": {
    • "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
    • "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
    • "resource": "accounts"
    },
  • "payout_method": {
    • "id": "00000000-6261-5553-0000-000000000bf2",
    • "path": "/payout_methods/00000000-6261-5553-0000-000000000bf2",
    • "resource": "payout_methods"
    },
  • "resource": "payouts",
  • "status": "pending",
  • "pending_reasons": [
    • {
      • "reason_code": "PROCESSING",
      • "reason_message": "Payout is being processed.",
      • "details": [
        • {
          • "detail_code": "processing",
          • "detail_message": "The Payout is currently under processing."
          }
        ]
      }
    ],
  • "reference_id": "unique_id_f40m_p4rtn3r",
  • "api_version": "3.1",
  • "custom_data": {
    • "my_key": "my_value"
    },
  • "rbits": [
    • {
      • "address": {
        • "origin_address": {
          • "city": "Sunnyvale",
          • "country": "US",
          • "line1": "20 Main Street",
          • "postal_code": "94085",
          • "region": "CA"
          }
        },
      • "receive_time": 1367958263,
      • "source": "partner_database",
      • "type": "address"
      }
    ]
}