Payment routes
Archive payment route
Requires api:write scope and Idempotency-Key.
DELETE
/
payment-routes
/
{paymentRouteId}
Archive payment route
curl --request DELETE \
--url http://localhost:4000/v1/payment-routes/{paymentRouteId} \
--header 'Authorization: Bearer <token>' \
--header 'Idempotency-Key: <idempotency-key>'const options = {
method: 'DELETE',
headers: {'Idempotency-Key': '<idempotency-key>', Authorization: 'Bearer <token>'}
};
fetch('http://localhost:4000/v1/payment-routes/{paymentRouteId}', 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}"
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>"
}
response = requests.delete(url, headers=headers)
print(response.text){
"status": "success",
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"customerId": "<string>",
"customerName": "<string>",
"origin": {
"key": "<string>",
"network": "<string>",
"symbol": "<string>",
"address": "<string>",
"acceptableTokens": [
{
"symbol": "<string>",
"code": "<string>"
}
]
},
"destination": {
"address": "<string>",
"key": "<string>",
"network": "<string>",
"symbol": "<string>",
"acceptableTokens": [
{
"symbol": "<string>",
"code": "<string>"
}
]
},
"refundTo": "<string>",
"depositAddress": "<string>",
"relayRequestId": "<string>",
"strict": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}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
Archive payment route
curl --request DELETE \
--url http://localhost:4000/v1/payment-routes/{paymentRouteId} \
--header 'Authorization: Bearer <token>' \
--header 'Idempotency-Key: <idempotency-key>'const options = {
method: 'DELETE',
headers: {'Idempotency-Key': '<idempotency-key>', Authorization: 'Bearer <token>'}
};
fetch('http://localhost:4000/v1/payment-routes/{paymentRouteId}', 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}"
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>"
}
response = requests.delete(url, headers=headers)
print(response.text){
"status": "success",
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"customerId": "<string>",
"customerName": "<string>",
"origin": {
"key": "<string>",
"network": "<string>",
"symbol": "<string>",
"address": "<string>",
"acceptableTokens": [
{
"symbol": "<string>",
"code": "<string>"
}
]
},
"destination": {
"address": "<string>",
"key": "<string>",
"network": "<string>",
"symbol": "<string>",
"acceptableTokens": [
{
"symbol": "<string>",
"code": "<string>"
}
]
},
"refundTo": "<string>",
"depositAddress": "<string>",
"relayRequestId": "<string>",
"strict": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}