Payment routes
Create payment route
Creates a cross-chain payment route. Requires api:write scope and Idempotency-Key.
POST
/
payment-routes
Create payment route
curl --request POST \
--url http://localhost:4000/v1/payment-routes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"originChainKey": "<string>",
"destinationChainKey": "<string>",
"destinationCurrency": "<string>",
"destinationAddress": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
originChainKey: '<string>',
destinationChainKey: '<string>',
destinationCurrency: '<string>',
destinationAddress: '<string>'
})
};
fetch('http://localhost:4000/v1/payment-routes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/payment-routes"
payload = {
"name": "<string>",
"originChainKey": "<string>",
"destinationChainKey": "<string>",
"destinationCurrency": "<string>",
"destinationAddress": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, 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"
Body
application/json
Specify networks with originChainKey / destinationChainKey. Use token codes like USDC for destinationCurrency.
Required string length:
2 - 80Origin network key from GET /payment-routes/chains (e.g. tron, bitcoin).
Settlement network — base or solana.
Token code — USDC or USDT on Base; USDC, USDT, or EURC on Solana.
Required string length:
2 - 128Required string length:
8 - 128Optional token code on the origin network.
Required string length:
2 - 128Required string length:
8 - 128Required string length:
1 - 128Available options:
wallet, exchange ⌘I
Create payment route
curl --request POST \
--url http://localhost:4000/v1/payment-routes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"originChainKey": "<string>",
"destinationChainKey": "<string>",
"destinationCurrency": "<string>",
"destinationAddress": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
originChainKey: '<string>',
destinationChainKey: '<string>',
destinationCurrency: '<string>',
destinationAddress: '<string>'
})
};
fetch('http://localhost:4000/v1/payment-routes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/payment-routes"
payload = {
"name": "<string>",
"originChainKey": "<string>",
"destinationChainKey": "<string>",
"destinationCurrency": "<string>",
"destinationAddress": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, 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"
}
}