Authentication
Organisations
Balance
Checkout
Payment Methods
Customers
Update Payment Link
Copy
curl --request PATCH \
--url https://api.cashful.africa/api/canary/payment-links/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {
"orderId": "12345"
}
}
'Copy
{
"statusCode": 400,
"message": [
"Bad Request"
],
"error": "Bad Request"
}Payment Links
Update Payment Link
Update an existing payment link
PATCH
/
api
/
canary
/
payment-links
/
{id}
Update Payment Link
Copy
curl --request PATCH \
--url https://api.cashful.africa/api/canary/payment-links/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {
"orderId": "12345"
}
}
'Copy
{
"statusCode": 400,
"message": [
"Bad Request"
],
"error": "Bad Request"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the payment link
Body
application/json
Payment link update details
Optional custom metadata
Example:
{ "orderId": "12345" }The name of the payment link
A description of the payment link
Whether the payment link is active
The URL to redirect to on successful payment
The URL to redirect to if customer cancels
Configuration for the hosted checkout page
Show child attributes
Show child attributes
Response
Payment link updated successfully
⌘I