Skip to content

Introduction

Overview

The Bank Account Management Service is only available for Payment API 1.8.

The Bank Account Management Service allows merchants to securely store buyer bank account details at Ratepay and reuse them for future transactions.

This service is intended for merchants who want to:

  • reduce friction in repeat purchases,
  • avoid handling sensitive bank data in their own systems, and
  • reuse stored bank accounts in webshop and backend orders.

How to use Bank Account Management Service API

General flow for API usage

  1. Authenticate against Ratepay's authorization service and retrieve an access token. You will receive the Client ID & Client Secret by your Ratepay representative. (see Authentication)
  2. Use received token to call the Bank Account Management Service API.
  3. Store the bank details of the buyer via the Store bank account request. If successful, you will receive a bank_account_reference.
  4. Send the value of bank_account_reference within a PAYMENT_REQUEST, via the reference parameter for the respective buyer.

Requirements for API calls

The Bank Account Management Service API must not be called directly from the frontend. Otherwise, this can expose the merchants credentials to the public audience. Instead, the backend system of the merchant should call the Bank Account Management Service API.

 
Next page