v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

Bank Accounts

Create Bank Account

Create a Bank Account to be used as either a funding source or a Disbursement destination. Store the returned :id and use it for a make_payment Item Action call. The :id is also referred to as a token when involving Bank Accounts.

post/bank_accounts

Request body

user_idstring required

User ID

bank_namestring required

Bank name

account_namestring required

Account name

routing_numberstring required

Required conditionally - Routing number / BSB number. See Bank account formats by country.

account_numberstring required

Account number. See Bank account formats by country.

account_type'savings' | 'checking' required

Bank account type (savings or checking)

holder_type'personal' | 'business' required

Holder type (personal or business)

countrystring required

ISO 3166-1 alpha-3 country code (3 char)

payout_currencystring

ISO 4217 alpha-3 currency code. This parameter determines the currency with which funds are paid out.

currencystring

ISO 4217 alpha-3 currency code. This is an optional field and if not provided, the item will be created with the default currency of the marketplace.

Example request

{
  "user_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "bank_name": "Bank of Australia",
  "account_name": "Samuel Seller",
  "routing_number": "111123",
  "account_number": "111234",
  "account_type": "checking",
  "holder_type": "personal",
  "country": "AUS",
  "payout_currency": "AUD",
  "currency": "AUD"
}

Response

Example response

{
  "bank_accounts": {
    "active": true,
    "id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
    "currency": "AUD",
    "verification_status": "not_verified",
    "bank": {
      "bank_name": "Bank of Australia",
      "country": "AUS",
      "account_name": "Samuel Seller",
      "routing_number": "XXXXX3",
      "account_number": "XXX234",
      "holder_type": "personal",
      "account_type": "checking",
      "direct_debit_authority_status": "approved"
    }
  }
}