Bank Account Management Service OpenAPI specification (version 1)

Download OpenAPI specification:Download

The Bank Account Management Service enables merchants to store bank account data of their customers easily and highly secured at Ratepay. The stored bank account data can be used on the merchant's website or within backoffice orders to simplify future purchases. The Bank Account Management Service offers a REST API to store, retrieve and delete customer bank account data. The API uses JSON as data exchange format..

Get stored bank account by shop buyer id

Retrieve a list of bank accounts stored for a specific buyer. Currently, the service stores one bank account per buyer. Thus, the returned list contains max. one bank account.

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 buyer 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
Responses
200

Successfully returned requested data

401

partner profile id doesn't belong to the asking shop

404

Unknown merchant consumer id

405

Method not allowed

406

Data format not supported (JSON only)

413

Request entity too large

500

Internal server error. Try again later.

get/partners/{partner_profile_id}/consumer/{shop_buyer_id}/bank-accounts
Request samples 
Response samples 
application/json
{
  • "bank_account_reference": "8e3412b0-a334-4d0a-b132-7ab996d769ef",
  • "owner": "Jane Doe",
  • "iban": "DE07 1234 1234 1234 1234 12",
  • "bic": "MARKDEFFXXX"
}