Payment Advice

After generating a token from the Login endpoint, The payment advice endpoint is called to generate payment link and also tokenize card for recurrent debit.

For card tokenization, make this attribute shouldTokenizeCard to true.

Parameter	Datatype	Required	Description
amount	Number	Yes	Amount to be debited from merchant.
currency	String	Yes	The currency code eg NGN.
merchantRef	String	Yes	The merchant ref is unique ref assigned to the merchant after registration on Pelpay.
narration	String	Yes	Reason for the transaction.
callBackUrl	String	Yes	This is the merchant specified destination link after Pelpay has processed payment.
splitCode	String	No	This is the code generated by the merchant from Pelpay portal on the process of sharing payments to various accounts as specified by merchant.
shouldTokenizeCard	Boolean	Yes	At default is false. When checked to true the system generates a code for recurrent payment.
customerId	String	Yes	The paying customer's ID.
customerLastName	String	Yes	The paying customer's last name.
customerFirstName	String	Yes	The paying customer first name.
customerEmail	String	Yes	The paying customer email address.
customerPhoneNumber	String	Yes	The paying customer's phone number.
customerAddress	String	Yes	The paying customer's address.
customerCity	String	Yes	The paying customer's city.
customerStateCode	String	Yes	The paying customer's state code.
customerPostalCode	String	Yes	Paying customer's postal code.
customerCountryCode	String	Yes	Paying customer's country code.
integrationKey	String	Yes	This is the credentials provided to customer after registration.

Payment Advice

POST https://api.pelpay.ng/payment/advice

Headers

Name	Type	Description
Authorization*	Token	{{access_token}}

Request Body

Name	Type	Description
amount	String
currency	String
merchantRef	String
narration	String
callBackUrl	String
splitCode	String
shouldTokenizeCard	Boolean
customerId	String
customerLastName	String
customerFirstName	String
customerEmail	String
customerPhoneNumber	String
customerAddress	String
customerCity	String
customerStateCode	String
customerPostalCode	String
customerCountryCode	String
integrationKey	String
mcc	String
merchantDescriptor	String

200: OK Successful

Response:
{
"requestSuccessful": true,
"responseData": {
"currency": "str",
"adviceReference": "6c4a4e48-dfbd-4a4e-8da2-2b4739234182",
"merchantRef": "13245654324567654",
"amount": 100,
"narration": "string",
"customerId": "1084276",
"charge": 0,
"status": "Pending",
"customerFullName": "Ferdinand Samuel",
"merchantName": "Kennochy Limited",
"paymentUrl": "https://payment.pelpay.ng/pay?adviceReference=6c4a4e48-dfbd-4a4e-8da2- 2b4739234182",
"channel": [ "Card", "BankTransfer" ]
},
"message": "Successful", "responseCode": "00"
}`

Request Body:

{
  "amount": 100,
  "currency": "str",
  "merchantRef": "13245654324567654",
  "narration": "string",
  "callBackUrl": "https://your_callback_url.com/",
  "splitCode": "",
  "shouldTokenizeCard": true,
  "customer": {
    "customerId": "sff",
    "customerLastName": "Ferdinand",
    "customerFirstName": "Samuel",
    "customerEmail": "[email protected]",
    "customerPhoneNumber": "",
    "customerAddress": "",
    "customerCity": "",
    "customerStateCode": "",
    "customerPostalCode": "",
    "customerCountryCode": "NG"
  },
  "integrationKey": "a6ccab0e-157d-4fb7-b15d-ddb7cd149153",
  "mcc": 0,
  "merchantDescriptor": "string"
}'

Response Body:

Response Data	Value
requestSuccessful	Boolean
currency	String
adviceReference	String
merchantRef	String
amount	Number
narration	String
customerId	String
charge	Number
status	String
customerFullName	String
merchantName	String
paymentUrl	String
channel	String
message	String
responseCode	Number

Response:
{
"requestSuccessful": true,
"responseData": {
"currency": "str",
"adviceReference": "6c4a4e48-dfbd-4a4e-8da2-2b4739234182",
"merchantRef": "13245654324567654",
"amount": 100,
"narration": "string",
"customerId": "1084276",
"charge": 0,
"status": "Pending",
"customerFullName": "Ferdinand Samuel",
"merchantName": "Kennochy Limited",
"paymentUrl": "https://payment.pelpay.ng/pay?adviceReference=6c4a4e48-dfbd-4a4e-8da2- 2b4739234182",
"channel": [ "Card", "BankTransfer" ]
},
"message": "Successful", "responseCode": "00"
}`