Skip to main content
DELETE
/
offramps
/
{orderId}
Cancel offramp order
curl --request DELETE \
  --url http://localhost:4000/v1/offramps/{orderId} \
  --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/offramps/{orderId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "http://localhost:4000/v1/offramps/{orderId}"

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",
    "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"

Path Parameters

orderId
string
required

Response

200 - application/json

Offramp order

status
string
Example:

"success"

message
string
data
object