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.
post/api/channels/{entityId}/payments
Path parameters
entityIdstring required
Example:8ac7a4ca694cec2601694cf5f9360026
The entity for the request.
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": {
"email": "name@example.com",
"fax": "2919392022",
"givenName": "Jane",
"surname": "Doe",
"mobile": "27610107822",
"phone": "27210030000",
"ip": "0.0.0.0",
"merchantCustomerLanguage": "EN",
"status": "NEW",
"merchantCustomerId": "sxxopjqy",
"taxId": "4550045030303",
"taxType": "tax type",
"birthDate": "1996-08-07",
"browser": {
"acceptHeader": "application/json",
"language": "EN",
"screenHeight": "1080",
"screenWidth": "1920",
"timezone": "30",
"userAgent": "Mozilla/5.0 (Android 4.4; Mobile; rv:41.0) Gecko/41.0 Firefox/41.0",
"javaEnabled": "false",
"javascriptEnabled": "true",
"screenColorDepth": "24",
"challengeWindow": "01"
}
},
"options": {
"emailCc": "ccexample@example.com",
"emailBcc": "bccexample@example.com",
"expiryTime": 5,
"notificationUrl": "https://example.com/example-webhook/"
},
"checkout": {
"defaultPaymentMethod": "CARD",
"paymentType": "DB"
}
}Response
OK.
Example response
{
"url": "https://l.ppay.io/G56F5_ll",
"id": "HBgast80997asAU"
}