Payment routes
Sync route deposits
Pulls latest deposit state for the route. Requires api:write scope and Idempotency-Key.
POST
/
payment-routes
/
{paymentRouteId}
/
deposits
/
sync
Sync route deposits
curl --request POST \
--url http://localhost:4000/v1/payment-routes/{paymentRouteId}/deposits/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/payment-routes/{paymentRouteId}/deposits/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/payment-routes/{paymentRouteId}/deposits/sync"
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>"
}
response = requests.post(url, headers=headers)
print(response.text){
"status": "success",
"message": "Payment route deposits synced",
"data": {
"synced": 2,
"routeId": "route-uuid-001"
}
}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.
Headers
Unique key for safe retries on mutating API-key requests. Cached for 24 hours per org, method, and path.
Maximum string length:
255Example:
"7f3c2a1b-4e5d-6c7b-8a9f-0e1d2c3b4a5f"
Path Parameters
RemitFlex payment route UUID (id from POST /payment-routes or GET /payment-routes).
⌘I
Sync route deposits
curl --request POST \
--url http://localhost:4000/v1/payment-routes/{paymentRouteId}/deposits/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/payment-routes/{paymentRouteId}/deposits/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/payment-routes/{paymentRouteId}/deposits/sync"
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>"
}
response = requests.post(url, headers=headers)
print(response.text){
"status": "success",
"message": "Payment route deposits synced",
"data": {
"synced": 2,
"routeId": "route-uuid-001"
}
}