Create Platform Merchant Bank Account

Create a bank account for a platform sub-merchant

SecurityLimepay-Token
Request
path Parameters
merchantId
required
string
Request Body schema: application/json
bankName
string

Name of financial institution where the account is held.

accountName
required
string

Name of the person or business that holds the account

accountNumber
required
string

Account number of the bank account. Should be all digits.

country
required
string (Country)
Enum: "AU" "NZ" "ZA"
currency
required
string

3 letter ISO code indicating the currency of the bank account.

routingNumber
required
string

Branch code (also known as BSB), 6 digits. Leave blank for New Zealand.

setAsPrimary
boolean

Make this account the primary bank account for the merchant. If not provided, the account will be set as primary.

Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/marketplaces/merchants/{merchantId}/accounts
Request samples
application/json
{
  • "bankName": "string",
  • "accountName": "string",
  • "accountNumber": "string",
  • "country": "AU",
  • "currency": "AUD",
  • "routingNumber": "string",
  • "setAsPrimary": true
}
Response samples
application/json
{
  • "accountId": "xacc_ZwQUxjTkqS0K1BZg"
}
Copyright © April Solutions 2023. All right reserved.