INinterlace
Payouts

List all payee bank accounts

Retrieves a paginated list of all payee bank accounts under the current user.

get/open-api/v3/payees

Request

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

Query parameters

accountIdstring required

The UUID of the account.

limitstring number

Limits the number of items to be returned.

pagestring number

The page to be returned, counting from 1 as the first page.

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

Currency code.

Example:USD
userNamestring

Recipient's username, automatically generated by concatenating first name and last name. Example: JohnSmith

Example:JohnSmith

Response

OK

codestring

Error code

messagestring

Error message

Example response

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

Changes

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