Sign in

v1

latestOpenAPI 3.0.02026-07-244074117.0 KB
Payout Accounts

Create a payout account

Create a payout account. This is used to customize the payout for a merchant's orders

post/v4/payout-accounts

Request body

namestring required

A nickname for this bank account

businessNamestring

The business name associated with the bank account

emailstring

The email address associated with the bank account for notifications

customerIdstring

The customer ID associated with the bank account. Only to be used if the payout account should be associated with a customer.

routingNumberstring required

Bank routing number

accountNumberstring required

Bank account number

taxIdstring required

Federal Tax ID

isDefaultAccountboolean

Whether the account is the default used for payouts. Defaults to false

accountType'checking' | 'savings' required

Account Type

externalIdstring

External ID for your reference

Example request

{
  "address": {
    "line1": "123 Main St",
    "city": "San Francisco",
    "country": "US",
    "state": "CA",
    "postalCode": "94107"
  }
}

Response

The created payout account.

idstring required

Payout account ID

namestring required

Name

externalIdstring

External ID

isDefaultAccountboolean required

Whether this is the default account for the merchant

createdAtstring date-time required

Timestamp of when account was create

updatedAtstring date-time required

Timestamp of when account was last updated