v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Online Checkout

Fetch checkout transaction

get/v1/checkout/transaction

Query parameters

idType'ORDER_ID' | 'ORDER_REFERENCE'

Checkout id type to use for this query. Valid values are the 'ORDER_REFERENCE', to use Order reference passed in when generating the checkout link, and 'ORDER_ID' to use the uuid value returned in the checkout link path.

idstring

Checkout transaction id based on the value selected in the idType parameter

Headers

accountIdstring uuid required

Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Response

OK - your request was successful.

codestring

Response Code

descriptionstring

response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "message": "success",
    "order": {
      "orderId": "56e03654-0c32-4d3e-bbd6-a9df22994a12",
      "orderReference": "90e81e8a-bc14-4ebf-89c0-57da752cca58",
      "customerId": "762878332454",
      "accountId": "56e03654-0c32-4d3e-bbd6-a9df22994a12",
      "callbackUrl": "https://ip:port/merchant.com/callback",
      "customerEmail": "abcde@gmail.com",
      "currency": "NGN"
    },
    "transactionDetails": {
      "transactionDate": "2023-12-06T15:46:43.000Z",
      "paymentReference": "5844858382134",
      "paymentVendorReference": "5844858382675493",
      "statusCode": "Payment approved"
    },
    "transferDetails": {
      "sessionId": "67584432178569543",
      "beneficiaryAccountName": "Tope Fade",
      "beneficiaryAccountNumber": "5844858382",
      "originatorAccountName": "Femi Fash",
      "originatorAccountNumber": "3409082834",
      "narration": "Checkout payment",
      "destinationInstitutionCode": "true",
      "paymentReference": "44384586756"
    },
    "cardDetails": {
      "cardPan": "515123 **** **** 6667",
      "cardType": "Verve",
      "cardCurrency": "NGN",
      "cardBank": "057"
    }
  }
}