Error
A valid request URL is required to generate request examples{
"success": true,
"message": "Payment link updated successfully",
"data": {
"id": "<string>",
"shortCode": "<string>",
"url": "<payment-link-url>/abc123",
"name": "<string>",
"type": "standard",
"pricing": {
"type": "fixed",
"currency": "KES",
"referenceCurrency": "KES",
"amount": 123,
"minAmount": 123,
"maxAmount": 123,
"packages": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "KES",
"description": "<string>"
}
]
},
"enabledPaymentMethods": [
"mobile_money"
],
"usageType": "single_use",
"currentUses": 123,
"isActive": true,
"collectCustomerInfo": {
"email": "required",
"phone": "required",
"name": "required",
"address": "required"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"paymentMethodConfig": {
"mobileMoneyProviders": [
"<string>"
],
"mobileMoneyCurrencies": [
"KES",
"GHS"
],
"mobileMoneyCountries": [
"<string>"
],
"supportedCurrencies": [
"<string>"
],
"cryptoNetworks": [
"<string>"
],
"cryptoCurrencies": [
"USDT",
"USDC"
],
"cardCurrencies": [
"<string>"
],
"cardCountries": [
"<string>"
],
"bankCurrencies": [
"<string>"
],
"bankCountries": [
"<string>"
]
},
"maxUses": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"afterPayment": {
"type": "message",
"message": "<string>",
"redirectUrl": "https://yourdomain.com/thank-you"
},
"branding": {
"logoUrl": "https://yourdomain.com/logo.png",
"primaryColor": "#0084FF",
"backgroundColor": "#FFFFFF"
},
"qrCodeUrl": "<string>",
"lastUsedAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"message": "Invalid API Key",
"data": {}
}Payment Links
Update Payment Link
type and usageType cannot be changed after creation.
PATCH
/
api
/
v3
/
payment-links
/
{id}
Error
A valid request URL is required to generate request examples{
"success": true,
"message": "Payment link updated successfully",
"data": {
"id": "<string>",
"shortCode": "<string>",
"url": "<payment-link-url>/abc123",
"name": "<string>",
"type": "standard",
"pricing": {
"type": "fixed",
"currency": "KES",
"referenceCurrency": "KES",
"amount": 123,
"minAmount": 123,
"maxAmount": 123,
"packages": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "KES",
"description": "<string>"
}
]
},
"enabledPaymentMethods": [
"mobile_money"
],
"usageType": "single_use",
"currentUses": 123,
"isActive": true,
"collectCustomerInfo": {
"email": "required",
"phone": "required",
"name": "required",
"address": "required"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"paymentMethodConfig": {
"mobileMoneyProviders": [
"<string>"
],
"mobileMoneyCurrencies": [
"KES",
"GHS"
],
"mobileMoneyCountries": [
"<string>"
],
"supportedCurrencies": [
"<string>"
],
"cryptoNetworks": [
"<string>"
],
"cryptoCurrencies": [
"USDT",
"USDC"
],
"cardCurrencies": [
"<string>"
],
"cardCountries": [
"<string>"
],
"bankCurrencies": [
"<string>"
],
"bankCountries": [
"<string>"
]
},
"maxUses": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"afterPayment": {
"type": "message",
"message": "<string>",
"redirectUrl": "https://yourdomain.com/thank-you"
},
"branding": {
"logoUrl": "https://yourdomain.com/logo.png",
"primaryColor": "#0084FF",
"backgroundColor": "#FFFFFF"
},
"qrCodeUrl": "<string>",
"lastUsedAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"message": "Invalid API Key",
"data": {}
}Update a payment link’s name, pricing, enabled payment methods, expiry, or branding.
type and usageType cannot be changed after creation — create a new link instead.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Note: type and usageType cannot be changed after creation.
Show child attributes
Show child attributes
Available options:
mobile_money, bank, card, crypto Restricts which providers/currencies/networks/countries are offered per payment method. All fields optional — omit to allow everything enabled on your account.
Show child attributes
Show child attributes
Whether email, phone, name, and address are required, optional, or not collected at checkout.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes