Verify Payment Status

This API makes it easy to check the status and details of a payment.

API Object

{
  "type": "onetime-debit",
  "data": {
    "_id": "62bce******************d3d",
    "id": "txd_EbhDM*****************",
    "status": "successful",
    "message": "Payment was successful",
    "amount": 20000,
    "description": "description of payment",
    "fee": 4500,
    "currency": "NGN",
    "customer": null,
    "reference": "V7TR***************3",
    "meta": null,
    "created_at": "2022-06-30T00:01:02.246Z",
    "updated_at": "2022-06-30T00:01:37.172Z",
    "account": {
      "_id": "62bce7***************77",
      "institution": {
        "name": "KudaBank",
        "bankCode": "090267",
        "type": "PERSONAL_BANKING"
      },
      "name": "JOHN DOE",
      "type": "DIGITAL_SAVINGS_ACCOUNT",
      "accountNumber": "11*******3",
      "balance": 1054282,
      "currency": "NGN",
      "bvn": "224********5",
      "liveMode": true,
      "timeline": "62bce7577***************6bc85f",
      "created_at": "2022-06-30T00:01:00.763Z",
      "updated_at": "2022-06-30T02:00:00.026Z"
    }  
  }
}

Verified Payment Fields

Field Description Type
type The payment type string
data The payment data object
data._id The primary id for the payment string
data.id The payment id string
data.status The status of the payment string
data.message The message returned depending on the payment status string
data.amount The payment's total value in the smallest denomination, such as a Kobo (Nigeria) or a Pesewa (Ghana). number
data.description The payment description string
data.fee The charge for the payment number
data.currency The currency of the payment account (NGN, GHS, etc) string
data.customer The Customer Id of the connected account string
data.reference The unique identifier of the payment string
data.meta Any additional information about the payment string
data.created_at The date and time the payment was created string
data.updated_at The date and time the payment was updated string
data.account The user's information object string
data.account._id The user's account ID string
data.account.institution The user's institution object string
data.account.institution.name The user's institution name string
data.account.institution.bankcode The user's institution bankcode string
data.account.institution.type The user's institution type(e.g Persornal Banking) string
data.account.name The user's name string
data.account.type The user's account type (e.g Savings Account) string
data.account.accountNumber The user's account number number
data.account.balance The user's account balance string
data.account.currency The user's account currency string
data.account.bvn The user's BVN number
data.account.livemode The payment environment boolean
data.account.timeline The timeline identifier for the payment string
data.account.created_at The date and time the user account was connected string
data.account.updated_at The date and time the user account was updated string

Did this page help you?