Payment routes
Get payment route
Requires api:read scope.
GET
/
payment-routes
/
{paymentRouteId}
Get payment route
curl --request GET \
--url http://localhost:4000/v1/payment-routes/{paymentRouteId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {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 = {"Authorization": "Bearer <token>"}
response = requests.get(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"
}
}{
"status": "error",
"message": "Payment route not found"
}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 route UUID (id from POST /payment-routes or GET /payment-routes).
⌘I
Get payment route
curl --request GET \
--url http://localhost:4000/v1/payment-routes/{paymentRouteId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {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 = {"Authorization": "Bearer <token>"}
response = requests.get(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"
}
}{
"status": "error",
"message": "Payment route not found"
}