Skip to main content
POST
/
payment-routes
Create payment route
curl --request POST \
  --url https://api.remitflex.com/v1/payment-routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "originChainId": 2,
  "destinationChainId": 2,
  "destinationCurrency": "<string>",
  "destinationAddress": "<string>"
}
'

Authorizations

​
Authorization
string
header
required

API key created in the RemitFlex Dashboard (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"

Body

application/json
​
name
string
required
Required string length: 2 - 80
​
originChainId
integer
required
Required range: x >= 1
​
destinationChainId
integer
required
Required range: x >= 1
​
destinationCurrency
string
required
Required string length: 4 - 128
​
destinationAddress
string
required
Required string length: 8 - 128
​
originCurrency
string
Required string length: 4 - 128
​
refundTo
string
Required string length: 8 - 128
​
strict
boolean
default:false
​
customerId
string
Required string length: 1 - 128

Response

201

Payment route created