Skip to main content
POST
/
offramps
Create offramp order
curl --request POST \
  --url http://localhost:4000/v1/offramps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "<string>",
  "amount": "<string>",
  "rate": "<string>",
  "reference": "<string>",
  "returnAddress": "<string>",
  "recipient": {
    "institution": "<string>",
    "accountIdentifier": "<string>",
    "accountName": "<string>",
    "currency": "<string>",
    "memo": "<string>",
    "providerId": "<string>"
  }
}
'
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: '<string>',
    amount: '<string>',
    rate: '<string>',
    reference: '<string>',
    returnAddress: '<string>',
    recipient: {
      institution: '<string>',
      accountIdentifier: '<string>',
      accountName: '<string>',
      currency: '<string>',
      memo: '<string>',
      providerId: '<string>'
    }
  })
};

fetch('http://localhost:4000/v1/offramps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "http://localhost:4000/v1/offramps"

payload = {
    "customerId": "<string>",
    "amount": "<string>",
    "rate": "<string>",
    "reference": "<string>",
    "returnAddress": "<string>",
    "recipient": {
        "institution": "<string>",
        "accountIdentifier": "<string>",
        "accountName": "<string>",
        "currency": "<string>",
        "memo": "<string>",
        "providerId": "<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",
    "orderId": "<string>",
    "customerId": "<string>",
    "receiveAddress": "<string>",
    "validUntil": "2023-11-07T05:31:56Z",
    "amount": "<string>",
    "token": "<string>",
    "network": "<string>",
    "rate": "<string>",
    "reference": "<string>",
    "returnAddress": "<string>",
    "status": "<string>",
    "externalTransferId": "<string>",
    "recipient": {
      "institution": "<string>",
      "accountIdentifier": "<string>",
      "accountName": "<string>",
      "currency": "<string>",
      "memo": "<string>",
      "providerId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

​
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
​
customerId
string
required
​
amount
string
required
​
rate
string
required
​
reference
string
required
​
returnAddress
string
required
​
recipient
object
required
​
token
string
default:USDC
​
network
string
default:base

Response

201 - application/json

Offramp order

​
status
string
Example:

"success"

​
message
string
​
data
object