Skip to content
Developer
/
Bank Account Management A...
/
/
Get stored bank account b...

Bank Account Management Service OpenAPI specification (version 1)

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

Download OpenAPI description
operations.json
operations.yaml
Languages
Servers
Integration environment

https://api-integration.ratepay.com/shop/consumer/v1/

Production environment

https://api.ratepay.com/shop/consumer/v1/

Get stored bank account by shop buyer id

Request

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.

Security
Bearer Authentication
Path
partner_profile_idstringrequired

partner profile id provided by Ratepay.

Example: MYSHOP_PR_DE
shop_buyer_idstringrequired

unique id assigned to the buyer by the merchant

Example: customer_1
Headers
Authorizationstringrequired

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

Content-Typestringrequired
Example: application/json
curl -i -X GET \
  https://api-integration.ratepay.com/shop/consumer/v1/partners/MYSHOP_PR_DE/consumer/customer_1/bank-accounts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json'

Responses

Successfully returned requested data

Bodyapplication/json
bank_account_referencestring(uuid)read-only

identifier of the bank account

Example: "8e3412b0-a334-4d0a-b132-7ab996d769ef"
ownerstring[ 0 .. 1000 ] charactersrequired

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

Example: "Jane Doe"
ibanstring[ 0 .. 50 ] charactersrequired

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

Example: "DE07 1234 1234 1234 1234 12"
bicstring[ 0 .. 50 ] characters

the bank identifier code

Example: "MARKDEFFXXX"
Response
application/json
{
  "bank_account_reference": "8e3412b0-a334-4d0a-b132-7ab996d769ef",
  "owner": "Jane Doe",
  "iban": "DE07 1234 1234 1234 1234 12",
  "bic": "MARKDEFFXXX"
}

Store bank account

Request

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.

Security
Bearer Authentication
Path
partner_profile_idstringrequired

partner profile id provided by Ratepay

Example: MYSHOP_PR_DE
shop_buyer_idstringrequired

unique id assigned to the consumer by the merchant

Example: customer_1
Headers
Authorizationstringrequired

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

Content-Typestringrequired
Example: application/json
Bodyapplication/jsonrequired

bank account data

ownerstring[ 0 .. 1000 ] charactersrequired

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

Example: "Jane Doe"
ibanstring[ 0 .. 50 ] charactersrequired

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

Example: "DE07 1234 1234 1234 1234 12"
bicstring[ 0 .. 50 ] characters

the bank identifier code

Example: "MARKDEFFXXX"
curl -i -X POST \
  https://api-integration.ratepay.com/shop/consumer/v1/partners/MYSHOP_PR_DE/consumer/customer_1/bank-accounts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "owner": "Jane Doe",
    "iban": "DE07 1234 1234 1234 1234 12",
    "bic": "MARKDEFFXXX"
  }'

Responses

bank account stored

Bodyapplication/json
bank_account_referencestring(uuid)

The bank_account_reference can be used in a payment request to identify the IBAN and BIC for the purchase.

Response
application/json
{
  "bank_account_reference": "269b5bfb-7617-4ba6-9adc-a6abf4d0c8d4"
}

Delete bank account

Request

Delete a stored bank account of a given buyer.

Security
Bearer Authentication
Path
partner_profile_idstringrequired

partner profile id provided by Ratepay

Example: MYSHOP_PR_DE
shop_buyer_idstringrequired

unique id assigned to the buyer by the merchant

Example: customer_1
bank_account_referencestringrequired

unique identifier for the bank account. This element can be retrieved by the GET request

Example: 226e7a20-5e1e-4f23-a56c-c8a851b190e7
Headers
Authorizationstringrequired

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

Content-Typestringrequired
Example: application/json
curl -i -X DELETE \
  https://api-integration.ratepay.com/shop/consumer/v1/partners/MYSHOP_PR_DE/consumer/customer_1/bank-accounts/226e7a20-5e1e-4f23-a56c-c8a851b190e7 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json'

Responses

bank account deleted

Get stored bank account by bank account reference

Request

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

Security
Bearer Authentication
Path
partner_profile_idinteger(int32)required

partner profile id provided by Ratepay.

Example: MYSHOP_PR_DE
shop_buyer_idstringrequired

unique id assigned to the buyer by the merchant

Example: customer_1
bank_account_referencestringrequired

the identifier of the bank account

Example: 226e7a20-5e1e-4f23-a56c-c8a851b190e7
Headers
Authorizationstringrequired

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

Content-Typestringrequired
Example: application/json
Bodyapplication/json
curl -i -X GET \
  https://api-integration.ratepay.com/shop/consumer/v1/partners/MYSHOP_PR_DE/shop-buyers/customer_1/bank-accounts/226e7a20-5e1e-4f23-a56c-c8a851b190e7 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json'

Responses

Successfully returned requested data

Bodyapplication/json
bank_account_referencestring(uuid)read-only

identifier of the bank account

Example: "8e3412b0-a334-4d0a-b132-7ab996d769ef"
ownerstring[ 0 .. 1000 ] charactersrequired

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

Example: "Jane Doe"
ibanstring[ 0 .. 50 ] charactersrequired

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

Example: "DE07 1234 1234 1234 1234 12"
bicstring[ 0 .. 50 ] characters

the bank identifier code

Example: "MARKDEFFXXX"
Response
application/json
{
  "bank_account_reference": "8e3412b0-a334-4d0a-b132-7ab996d769ef",
  "owner": "Jane Doe",
  "iban": "DE07 1234 1234 1234 1234 12",
  "bic": "MARKDEFFXXX"
}