Payment Advice

Create a Payment Advice

POST /api/advice

Create Payment Advice

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

{
  "amount": 100,
  "currency": "NGN",
  "merchantRef": "12345678909876543321",
  "narration": "test",
  "callBackUrl": "https://your_callback_url.com/",
  "splitCode": "",
  "shouldTokenizeCard": false,
  "customer": {
    "customerId": "cbl",
    "customerLastName": "Codes",
    "customerFirstName": "Bytes",
    "customerEmail": "[email protected]",
    "customerPhoneNumber": "",
    "customerAddress": "",
    "customerCity": "",
    "customerStateCode": "",
    "customerPostalCode": "",
    "customerCountryCode": "NG"
  },
  "integrationKey": "afc65827-ce24-44e1-bfa3-aa9d4b8e9ceb",
  "mcc": 0,
  "merchantDescriptor": "string"
}

Response

{
  "requestSuccessful": true,
  "responseData": {
    "currency": "NGN",
    "adviceReference": "eced58f4-c187-4f3c-8482-062cde42red5",
    "merchantRef": "13277654324537993",
    "amount": 100,
    "narration": "test",
    "customerId": "1092768",
    "charge": 0,
    "status": "Pending",
    "customerFullName": "Chams Switch",
    "merchantName": "Chams Switch",
    "paymentUrl": "https://payment.pelpay.ng/pay?adviceReference=eced58f4-c187-4f3c-8482-062cde42red5",
    "channels": [
      "Card",
      "BankTransfer",
      "USSD"
    ],
    "channel": [
      "Card",
      "BankTransfer",
      "USSD"
    ],
    "customerCharge": 0,
    "merchantCharge": 0,
    "vatCharge": 0
  }
}

Last updated