Pay with bank

Starts a direct bank debit for the bank the customer picked. The customer then authorises the payment in their banking app or through the bank’s approval flow. This can take a minute or more, so keep the pay screen in a waiting state and tell the customer to check their app.

Treat this channel as asynchronous. The response tells you the payment has started, not that it has succeeded. Wait for the checkout.completed event or the payment.completed webhook, then confirm with verify before you fulfil. If the customer never approves, the payment later becomes abandoned.

If you omit bankCode the call fails with bank_payment.bank_required. If the bank cannot be reached you receive bank_payment.failed, and the customer can pick another bank or switch channel.

POST

payment

checkout

charge

bank-payment

Pay with bank

curl --request POST \
  --url https://api.sandbox.vestrapay.app/v1/payment/checkout/charge/bank-payment \
  --header 'Content-Type: application/json' \
  --header 'x-access-code: <api-key>' \
  --data '
{
  "bankCode": "057"
}
'

const options = {
  method: 'POST',
  headers: {'x-access-code': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({bankCode: '057'})
};

fetch('https://api.sandbox.vestrapay.app/v1/payment/checkout/charge/bank-payment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.vestrapay.app/v1/payment/checkout/charge/bank-payment"

payload = { "bankCode": "057" }
headers = {
    "x-access-code": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.vestrapay.app/v1/payment/checkout/charge/bank-payment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bankCode' => '057'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-code: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "status": "success",
  "data": {
    "status": "processing",
    "reference": "VPY_TXN_ACME001",
    "transactionReference": "KPY-PAY-8f1a2b3c",
    "redirectUrl": "https://pay.bank.example/authorise/8f1a2b3c",
    "bankName": "Zenith Bank"
  }
}

Authorizations

x-access-code

string

header

required

The accessCode returned by initialise. Scoped to one payment and valid for 60 minutes. Safe to give to the customer's browser.

Body

application/json

bankCode

string

required

The code of the bank the customer picked, from the banks list. The 057 in the example is illustrative.

Example:

"057"

Response

Bank payment started. Awaiting authorisation at the customer's bank.

status

enum<string>

required

Available options:

success

data

object

required

Show child attributes

Pay with bank

curl --request POST \
  --url https://api.sandbox.vestrapay.app/v1/payment/checkout/charge/bank-payment \
  --header 'Content-Type: application/json' \
  --header 'x-access-code: <api-key>' \
  --data '
{
  "bankCode": "057"
}
'

const options = {
  method: 'POST',
  headers: {'x-access-code': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({bankCode: '057'})
};

fetch('https://api.sandbox.vestrapay.app/v1/payment/checkout/charge/bank-payment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.vestrapay.app/v1/payment/checkout/charge/bank-payment"

payload = { "bankCode": "057" }
headers = {
    "x-access-code": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.vestrapay.app/v1/payment/checkout/charge/bank-payment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bankCode' => '057'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-code: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "status": "success",
  "data": {
    "status": "processing",
    "reference": "VPY_TXN_ACME001",
    "transactionReference": "KPY-PAY-8f1a2b3c",
    "redirectUrl": "https://pay.bank.example/authorise/8f1a2b3c",
    "bankName": "Zenith Bank"
  }
}

Payments

Checkout

Pay with bank

Authorizations

Body

Response