Payouts

Create a payee bank account

Creates a new bank account for a payee under the current user, returning the account details upon success.

post/open-api/v3/payee

Request

  • Base URL
    https://api-sandbox.interlace.money
  • URL
    https://api-sandbox.interlace.money/open-api/v3/payee
  • Auth
    API key in header x-access-token

Request body

accountIdstring required

The UUID of the account.

firstNamestring

Recipient's first name. Example: John

lastNamestring required

Recipient's last name. Example: Smith

paymentType'COMPANY' | 'INDIVIDUAL' required

Payment to company or individual bank account.

currency'CNH' | 'USD' | 'HKD' | 'GBP' | 'EUR' | 'AUD' | 'AED' | 'ILS' | 'CAD' | 'SGD' | 'MYR' | 'JPY' | 'IDR' required

Currency code.

accountNumberstring required

Account number.

bankNamestring

Bank name.

paymentMethod'ACH' | 'EFT' | 'SEPA' | 'FPS' | 'CHATS' | 'LOCAL' | 'IBG' | 'FAST' | 'AUS_PAY_NET' | 'FED_WIRE' | 'SWIFT' required

Payment method. This parameter belongs to LOCAL except SWIFT, For example, ACH is a local in the United States.

commentsstring

Remark

Example request

{
  "firstName": "John",
  "lastName": "Smith"
}

Response

OK

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter",
  "data": {
    "userName": "JohnSmith"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.