Verification

When the transaction is done, you can use the reference token sent to verify the payment if it was successful or the transaction failed by sending a GET request to our Confirmation API. See format and required query parameters below.

• Method: GET

• Endpoint: https://api.pelpay.ng/api/Transaction/bypaymentreference/{{ref}}

Verification

GET https://api.pelpay.ng/api/Transaction/bypaymentreference/{{ref}}

Path Parameters

Name	Type	Description
referenceId	String

Headers

Name	Type	Description
Authorization*	Token	{{access_token}}

200: OK

{
  "requestSuccessful": true,
  "responseData": {
    "merchantCode": "mcode",
    "paymentReference": "551bd59d-70f4-4c9d-a161-0ec033b3sa",
    "merchantReference": "011000211205081224727731138882824436",
    "amountCollected": 100,
    "amount": 100,
    "callBackUrl": "{callback_url}?advicereference=dce15b63-ca70-4f73-a681-95ac80ee83f6&paymentreference=551bd59d-70f4-4c9d-a161-0ec033b33d1a",
    "processorCode": "00",
    "transactionStatus": "Successful",
    "currencyCode": "NGN",
    "accountNumber": "",
    "accountNumberMasked": "5399*****0706",
    "narration": "Fund Wallet",
    "env": "Live",
    "message": "Successful",
    "sessionMerchantID": "pelpaylocal",
    "orgId": "K8vif92e",
    "returnUrl": "https://api.pelpay.africa/payment/card/webhook?advicereference=dce15b63-ca76&paymentreference=551bd59d-ec033b33d1a",
    "amountPaid": "100.00"
  },
  "message": "Successful",
  "responseCode": "00"
}

Response Body:

Response Data	Value	Description
requestSuccessful	Boolean	Returns true if the request was successful.
paymentReference	String	The transaction reference generated from Pelpay.
merchantReference	String	The transaction reference used to initiate the transaction.
amountCollected	String	The amount and transaction charges.
amount	String	Amount debited from the merchant.
callBackUrl	String	This is the merchant specified destination link after Pelpay has processed payment.
transactionStatus	String	This is the status of the transaction. It can be successful or failed.
currencyCode	String	The currency code eg NGN.
accountNumber	String	Customer’s account number.
accountNumberMasked	String	The masked customer’s account number.
narration	String	Reason for the transaction.
message	String	Message from the transaction.
amountPaid	Number	Total amount paid in the transaction.
message	String	Message from the request.
responseCode	String	The response code from the request.

{
  "requestSuccessful": true,
  "responseData": {
    "merchantCode": "mcode",
    "paymentReference": "551bd59d-70f4-4c9d-a161-0ec033b3sa",
    "merchantReference": "011000211205081224727731138882824436",
    "amountCollected": 100,
    "amount": 100,
    "callBackUrl": "{callback_url}?advicereference=dce15b63-ca70-4f73-a681-95ac80ee83f6&paymentreference=551bd59d-70f4-4c9d-a161-0ec033b33d1a",
    "processorCode": "00",
    "transactionStatus": "Successful",
    "currencyCode": "NGN",
    "accountNumber": "",
    "accountNumberMasked": "5399*****0706",
    "narration": "Fund Wallet",
    "env": "Live",
    "message": "Successful",
    "sessionMerchantID": "pelpaylocal",
    "orgId": "K8vif92e",
    "returnUrl": "https://api.pelpay.africa/payment/card/webhook?advicereference=dce15b63-ca76&paymentreference=551bd59d-ec033b33d1a",
    "amountPaid": "100.00"
  },
  "message": "Successful",
  "responseCode": "00"
}