Verify a payment

Returns the current state of a payment. This is the canonical, server-side confirmation. Call it from your server before you fulfil an order, whether you learned of the payment from a webhook, the browser callback or your own polling.

Fulfil only when both of these hold: data.status is success, and data.amount equals the amount you expected for that order. If the status is success but the amount differs, hold the order and investigate.

Verify is read-only and safe to repeat, so retry on network failure or a 5xx response with exponential backoff. A payment that stays pending or processing should be kept in a waiting state rather than failed. Webhooks and later verify calls reflect the final outcome.

Use the key and host of the environment where the payment was created. A sandbox reference looked up on live, or the reverse, returns 404 with transaction.not_found.

Splits. When the payment was initialised with a distribution, data.split summarises how it was allocated. Allocation follows success by a short moment, so a call made in the first instant may not include split yet. The payment is already success and safe to fulfil.

GET

payment

verify

{reference}

Verify a payment

curl --request GET \
  --url https://api.sandbox.vestrapay.app/v1/payment/verify/{reference} \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.sandbox.vestrapay.app/v1/payment/verify/{reference}', 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/verify/{reference}",
  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-api-key: <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": {
    "id": "3f2a0c1e-8b44-4d91-9c2a-1a2b3c4d5e6f",
    "reference": "VPY_TXN_ACME001",
    "amount": "100.00",
    "total": "101.50",
    "amountSettled": "100.00",
    "currency": "NGN",
    "status": "success",
    "channel": "card",
    "fees": "1.50",
    "merchantBearsCost": false,
    "paidAt": "2026-05-10T14:30:00.000Z",
    "metadata": {
      "orderId": "ORD_12345"
    }
  }
}

Authorizations

x-api-key

string

header

required

Your secret key. sk_test_… on the sandbox, sk_live_… on live. Server-side only. Copy it from Settings → Developers in the merchant dashboard. Authorization: Bearer with the same value is also accepted.

Path Parameters

reference

string

required

The reference returned by initialise, for example VPY_TXN_ACME001.

Response

The current state of the payment.

status

enum<string>

required

Available options:

success

data

object

required

The current state of a payment.

Show child attributes

Verify a payment

curl --request GET \
  --url https://api.sandbox.vestrapay.app/v1/payment/verify/{reference} \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.sandbox.vestrapay.app/v1/payment/verify/{reference}', 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/verify/{reference}",
  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-api-key: <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": {
    "id": "3f2a0c1e-8b44-4d91-9c2a-1a2b3c4d5e6f",
    "reference": "VPY_TXN_ACME001",
    "amount": "100.00",
    "total": "101.50",
    "amountSettled": "100.00",
    "currency": "NGN",
    "status": "success",
    "channel": "card",
    "fees": "1.50",
    "merchantBearsCost": false,
    "paidAt": "2026-05-10T14:30:00.000Z",
    "metadata": {
      "orderId": "ORD_12345"
    }
  }
}

Payments

Checkout

Verify a payment

Authorizations

Path Parameters

Response