Add Settlement Bank Account

Add a settlement bank account to a merchant during or after the onboarding process. Bank accounts are linked to the merchant wallet. There can be multiple bank accounts to the same wallet where each bank account is for a specific currency.

Note

Before running this method, you must run the Upload Bank Statement Verification File.

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.

Request Path Parameters

- ewallet
- Identifier of the merchant's ewallet. String starting with ewallet_.

Request Body Parameters

- 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_name
- The name of the bank.

- beneficiary_city
- City of the address of the beneficiary.

- beneficiary_name
- Full name of the account beneficiary.

- beneficiary_national_id
- ID number of the beneficiary.

- beneficiary_postal_code
- Postal code of the beneficiary.

- 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 18-digit code that is assigned to each bank account in Mexico.

- 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
- The type of the account. Valid values are individual and company.

- file_token
- The file identifier that was returned from the Upload Bank Statement Verification File method. String starting with batch_.

- iban
- International Bank Account Number is a standardized code used for international money transfers.

- sort_code
- A six-digit UK and Irish bank identifier, formatted as three pairs of numbers.

Response

/v1/partner/onboarding/organization/bank_accounts/:ewallet

Add Settlement Bank Account

curl -X post v1/partner/onboarding/organization/bank_accounts/ewallet_377a1b20ddbec3f22d5b956d80cf271c' \
-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' \
--data-raw '{
    "currency": "EUR",
    "country": "DE",
    "bank_account_alias": "New Bank",
    "account_number": "134511232",
    "bank_name": "NEW BANK OF NEW TOWN LIMITED",
    "beneficiary_name":"Four Stars Tech LIMITED",
    "bic_swift":"DHBKHKHH",
    "entity_type": "company",
    "file_token": "batch_574e2970d561ca2175c3cd99e6170cf1"
}'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "Success",
        "response_code": "",
        "operation_id": "e49e9b96-1fa9-44cf-b1ae-cfce5cbbc488"
    },
    "data": {
        "bank_account": "bank_64818da44aac2c39bb0a9a0d37fdd14a",
        "ewallet_token": "ewallet_377a1b20ddbec3f22d5b956d80cf271c",
        "merchant_account_id": "org_8044f944aa36b8edab5eb0793187b453"
    }
}

In this section:

Documentation