2. List Account

  • Introduction:
    This API is used to retrieve a list of payer or beneficiary accounts for a merchant.

  • Endpoint: /v1/transfer/list-account

  • Method: GET

Request Parameters

Field Type Required Description
accountId string N Unique identifier of the account. If provided, no other parameter is required.
accountType string N Role of the account: either payer or beneficiary. Required if accountId is not provided.
networkType string N Settlement network: one of PIX, SWIFT, SEPA, LOCAL. Required if accountId is not provided.
country string N Country code in ISO 3166-1 alpha-2 format (e.g., BR, US, HK). Required if accountId is not provided.
currency string N Currency code in ISO 4217 format (e.g., BRL, USD, EUR). Required if accountId is not provided.
createTimeStartPeriod string N account create time start period (yyyy-MM-dd HH:mm:ss)
createTimeEndPeriod string N account create time end period (yyyy-MM-dd HH:mm:ss)

Parameter Rule:

  • If accountId is provided, you do not need to provide any other parameters; the returned list will contain single record of the specified one.
  • If accountId is not provided, you may specify any combination of the other parameters to filter and list matching accounts.
  • It is advisable to configure the createTimeStartPeriod and createTimeEndPeriod parameters to optimize performance.

Response

Request through accountID:

{
  "status": 200,
  "code": null,
  "msg": "OK",
  "data": [
    {
      "accountId": "acct_94812ad91a",
      "status": "active",
      "accountType": "payer",
      "networkType": "PIX",
      "country": "BR",
      "currency": "USD",
      "accountInfo": {
        "cpfOrCnpj": "12345678900",
        "bankCode": "001",
        "accountNumber": "56789-0",
        "accountHolderName": "João Silva"
      }
    },
  ],
  "traceId": "e8b6f3c4-1a2d-4f5e-b678-1234567890ab"
}

Request through accountType/networkType/country/currency:

{
  "status": 200,
  "code": null,
  "msg": "OK",
  "data": [
    {
      "accountId": "acct_94812ad91a",
      "status": "active",
      "accountType": "payer",
      "networkType": "PIX",
      "country": "BR",
      "currency": "USD",
      "accountInfo": {
        "cpfOrCnpj": "12345678900",
        "bankCode": "001",
        "accountNumber": "56789-0",
        "accountHolderName": "João Silva"
      }
    },
    {
      "accountId": "acct_1122334455",
      "status": "inactive",
      "accountType": "beneficiary",
      "networkType": "SEPA",
      "country": "DE",
      "currency": "EUR",
      "accountInfo": {
        "accountHolderName": "Müller GmbH",
        "iban": "DE89370400440532013000",
        "bic": "COBADEFFXXX"
        }
    },
    {
      "accountId": "acct_0012545",
      "status": "inactive",
      "accountType": "beneficiary",
      "networkType": "SWIFT",
      "country": "SG",
      "currency": "USD",
      "accountInfo": {
        "accountHolderName": "ACME Inc",
        "accountNumber": "12345678",
        "bankName": "Chase Bank",
        "bankAddress": "123 Wall Street, NY",
        "swiftCode": "CHASUS33XXX",
        "iban": null,
        "beneficiaryAddress": "31, Address 1-2",
        "beneficiaryCity": "Singapore",
        "beneficiaryCountry": "Singapore",
        "beneficiaryPostalcode": "123456"
        }
    },
  ],
  "traceId": "Auto:75f476b99c26423d93c93682dd4ce030"
}

Error Response Example

{
  "status": 400,
  "code": "LIST0001",
  "msg": "Missing required field: accountType",
  "traceId": "e8b6f3c4-1a2d-4f5e-b678-1234567890ab"
}
Code Message Meaning
LIST0001 Missing required field: accountType One or more mandatory fields were not provided.
LIST0002 Invalid accountType: foo accountType must be either payer or beneficiary.
LIST0003 Unsupported networkType: LOCALX networkType must be one of PIX, SWIFT, SEPA, LOCAL.
LIST0000 Internal server error An unexpected error occurred. Please retry or contact support.

results matching ""

    No results matching ""