Skip to main content
POST
/
collections
/
{id}
/
cancel
Cancel payment link
curl --request POST \
  --url http://localhost:4000/v1/collections/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>'
const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', Authorization: 'Bearer <token>'}
};

fetch('http://localhost:4000/v1/collections/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "http://localhost:4000/v1/collections/{id}/cancel"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, 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

​
Authorization
string
header
required

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.

Headers

​
Idempotency-Key
string
required

Unique key for safe retries on mutating API-key requests. Cached for 24 hours per org, method, and path.

Maximum string length: 255
Example:

"7f3c2a1b-4e5d-6c7b-8a9f-0e1d2c3b4a5f"

Path Parameters

​
id
string<uuid>
required

Response

200 - application/json

Payment link

​
status
string
Example:

"success"

​
message
string
​
data
object