List Settlement Bank Accounts

List the settlement bank accounts of a merchant during or after the onboarding process. Bank accounts are linked to the merchant wallet.

Parameters

Request Header Parameters

- access_key
- Unique access key provided by Rapyd for each authorized user.
  See Developers.
- Content-Type
- Indicates that the data appears in JSON format. Set to application/json.
- idempotency
- A unique key that prevents the platform from creating the same object twice.
  See Idempotency.
- salt
- Random string. Recommended length: 8-16 characters.
- signature
- Signature calculated for each request individually.
  See Request Signatures.
- timestamp
- Timestamp for the request, in Unix time (seconds).
- merchant_account_id
- The merchant account ID that was provided to you when you created the organization. See also Create Organization.

Response

Returns an array of objects where each object contains the details of a bank account:

- account_number
- The bank account number.

- bank_account_alias
- A custom, easy-to-remember nickname or label you can assign to a bank account to identify it more easily than its lengthy account number.

- bank_account_token
- Identifier of the bank account. String starting with bank_.

- bank_name
- The name of the bank.

- beneficiary_city
- The city of the beneficiary address.

- beneficiary_name
- Full name of the account beneficiary.

- beneficiary_national_id
- The national ID number of the beneficiary.

- beneficiary_postal_code
- The postal code of the beneficiary address.

- beneficiary_street_address
- The street address of the beneficiary.

- bic_swift
- The Business Identifier Code of the specific bank for international transactions. Comprised of 8 or 11 characters.

- clabe
- An additional bank account identifier in Mexico. Null when not relevant.

- country
- Name of the country where the bank is located. Two-letter ISO 3166-1 alpha-2 code.

- currency
- The currency of the account. Three-letter ISO 4217 code.

- entity_type
- Valid values are individual and company.

- ewallet_token
- Identifier of the ewallet that is linked to the bank account. String starting with ewallet_.

- iban
- International Bank Account Number used to identify a bank account for cross-border transactions

- merchant_account_id
- Identifier of the merchant. String starting with org_.

- settlement_configuration
- The national ID details of the beneficiary.
  type
  Indicates the organization that settles the transactions in the bank account.
  frequency
  The frequency interval in which the account is settled (daily, weekly, monthly, etc.).
  day
  tbd
  min_amount
  The minimum settlement amount.
  min_amount_currency
  The minimum amount currency
  client_configured_min_settlement_amount
  The client configured minimum settlement amount.

- sort_code
- A six-digit UK and Irish bank identifier. Null when not relevant.

- static_reference_id
- An identifier that is associated with the bank account details.

- status
- The status of the bank account. Valid Values are active and inactive.

/v1/partner/onboarding/organization/bank_accounts

List Settlement Bank Accounts

curl -X get v1/partner/onboarding/organization/bank_accounts
-H 'access_key: your-access-key-here' \
-H 'Content-Type: application/json' \
-H 'idempotency: your-idempotency-parameter-here' \
-H 'salt: your-random-string-here' \
-H 'signature: your-calculated-signature-here' \
-H 'timestamp: your-unix-timestamp-here' \
-H 'merchant_account_id: your-merchant-account-here' \

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "Success",
        "response_code": "",
        "operation_id": "d7b75144-5602-4aa5-b886-34bb18f95ef8"
    },
    "data": [
        {
            "bank_account_id": "bank_4b693c599d2691db1b9abd305028f1c8",
            "ewallet_token": "ewallet_2a27685f2f71ae9a9fe4265fceabcab7",
            "merchant_account_id": "org_ec130a123c9d25af939774ddb2c00a32",
            "currency": "USD",
            "country": "US",
            "bank_account_alias": "bank of anytown",
            "bank_name": "Anytown bank LIMITED",
            "account_number": null,
            "bic_swift": null,
            "beneficiary_name": "ANY TECHNOLOGY LIMITED",
            "entity_type": "company",
            "static_reference_id": null,
            "sort_code": "60-16-14",
            "clabe": "31926817",
            "iban": "GB29NWBK60161331926818",
            "beneficiary_street_address": "233 East 34th street",
            "beneficiary_postal_code": "432Z2",
            "beneficiary_city": "Any Town",
            "beneficiary_national_id": "123456789",
            "settlement_configuration": {
                "type": "Settlement by Rapyd",
                "frequency": "daily",
                "day": null,
                "min_amount": 100,
                "min_amount_currency": "USD",
                "client_configured_min_settlement_amount": null
            },
            "status": "active"
        },
        {
            "bank_account_id": "bank_38ac2aa3dcbc9279b9520ef8d3d433dd",
            "ewallet_token": "ewallet_2a27685f2f71ae9a9fe4265fceabcab7",
            "merchant_account_id": "org_ec130a123c9d25af939774ddb2c00a32",
            "currency": "EUR",
            "country": "DE",
            "bank_account_alias": "New Town Bank",
            "bank_name": "New Town Bank LIMITED",
            "account_number": "134511232",
            "bic_swift": "DHBKHKHH",
            "beneficiary_name": "Four Stars Limo Service",
            "entity_type": "company",
            "static_reference_id": null,
            "sort_code": "60-16-13",
            "clabe": "31926819",
            "iban": "GB29NWBK60161331926819",
            "beneficiary_street_address": "23 West 35th Street",
            "beneficiary_postal_code": "ZRTE3",
            "beneficiary_city": "New Town",
            "beneficiary_national_id": "123789456",
            "settlement_configuration": {
                "type": "Settlement by Rapyd",
                "frequency": "daily",
                "day": null,
                "min_amount": 100,
                "min_amount_currency": "EUR",
                "client_configured_min_settlement_amount": null
            },
            "status": "active"
        }
    ]
}

In this section:

Documentation

List Settlement Bank Accounts

Parameters

Request Header Parameters

Response

Search results