Payment with Token
Once a successful payment has been made using the Payment Advice endpoint and setting the shouldTokenizeCard value to true, you can use the token generated for subsequent transactions.
Method: POST
Endpoint: https://api.pelpay.ng/Payment/token
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
String
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's first name.
customerEmail
String
Yes
The paying customer's 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 one the credentials provided to customer after registration
notificationUrl
String
Yes
This is the call back URL.
token
String
Yes
The generated token to be used for recurrent payments.
Request Body:
{
"amount": 0,
"currency": "str",
"merchantRef": "string",
"narration": "string",
"callBackUrl": "string",
"splitCode": "string",
"shouldTokenizeCard": true,
"customer": {
"customerId": "string",
"customerLastName": "string",
"customerFirstName": "string",
"customerEmail": "string",
"customerPhoneNumber": "string",
"customerAddress": "string",
"customerCity": "string",
"customerStateCode": "string",
"customerPostalCode": "string",
"customerCountryCode": "string"
},
"integrationKey": "string",
"mcc": 0,
"merchantDescriptor": "string",
"notificationUrl": "string",
"token": "string"
}Last updated