Verify Transaction

This endpoint is used to verify a payment transaction with a reference ID.

GET /api/payment/verify/{reference}

Example Request

curl --location --request GET 'https://paywithbank3d.com/api/payment/verify/reference \' 
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <client_id:client_secret>' \

Response

{
 "hmac":
"feffc947c4a88cc1d91d5d3e7c3392838f0e50502bd3a7f8313d7854a9632714",
 "mode": "dev",

"status": "SUCCESSFUL",
"code": "00",
 "description": "Approved by Financial Institution",
 "amount": 4000000,
 "merchantRef": "WQ-506391000507913",
 "transactionRef": "0000000000000044177",
 "paymentRef": "330137174040",
 "currencyCode": "NGN",
 "data": {
 "pan": "501501******5015",
 "expiry": "01/30",
 "expiryDate": "2030-01-31T23:59:00.000"
 },
 "option": "card",
 "nextAction": "APPROVE",
 "transactionDate": "2022-11-14T22:33:37.833Z",
 "paymentDate": "2022-11-14T22:34:24.913Z"
}

Path Parameter

reference · string

A unique reference ID associated with the payment transaction.

Response

hmac · string

A crytographic hash(HMAC) representing the integrity of the data.

mode · string

Indicates the mode, which is set to “dev” in this case.

status · string

Represents the status of the transaction, which is either “SUCCESSFUL” or “FAILED”

code · string

A code associated with the transaction status

description · string

A description of the transaction status, indicating it was “Approved by Financial Institution.”

amount · number

The transaction amount (currency is specified in Kobo)

merchantRef · string

A reference associated with the merchant

transactionRef · string

A reference for the transaction.

paymentRef · string

A payment reference related to the transaction

currencyCode · string

The currency code for the transaction, which is “NGN” (Nigerian Naira)

data · object

An object containing additional data related to the transaction:

Show object content

pan · string

don’t know what this is

token · string

Card expiry date

expiryDate · string

Card expiry date in ISO 8601 format, including the time.

option · string

Specifies the payment option used, which is “card.”

nextAction · string

Indicates the next action to be taken, which is “APPROVE.”

transactionDate · string

The date and time of the transaction in ISO 8601 format

paymentDate · string

The date and time when the payment was made in ISO 8601 format.

Example Request

curl --location --request GET 'https://paywithbank3d.com/api/payment/verify/reference \' 
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <client_id:client_secret>' \

Response

{
 "hmac":
"feffc947c4a88cc1d91d5d3e7c3392838f0e50502bd3a7f8313d7854a9632714",
 "mode": "dev",

"status": "SUCCESSFUL",
"code": "00",
 "description": "Approved by Financial Institution",
 "amount": 4000000,
 "merchantRef": "WQ-506391000507913",
 "transactionRef": "0000000000000044177",
 "paymentRef": "330137174040",
 "currencyCode": "NGN",
 "data": {
 "pan": "501501******5015",
 "expiry": "01/30",
 "expiryDate": "2030-01-31T23:59:00.000"
 },
 "option": "card",
 "nextAction": "APPROVE",
 "transactionDate": "2022-11-14T22:33:37.833Z",
 "paymentDate": "2022-11-14T22:34:24.913Z"
}