mono-logo

Verify a Payment Status

Last updated Sept 24th, 2022

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

API Object

Request

123456789101112131415161718192021222324252627282930313233343536
{
  "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"
    }  
  }
}

Payment Fields

FieldDescriptionType
typeThe payment typestring
dataThe payment dataobject
data.idThe primary id for the payment.number
data.idThe payment idstring
data.statusThe status of the payment.string
data.messageThe message returned depending on the payment status.number
data.amountThe payment's total value in the smallest denomination, such as a Kobo (Nigeria) or a Pesewa (Ghana).string
data.descriptionThe payment description.number
data.feeThe charge for the payment.string
data.currencyThe currency of the payment account (NGN, GHS, etc).string
data.customerThe Customer Id of the connected account.string
data.referenceThe unique identifier of the payment.string
data.metaAny additional information about the payment.string
data.created_atThe date and time the payment was created.string
data.updated_atThe date and time when the payment was updated.string
data.accountThe user's information object.string
data.account._idThe user's account ID.string
data.account.institutionThe user's institution object.string
data.account.institution.namedata.account.institution.namestring
data.account.institution.bankcodeThe user's institution bankcode.string
data.account.institution.typeThe user's institution type(e.g Personal Banking).string
data.account.nameThe user's name.string
data.account.typeThe user's account type (e.g Savings Account).string
data.account.accountNumberThe user's account number.number
data.account.balanceThe user's account balance.string
data.account.currencyThe user's account currency.string
data.account.bvnThe user's BVN.number
data.account.livemodeThe payment environment.boolean
data.account.timelineThe timeline identifier for the payment.string
data.account.created_atThe date and time the user account was connected.string
data.account.updated_atThe date and time the user account was updated.string

Did this page help you?