# Bank Account Management Service OpenAPI specification

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

Version: version 1

## Servers

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

Production environment
```
https://api.ratepay.com/shop/consumer/v1
```

## Security

### Bearer Authentication

For each request, a valid access token must be provided in the Authorization header. See [Authentication API](/docs/developer/authentication/authentication/) for obtaining a valid token.

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Bank Account Management Service OpenAPI specification](https://docs.ratepay.com/_bundle/docs/developer/bank_account_management/operations.yaml)

## Other

### Get stored bank account by shop buyer id

 - [GET /partners/{partner_profile_id}/consumer/{shop_buyer_id}/bank-accounts](https://docs.ratepay.com/docs/developer/bank_account_management/operations/other/getbankaccounts.md): 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.

### Store bank account

 - [POST /partners/{partner_profile_id}/consumer/{shop_buyer_id}/bank-accounts](https://docs.ratepay.com/docs/developer/bank_account_management/operations/other/storebankaccount.md): 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.

### Delete bank account

 - [DELETE /partners/{partner_profile_id}/consumer/{shop_buyer_id}/bank-accounts/{bank_account_reference}](https://docs.ratepay.com/docs/developer/bank_account_management/operations/other/deletebankaccount.md): Delete a stored bank account of a given buyer.

### Get stored bank account by bank account reference

 - [GET /partners/{partner_profile_id}/shop-buyers/{shop_buyer_id}/bank-accounts/{bank_account_reference}](https://docs.ratepay.com/docs/developer/bank_account_management/operations/other/getbankaccountinternal.md): 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.