Add bank accounts

Use the following API requests to manage the bank account details of affiliated merchant accounts:

Add and retrieve bank accounts:

Add bank account: Add a bank account to a merchant account.
List bank accounts: Retrieve a list of all bank accounts.
Get bank account: Retrieve a specific bank account.

Verify bank accounts by payment link or bank statement:

Create payment link: Create a payment link to verify a bank account.
Add bank statement: Add a bank statement to verify a bank account.
List bank statements: Retrieve a list of all bank statements.
Get bank statement: Retrieve a specific bank statement.

Authentication

All the bank account requests require a partner account API key. This is not the same as a site API key. For more information, email your partner manager.

All URLs on this page are directed to our test API. To use the live API, change the subdomain testapi to api and use the corresponding API key.

Add bank account

POST https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}/bank-accounts?api_key={your-account-api-key}

Add a new bank account to a merchant account.

Path parameters

Parameter	Description
account_id `string`	The affiliated merchant ID. Format: 8 character string, e.g. `12345678`. Required.

Request body parameters

Parameter	Description
currency `string`	The currency of the bank account. Format: ISO-4217, e.g. `EUR`. Required.
holder_name `string`	The full name of the bank account holder. This can be a natural person, company, or other legal entity. Format: Max 40 characters. Required.
iban `string`	The IBAN of the bank account. Format: Alphanumeric string of up to 34 characters. Required.

Response body parameters

The following are in addition to the request body parameters.

Parameter	Description
id `string`	The unique identifier of the bank account. Referred to as `bankaccount_id`.

Sample request

curl -X POST "https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}/bank-accounts?api_key={your-account-api-key}" \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--data-raw '{
  "currency" :"EUR",
  "holder_name" :"{affiliate-company-name}",
  "iban" :"NL02ABNA0123456789"
}'

Sample response

{
  "data": {
    "currency" :"EUR",
    "holder_name" :"{affiliate-company-name}",
    "iban" :"NL02ABNA0123456789",
    "id" :"t4xwvomi45heq"
  },
  "success": true
}

List bank accounts

GET https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}/bank-accounts?api_key={your-account-api-key}

Retrieve a list of all bank accounts linked to an affiliated merchant account.

Path parameters

Parameter	Description
account_id `string`	The affiliated merchant ID. Format: 8 character string, e.g. `12345678`. Required.

Response body parameters

Parameter	Description
currency `string`	The currency of the bank account. Format: ISO-4217, e.g. `EUR`.
holder_name `string`	The full name of the bank account holder. This can be a natural person, company, or other legal entity. Format: Max 40 characters.
iban `string`	The IBAN of the bank account. Format: Alphanumeric string of up to 34 characters.
id `string`	The unique identifier of the bank account. Referred to as `bankaccount_id`.
status `string`	The screening status of the bank account.

Sample request

curl -X GET "https://testapi.multisafepay.com/v1/json/accounts/{affiliate_account_id}/bank-accounts?api_key={your-account-api-key}" \
--header "accept: application/json" \

Sample response

{
  "data": [
    {
      "currency": "EUR",
      "holder_name": "{affiliate-company-name}",
      "iban": "NL02ABNA0123456789",
      "id" :"t4xwvomi45heq",
      "status": "pending"
    },
    {
      "currency": "USD",
      "holder_name": "{affiliate-company-name}",
      "iban": "NL02ABNA0123456789",
      "id": "ytipdsfs746os",
      "status": "pending"
    }
  ],
  "success": true
}

Get bank account

GET https://testapi.multisafepay.com/v1/json/bank-accounts/{bankaccount_id}?api_key={your-account-api-key}

Retrieve a specific bank account by its identifier.

Path parameters

Parameter	Description
bankaccount_id	The unique identifier of the bank account. Format: String, e.g. `upp6ogjqret36`. Required. The `bankaccount_id` is returned as `id` in the add bank account and list bank accounts requests.

Response body parameters

Parameter	Description
currency `string`	The currency of the bank account. Format: ISO-4217, e.g. `EUR`.
holder_name `string`	The full name of the bank account holder. This can be a natural person, company or other legal entity. Format: Max 40 characters.
iban `string`	The IBAN of the bank account. Format: Alphanumeric string of up to 34 characters.
id `string`	The unique identifier of the bank account. Referred to as `bankaccount_id`.
status `string`	The screening status of the bank account.

Sample request

curl -X GET "https://testapi.multisafepay.com/v1/json/bank-accounts/{bankaccount_id}?api_key={your-account-api-key}" \
--header "accept: application/json" \

Sample response

{
  "data": {
    "currency": "EUR",
    "holder_name": "{affiliate-company-name}",
    "iban": "NL02ABNA0123456789",
    "id": "{bankaccount_id}",
    "status": "pending"
  },
  "success": true
}

Create payment link

POST https://testapi.multisafepay.com/v1/json/bank-accounts/{bankaccount_id}/payment-links?api_key={your-account-api-key}

Create a payment link for a refundable 1 EUR payment. This payment is used to verify the ownership of the associated bank account. Alternatively, supply a copy of a bank statement through the bank-statements request.

Path parameters

Parameter	Description
bankaccount_id	The unique identifier of the bank account. Format: String, e.g. `upp6ogjqret36`. Required. The `bankaccount_id` is returned as `id` in the add bank account and list bank accounts requests.

Request body parameters

No parameters are sent in this request.

Response body parameters

Parameter	Description
bankaccount_id `string`	The unique identifier of the bank account.
payment_link `string`	The URL where you can make the refundable 1 EUR payment.

