Remitflex Documentation

POST

collections

{id}

sync

Sync payment link status

curl --request POST \
  --url http://localhost:4000/v1/collections/{id}/sync \
  --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}/sync', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

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

response = requests.post(url, headers=headers)

print(response.text)

{
  "status": "success",
  "message": "Payment link synced",
  "data": {
    "synced": true,
    "collectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567891"
  }
}

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

string<uuid>

required

Response

200 - application/json

Payment link sync result

status

string

Example:

"success"

message

string

data

object

Show child attributes

Update payment link

Cancel payment link

Sync payment link status

curl --request POST \
  --url http://localhost:4000/v1/collections/{id}/sync \
  --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}/sync', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

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

response = requests.post(url, headers=headers)

print(response.text)

{
  "status": "success",
  "message": "Payment link synced",
  "data": {
    "synced": true,
    "collectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567891"
  }
}