Store bank account

Store bank account data for a specific buyer. Currently, only one bank account can be stored per buyer. Subsequent calls to that endpoint for the same buyer will overwrite existing bank account data.

SecurityBearer Authentication
Request
path Parameters
partner_profile_id
required
string

partner profile id provided by Ratepay

Example: MYSHOP_PR_DE
shop_buyer_id
required
string

unique id assigned to the consumer by the merchant

Example: customer_1
header Parameters
Authorization
required
string

For each request, a valid access token must be provided in the Authorization header. See Authentication API for obtaining a valid token.

Content-Type
required
string
Example: application/json
Request Body schema: application/json
required

bank account data

owner
required
string [ 0 .. 1000 ] characters

name of bank account owner (including first name and last name)

iban
required
string [ 0 .. 50 ] characters

the international bank account number. Spaces are allowed, but not necessary.

bic
string [ 0 .. 50 ] characters

the bank identifier code

Responses
201

bank account stored

400

data must contain IBAN and owner

401

partner profile id doesn't belong to the asking shop

405

Method not allowed

406

Data format not supported (JSON only)

413

Request entity too large

415

Unsupported content type

422

Invalid IBAN or BIC

500

Internal server error. Try again later.

post/partners/{partner_profile_id}/consumer/{shop_buyer_id}/bank-accounts
Request samples
application/json
{
  • "owner": "Jane Doe",
  • "iban": "DE07 1234 1234 1234 1234 12",
  • "bic": "MARKDEFFXXX"
}
Response samples
application/json
{
  • "bank_account_reference": "269b5bfb-7617-4ba6-9adc-a6abf4d0c8d4"
}