Payment links
Update payment link
Update metadata, embed theme, or cancel (status cancelled). Logo is uploaded separately via POST /collections//logo. Requires api:write.
PATCH
/
collections
/
{collectionId}
Update payment link
curl --request PATCH \
--url http://localhost:4000/v1/collections/{collectionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"reference": "<string>",
"fromName": "<string>",
"payeeName": "<string>",
"successRedirectUrl": "<string>",
"embedConfig": {
"layout": "default",
"accentColor": "<string>",
"backgroundColor": "<string>",
"textColor": "<string>",
"mutedTextColor": "<string>",
"borderColor": "<string>",
"borderRadius": 16,
"fontFamily": "<string>",
"hideBrandFooter": true,
"hideStepIndicator": true,
"hideMerchantBanner": true,
"labels": {
"continueButton": "<string>",
"sentButton": "<string>",
"checkAgainButton": "<string>",
"modalTitle": "<string>"
}
},
"status": "cancelled"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
reference: '<string>',
fromName: '<string>',
payeeName: '<string>',
successRedirectUrl: '<string>',
embedConfig: {
layout: 'default',
accentColor: '<string>',
backgroundColor: '<string>',
textColor: '<string>',
mutedTextColor: '<string>',
borderColor: '<string>',
borderRadius: 16,
fontFamily: '<string>',
hideBrandFooter: true,
hideStepIndicator: true,
hideMerchantBanner: true,
labels: {
continueButton: '<string>',
sentButton: '<string>',
checkAgainButton: '<string>',
modalTitle: '<string>'
}
},
status: 'cancelled'
})
};
fetch('http://localhost:4000/v1/collections/{collectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/collections/{collectionId}"
payload = {
"label": "<string>",
"reference": "<string>",
"fromName": "<string>",
"payeeName": "<string>",
"successRedirectUrl": "<string>",
"embedConfig": {
"layout": "default",
"accentColor": "<string>",
"backgroundColor": "<string>",
"textColor": "<string>",
"mutedTextColor": "<string>",
"borderColor": "<string>",
"borderRadius": 16,
"fontFamily": "<string>",
"hideBrandFooter": True,
"hideStepIndicator": True,
"hideMerchantBanner": True,
"labels": {
"continueButton": "<string>",
"sentButton": "<string>",
"checkAgainButton": "<string>",
"modalTitle": "<string>"
}
},
"status": "cancelled"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"status": "success",
"message": "Payment link created",
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567891",
"status": "awaiting_origin",
"linkMode": "invoice",
"pricingType": "fixed",
"payerSource": "wallet",
"label": "Invoice #1042",
"reference": "INV-1042",
"fromName": null,
"payeeName": "Acme Ltd",
"logoUrl": null,
"customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"customerName": "Acme Ltd",
"receiveAmount": 500,
"receiveAmountAtomic": "500000000",
"sendAmount": null,
"amount": 500,
"amountAtomic": "500000000",
"origin": null,
"destination": {
"key": "solana",
"network": "Solana",
"symbol": "USDC",
"address": "2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB"
},
"expectedAmountOut": null,
"receivedAmountOut": null,
"refundTo": null,
"depositAddress": null,
"relayRequestId": null,
"relayStatus": null,
"depositTxHash": null,
"inTxHashes": [],
"outTxHashes": [],
"failReason": null,
"successRedirectUrl": null,
"payUrl": "https://pay.remitflex.io/a1b2c3d4-e5f6-7890-abcd-ef1234567891",
"embedUrl": "https://pay.remitflex.io/embed/a1b2c3d4-e5f6-7890-abcd-ef1234567891",
"embedConfig": {
"layout": "default"
},
"quoteValidUntil": null,
"quotedAt": null,
"completedAt": null,
"createdAt": "2026-06-26T09:00:00.000Z",
"updatedAt": "2026-06-26T09:00:00.000Z"
}
}Authorizations
API key created in the Remitflex Dashboard at dashboard.remitflex.io (rmf_live_... or rmf_test_...).
Key management endpoints require a dashboard JWT and are not part of this reference.
Path Parameters
RemitFlex payment link (collection) UUID — parent link or checkout session id from create/list/get.
Body
application/json
Partial update. Set status to cancelled to void an open link. Logo uses POST /collections/{collectionId}/logo (multipart).
⌘I
Update payment link
curl --request PATCH \
--url http://localhost:4000/v1/collections/{collectionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"reference": "<string>",
"fromName": "<string>",
"payeeName": "<string>",
"successRedirectUrl": "<string>",
"embedConfig": {
"layout": "default",
"accentColor": "<string>",
"backgroundColor": "<string>",
"textColor": "<string>",
"mutedTextColor": "<string>",
"borderColor": "<string>",
"borderRadius": 16,
"fontFamily": "<string>",
"hideBrandFooter": true,
"hideStepIndicator": true,
"hideMerchantBanner": true,
"labels": {
"continueButton": "<string>",
"sentButton": "<string>",
"checkAgainButton": "<string>",
"modalTitle": "<string>"
}
},
"status": "cancelled"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
reference: '<string>',
fromName: '<string>',
payeeName: '<string>',
successRedirectUrl: '<string>',
embedConfig: {
layout: 'default',
accentColor: '<string>',
backgroundColor: '<string>',
textColor: '<string>',
mutedTextColor: '<string>',
borderColor: '<string>',
borderRadius: 16,
fontFamily: '<string>',
hideBrandFooter: true,
hideStepIndicator: true,
hideMerchantBanner: true,
labels: {
continueButton: '<string>',
sentButton: '<string>',
checkAgainButton: '<string>',
modalTitle: '<string>'
}
},
status: 'cancelled'
})
};
fetch('http://localhost:4000/v1/collections/{collectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/collections/{collectionId}"
payload = {
"label": "<string>",
"reference": "<string>",
"fromName": "<string>",
"payeeName": "<string>",
"successRedirectUrl": "<string>",
"embedConfig": {
"layout": "default",
"accentColor": "<string>",
"backgroundColor": "<string>",
"textColor": "<string>",
"mutedTextColor": "<string>",
"borderColor": "<string>",
"borderRadius": 16,
"fontFamily": "<string>",
"hideBrandFooter": True,
"hideStepIndicator": True,
"hideMerchantBanner": True,
"labels": {
"continueButton": "<string>",
"sentButton": "<string>",
"checkAgainButton": "<string>",
"modalTitle": "<string>"
}
},
"status": "cancelled"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"status": "success",
"message": "Payment link created",
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567891",
"status": "awaiting_origin",
"linkMode": "invoice",
"pricingType": "fixed",
"payerSource": "wallet",
"label": "Invoice #1042",
"reference": "INV-1042",
"fromName": null,
"payeeName": "Acme Ltd",
"logoUrl": null,
"customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"customerName": "Acme Ltd",
"receiveAmount": 500,
"receiveAmountAtomic": "500000000",
"sendAmount": null,
"amount": 500,
"amountAtomic": "500000000",
"origin": null,
"destination": {
"key": "solana",
"network": "Solana",
"symbol": "USDC",
"address": "2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB"
},
"expectedAmountOut": null,
"receivedAmountOut": null,
"refundTo": null,
"depositAddress": null,
"relayRequestId": null,
"relayStatus": null,
"depositTxHash": null,
"inTxHashes": [],
"outTxHashes": [],
"failReason": null,
"successRedirectUrl": null,
"payUrl": "https://pay.remitflex.io/a1b2c3d4-e5f6-7890-abcd-ef1234567891",
"embedUrl": "https://pay.remitflex.io/embed/a1b2c3d4-e5f6-7890-abcd-ef1234567891",
"embedConfig": {
"layout": "default"
},
"quoteValidUntil": null,
"quotedAt": null,
"completedAt": null,
"createdAt": "2026-06-26T09:00:00.000Z",
"updatedAt": "2026-06-26T09:00:00.000Z"
}
}