Generate or cancel

Generate link

Generate a unique payment link for a transaction and optionally send this link to the recipient via email, SMS, WhatsApp, or a combination of the three.

For more information, see the documentation, and for sample calls, see the public Postman collection.

post/api/channels/{entityId}/payments

Request

Base URL
https://sandbox-l.ppay.io
URL
https://sandbox-l.ppay.io/api/channels/{entityId}/payments
Auth
HTTP bearer

Request body

Example request

{
  "payment": {
    "merchantInvoiceId": "INV90001",
    "amount": 10,
    "currency": "ZAR",
    "files": [
      "8DA36E1E-B5DB-45CC-871C-47BDDCD3C2CF"
    ],
    "notes": "Please pay this at your earliest convenience."
  },
  "customer": {
    "givenName": "Grace",
    "surname": "Nkosi",
    "email": "grace.nkosi@example.com",
    "mobile": "+27123456789",
    "whatsapp": "+27123456789",
    "billing": {
      "street1": "123 Example Street",
      "city": "Cape Town",
      "state": "Western Cape",
      "postalCode": "7000",
      "country": "ZA"
    }
  },
  "options": {
    "emailCc": "ccexample@example.com",
    "emailBcc": "bccexample@example.com",
    "expiryTime": 5,
    "notificationUrl": "https://example.com/example-webhook/"
  },
  "checkout": {
    "defaultPaymentMethod": "CARD",
    "paymentType": "DB"
  }
}

Response

Payment link successfully generated.

urlstring required

Payment link.

idstring required

ID of payment link.

Example response

{
  "url": "https://l.ppay.io/G56F5_ll",
  "id": "HBgast80997asAU"
}

Changes

No recorded changes to this operation across all 1 revision of this API.