Stream checkout events

A Server-Sent Events stream that lets a pay screen update live. Open it after you submit a charge. It is not wrapped in the { status, data } envelope.

The stream replays stored events after Last-Event-ID when you send it, then emits checkout.connected, periodic checkout.heartbeat keep-alives, and progress events as they happen. It closes after the configured session timeout, which is 15 minutes by default.

Event	Meaning
`checkout.connected`	The stream is open.
`checkout.heartbeat`	Keep-alive. Ignore it.
`checkout.processing`	A charge is in flight.
`checkout.3ds_required`	The customer must complete a 3-D Secure challenge.
`checkout.awaiting_transfer`	A virtual account is open and waiting for the transfer.
`checkout.awaiting_bank_authorization`	The customer must approve the payment at their bank.
`checkout.awaiting_ussd`	The customer must dial the USSD code.
`checkout.amount_mismatch`	A transfer of the wrong amount was received. The window is still open, so ask the customer to send the exact total.
`checkout.completed`	Terminal. Read `status` in the payload, then verify from your server.
`checkout.timeout`	The session ended without an outcome.

The interactive playground cannot test this endpoint, because it waits for the connection to close. Use curl -N or an EventSource in the browser.

GET

payment

checkout

events

Stream checkout events

curl --request GET \
  --url https://api.sandbox.vestrapay.app/v1/payment/checkout/events \
  --header 'x-access-code: <api-key>'

const options = {method: 'GET', headers: {'x-access-code': '<api-key>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.vestrapay.app/v1/payment/checkout/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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;
}

event: checkout.completed
data: {"status":"success","reference":"VPY_TXN_ACME001","amount":"5000.00","currency":"NGN","channel":"card"}

{
  "status": "failed",
  "error": "missing_access_code",
  "message": "The x-access-code header is required."
}

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.

Headers

Last-Event-ID

string

The id of the last event you received, so that the stream resumes after it.

Response

An open text/event-stream. Each event has an event name, an optional id, and a JSON data line.

The response is of type string.

Stream checkout events

curl --request GET \
  --url https://api.sandbox.vestrapay.app/v1/payment/checkout/events \
  --header 'x-access-code: <api-key>'

const options = {method: 'GET', headers: {'x-access-code': '<api-key>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.vestrapay.app/v1/payment/checkout/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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;
}

event: checkout.completed
data: {"status":"success","reference":"VPY_TXN_ACME001","amount":"5000.00","currency":"NGN","channel":"card"}

{
  "status": "failed",
  "error": "missing_access_code",
  "message": "The x-access-code header is required."
}

Payments

Checkout

Stream checkout events

Authorizations

Headers

Response