Sample request

curl -X POST "https://testapi.multisafepay.com/v1/json/bank-accounts/{bankaccount_id}/payment-links?api_key={your-account-api-key}" \
--header "accept: application/json" \

Sample response

{
  "data": {
    "bankaccount_id": "{bankaccount_id}",
    "payment_link": "https://paymentlink.com/link"
  },
  "success": true
}

Add bank statement

POST https://testapi.multisafepay.com/v1/json/bank-accounts/{bankaccount_id}/bank-statements?api_key={your-account-api-key}

Upload a bank statement to verify the ownership of the bank account. Alternatively, create a payment link using the payment-links request.

Path parameters

Parameter	Description
bankaccount_id	The unique identifier of the bank account. Format: String, e.g., `upp6ogjqret36`. Required. The `bankaccount_id` is returned as `id` in the add bank account and list bank accounts requests.

Request body parameters

Parameter	Value
encoded_content `string`	Base64 encoded content. Required.
filename `string`	The bank statement filename. Format: Max 250 characters. Required.
mime_type `string`	The media type of the bank statement file . Options: `application/pdf` `image/jpeg`

Response body parameters

Parameter	Value
account_id `string`	The affiliated merchant ID. Format: 8 character string, e.g. `12345678`.
bankaccount_id `string`	The unique identifier of the bank account. Format: String, e.g. `upp6ogjwpot36`.
document_type `string`	The document type of the file.
filename `string`	The bank statement filename. Format: Max 250 characters.
id `string`	The unique identifier of the bank statement. Referred to as `bankstatement_id`.
mime_type `string`	The media type of the bank statement file . Options: `application/pdf` `image/jpeg`

Sample request

curl -X POST "https://testapi.multisafepay.com/v1/json/bank-accounts/{bankaccount_id}/bank-statements?api_key={your-account-api-key}" \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--data-raw '{
  "encoded_content": "string",
  "filename": "bank-statement.pdf",
  "mime_type": "application/pdf"
}'

Sample response

{
  "data": {
    "account_id": "{affiliate_account_id}",
    "bankaccount_id": "{bankaccount_id}",
    "document_type": null,
    "filename": "bank-statement.pdf",
    "id": "4jrp7krwlrafq",
    "mime_type": "application/pdf"
  },
  "success": "true"
}

List bank statements

GET https://testapi.multisafepay.com/v1/json/bank-accounts/{bankaccount_id}/bank-statements?api_key={your-account-api-key}

Retrieve a list of all bank statements associated with a bank account.

Path parameters

Parameter	Description
bankaccount_id	The unique identifier of the bank account. Format: String, e.g., `upp6ogjqret36`. Required. The `bankaccount_id` is returned as `id` in the add bank account and list bank accounts requests.

Response body parameters

Parameter	Value
account_id `string`	The affiliated merchant ID. Format: 8 character string, e.g. `12345678`.
bankaccount_id `string`	The unique identifier of the bank account. Format: String, e.g. `upp6ogjwpot36`.
document_type `string`	The document type of the file.
filename `string`	The name of the bank statement file. Format: Max 250 characters.
id `string`	The unique identifier of the bank statement. Referred to as `bankstatement_id`.
mime_type `string`	The media type of the bank statement file . Options: `application/pdf` `image/jpeg`

Sample request

curl -X GET "https://testapi.multisafepay.com/v1/json/bank-accounts/{bankaccount_id}/bank-statements?api_key={your-account-api-key}" \
--header "accept: application/json" \

Sample response

{
  "data": {
    "account_id": "{affiliate_account_id}",
    "bankaccount_id": "{bankaccount_id}",
    "document_type": "bankstatement",
    "filename": "bank-statement.pdf",
    "id": "4jrp7krwlrafq",
    "mime_type": "application/pdf"
  },
  "success": "true"
}

Get bank statement

GET https://testapi.multisafepay.com/v1/json/bank-statements/{bankstatement_id}?api_key={your-account-api-key}

Retrieve a specific bank statement by its identifier.

Path parameters

Parameter	Description
bankstatement_id	The unique identifier of the bank statement Format: String, e.g. `it613jfo4psde`. Required. The `bankstatement_id` is returned as `id` in the add bank statement and list bank statements requests.

Response body parameters

Parameter	Value
account_id `string`	The affiliated merchant ID. Format: 8 character string, e.g. `12345678`.
bankaccount_id `string`	The unique identifier of the bank account. Format: String, e.g. `upp6ogjwpot36`.
document_type `string`	The document type of the file.
filename `string`	The name of the bank statement file. Format: Max 250 characters.
id `string`	The unique identifier of the bank statement. Referred to as `bankstatement_id`.
mime_type `string`	The media type of the bank statement file . Options: `application/pdf` `image/jpeg`

Sample request

curl -X GET "https://testapi.multisafepay.com/v1/json/bank-statements/{bankstatement_id}?api_key={your-account-api-key}" \
--header "accept: application/json" \

Sample response

{
  "data": {
    "account_id": "{affiliate_account_id}",
    "bankaccount_id": "{bankaccount_id}",
    "document_type": "bankstatement",
    "filename": "bank-statement.pdf",
    "id": "{bankstatement_id},
    "mime_type": "application/pdf"
  },
  "success": true
}

Next steps

You have added one or multiple bank accounts to a merchant account. Next, you can add UBOs and websites using the unique affiliated merchant ID.

Create a merchant account

Add UBO details

Feedback

Propose a change on GitHub external-link-icon or
send an email to [email protected]

Other languages

For an explanation in another language, contact your account manager.