Update Settlement Bank Account

Update a settlement bank account 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.

Request Path Parameters

- bank_account
- Identifier of the merchant's bank account. String starting with bank_.

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_name
- Full name of the account beneficiary.

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

- 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 request. String starting with batch_.

Response

- 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_.
- 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.

/v1/partner/onboarding/organization/bank_accounts/:bank_account_token

Update Settlement Bank Account

curl -X post v1/partner/onboarding/organization/bank_accounts/bank_72816f421681da02f7f87be41005188b' \
-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 '{
    "bank_account_alias": "New Bank",
    "bank_name": "New Bank of New Town",
    "beneficiary_name":"Four Stars Tech Limited",
    "entity_type": "company",
    "file_token": "batch_c24b1c33fd46d928a2b70b60efa9c01f"
}'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "Success",
        "response_code": "",
        "operation_id": "d22f4726-13bb-46c7-82b3-0021e937dcb8"
    },
    "data": {
        "bank_account_id": "bank_72816f421681da02f7f87be41005188b",
        "merchant_account_id": "049c71b8-945b-43ab-b069-44610f5bc818",
        "currency": "EUR",
        "country": "DE",
        "bank_account_alias": "New Bank",
        "bank_name": "New Bank of New Town",
        "account_number": "",
        "bic_swift": "",
        "beneficiary_name": "Four Stars Tech Limited",
        "entity_type": "company",
        "static_reference_id": null,
        "sort_code": "12331212",
        "clabe": "null",
        "iban": "ERTERTHGJ,
        "beneficiary_street_address": "23 East 34th Street ",
        "beneficiary_postal_code": "4568Z",
        "beneficiary_city": "New Town",
        "beneficiary_national_id": "465687098"
    }
}{
    "bank_account_alias": "New Bank",
    "bank_name": "New Bank of New Town",
    "beneficiary_name":"Four Stars Tech Limited",
    "entity_type": "company",
    "file_token": "batch_c24b1c33fd46d928a2b70b60efa9c01f"
}

In this section:

Documentation

Update Settlement Bank Account

Parameters

Request Header Parameters

Request Path Parameters

Request Body Parameters

Response

Search results