Checkout

Verify Checkout By Source Reference

Retrieve the current state of a checkout and its transaction attempts using the merchant source reference.

GET
/api/v1/checkout/source-reference/{sourceReference}/verify

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

sourceReference*string

Merchant source reference

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/checkout/source-reference/SRC_ABC123/verify"
{
  "requestId": "abcd1234-5678-90ef-ghij-1234567890kl",
  "requestTimestamp": "2026-01-01 12:00:00.000",
  "message": "Checkout status.",
  "statusCode": 200,
  "data": {
    "checkoutReference": "CHT_ABC123",
    "sourceReference": "SRC_ABC123",
    "checkoutStatus": "completed",
    "paymentMethod": "bank_transfer",
    "isFinal": true,
    "businessId": "biz-uuid",
    "customer": {
      "reference": "CUST_XYZ",
      "email": "john@example.com",
      "name": "John Doe"
    },
    "checkoutAmount": {
      "value": 1000,
      "currency": "NGN",
      "formatted": "NGN 1,000.00"
    },
    "transactionAmount": {
      "value": 1050,
      "currency": "NGN",
      "formatted": "NGN 1,050.00"
    },
    "feeAmount": {
      "value": 50,
      "currency": "NGN",
      "formatted": "NGN 50.00"
    },
    "successfulTransactionReference": "TRX_SUCCESS123",
    "latestTransactionReference": "TRX_LATEST123",
    "paymentChannel": "bank_transfer",
    "senderName": "Jane Doe",
    "processedAt": "2026-01-01 12:00:00",
    "completedAt": "2026-01-01 12:05:00",
    "failedAt": null,
    "cancelledAt": null,
    "reason": null,
    "transactionsSummary": {
      "total": 2,
      "successful": 1,
      "failed": 1,
      "pending": 0
    },
    "transactions": [
      {
        "transactionReference": "TRX_ABC123",
        "status": "successful",
        "channel": "bank_transfer",
        "amount": {
          "value": 1050,
          "currency": "NGN",
          "formatted": "NGN 1,050.00"
        },
        "reason": null
      }
    ]
  }
}
{
  "requestId": "f006ad7b-096c-4254-8c7e-2d23a55b0b0e",
  "requestTimestamp": "2026-01-01 12:00:00.000",
  "message": "Invalid API key.",
  "statusCode": 401
}
{
  "requestId": "f006ad7b-096c-4254-8c7e-2d23a55b0b0e",
  "requestTimestamp": "2026-01-01 12:00:00.000",
  "message": "Checkout not found for the provided source reference.",
  "statusCode": 404
}

How is this guide?