Transformer & Payment Initiation

To initiate payments with Transformer, the following two endpoints must be integrated:

  1. Request Transformer’s BIN lookup
  2. Initiate the payment creation with Volt

Request BIN lookup

This is the first required step. When you request the BIN lookup we will send you the bank details that will allow your customer to pay via open banking instead of their card.

We will need the following information:

  • BIN – first six digits of a card, integer 6 or 8 digits 

Authorisations: OAuth
The request has to be authorised with a Bearer token received via OAUTH and attached to Headers. It will look something like this:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciO ... F_n1hAeBoplzOfQ

Request body schema: application/json
Details of the Transformer match you would like to initiate:

bin
required
integer  6 or 8 digits
First six / eight digits of a card entered by the payer on your checkout

Responses

When a request is submitted, you will see one of the following responses. Green responses indicate success; red responses indicate that the request was unsuccessful. 

200 OK (Successful Transformer Match)
The BIN has been recognised and matched with the corresponding bank. The response includes the name and logo of the bank as well as the Transformer code that should be used in the payment initiation request. 

An empty value will be returned in the Terms and Conditions field, which should currently be treated as a placeholder. We plan to include T&Cs in the response in Transformer version 1.1, which would allow the customer to avoid being redirected to Volt’s checkout when initiating the payment.

400 Bad request (Invalid BIN)
We cannot accept the payload from the request you sent because the BIN is invalid. It should be 6 or 8 digits long.

401 Access denied
Your credentials were invalid, usually because a valid authentication token was not supplied. It may be that the token you used has expired. You will need to re-authenticate and then resubmit this request with updated credentials.

403 Not authorised
Although your credentials are correct, you do not have access to this product. You will be prompted to contact your account manager to enable Transformer. 

404 BIN not matched
BIN has not been matched with any of the banks in our database, therefore payment initiation is not possible.

Example request payload:

  • Sandbox
  • Production
POST https://sandbox.volt.io/transformer-match
POST https://volt.io/transformer-match
POST /transformer-match
{
   "bin": "123456"
}
Example success response (HTTP 200)
{
   "transformerCode": "XYZ",
   "bankLogo": "{asset_url}",
   "bankName": "Barclays",
   "termsAndConditions": "T&C text"
}
Example bad request response (HTTP 400)
{
   "exception": {
       "message": "BIN must be 6 or 8 digits long"
   }
}
Example access denied response (HTTP 401)
{
   "exception": {
       "message": "Unauthorized"
   }
}
Example not authorised response (HTTP 403) - in case BIN has been correctly matched
{
   "exception": {
       "message": "We have matched BIN with the bank but you do not have access to this product. Please contact your account manager to enable Volt Transformer"
   }
}
Example not authorised response (HTTP 403) - in case BIN has not been matched
{
   "exception": {
       "message": "You do not have access to this product. Please contact your account manager to enable Volt Transformer"
   }
}
Example BIN not matched response (HTTP 404)
{
   "exception": {
       "message": "BIN could not be matched"
   }
}