Update Payment Link

This API allows partners to update details associated with a payment link.
patch
https://<PayEngine-host>
/api/payment-link/:id
Sample Request Body
Sample Response Body
{
"merchantId": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
"data": {
"amount": 12.50,
"payerId": "1234",
"currencyCode": "USD",
"salesTax": 2.50,
"orderNumber": "A350",
"payerEmail": "[email protected]",
"startDate": "20220510",
"endDate": "20221115",
"description": "A coffee cup in the morning"
}
}
{
"data": {
"paymentLinkId": "wlx57",
"merchantId": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
"amount": "12.50",
"currencyCode": "USD",
"salesTax": "2.50",
"orderNumber": "A350",
"payerId": "1234",
"payerEmail": "[email protected]",
"description": "A coffee cup in the morning",
"startDate": "2022-05-10T00:00:00.000Z",
"endDate": "2022-11-15T00:00:00.000Z",
"createdAt": "2022-09-11T03:36:42.113Z",
"updatedAt": "2022-09-11T03:36:42.113Z",
"paymentLinkStatus": "ACTIVE",
"paymentLinkUrl": "<Payment URL>",
"qrCodeUrl": "<QRCode Image URL>"
}
}
Webhook event: PAYMENTLINK_UPDATED

Webhook Payload Example

{
event_uid: '4d304a4ed5a4e338b4753ab832efd9c0',
event: 'PAYMENTLINK_UPDATED',
data: {
paymentLinkId: '4ny14',
paymentUrl: <payment link url>,
qrCodeUrl: <qr code url>,
paymentLinkStatus: 'ACTIVE',
merchantId: 'c404d923-226f-4aae-92da-22c1ef370434',
startDate: <start timestamp>,
endDate: <end timestamp>,
amount: '150.00',
payerId: 'CUST23765',
description: 'Payment for invoice #45324'
}
}