Skip to main content
PATCH
/
api
/
canary
/
payment-links
/
{id}
Update Payment Link
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"
  }
}
'
{
  "statusCode": 400,
  "message": [
    "Bad Request"
  ],
  "error": "Bad Request"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The unique identifier of the payment link

Body

application/json

Payment link update details

​
metadata
object
required

Optional custom metadata

Example:
{ "orderId": "12345" }
​
name
string

The name of the payment link

​
description
string

A description of the payment link

​
active
boolean

Whether the payment link is active

​
totalAmount
number
​
successUrl
string

The URL to redirect to on successful payment

​
cancelUrl
string

The URL to redirect to if customer cancels

​
hostedCheckoutConfig
object

Configuration for the hosted checkout page

Response

Payment link updated successfully