Skip to main content
Use this endpoint to look up the current state of any off-ramp you have previously initiated. The response returns the complete off-ramp object, including the latest status, updated_at timestamp, and — if the off-ramp failed — a failure_reason field explaining what went wrong.

​
Endpoint

GET https://api.remitflex.com/v1/offramp/{id}

​
Path Parameters

​
id
string
required
The unique identifier of the off-ramp to retrieve. Off-ramp IDs are prefixed with ofr_ and are returned when you initiate an off-ramp.

​
Status Values

The status field on the off-ramp object reflects the current stage in the off-ramp lifecycle. The table below describes each possible value.
StatusDescription
pendingOff-ramp has been initiated and is queued for processing.
processingRemitFlex is actively converting the stablecoin and preparing the bank transfer.
settledStablecoin conversion is complete and the bank transfer has been initiated.
deliveredThe destination bank has confirmed receipt of the funds.
failedThe off-ramp could not be completed. Inspect the failure_reason field for the error code.

​
Response Fields

​
id
string
Unique identifier for the off-ramp, prefixed with ofr_.
​
status
string
Current lifecycle state of the off-ramp. See Status Values above.
​
amount
number
The stablecoin amount originally submitted for conversion.
​
source_currency
string
The stablecoin that was converted (e.g., "USDC").
​
destination_currency
string
The ISO 4217 fiat currency code for the bank deposit (e.g., "EUR").
​
converted_amount
number
The fiat amount deposited or to be deposited into the bank account, after fees.
​
fee
number
The total fee charged for this off-ramp, denominated in the source_currency.
​
bank_account
object
Bank account details associated with this off-ramp.
​
reference
string
Your internal reference string, as provided when the off-ramp was created.
​
failure_reason
string
Present only when status is failed. Contains a machine-readable error code describing why the off-ramp could not be completed (e.g., "invalid_account_number", "compliance_rejected").
​
estimated_settlement
string
ISO 8601 timestamp of the expected settlement time. Only present while the off-ramp is in pending or processing state.
​
created_at
string
ISO 8601 timestamp of when the off-ramp was created.
​
updated_at
string
ISO 8601 timestamp of the most recent update to this off-ramp object.
​
metadata
object
The arbitrary key-value pairs attached to this off-ramp at creation time, returned as-is.

​
Example Request & Response

curl https://api.remitflex.com/v1/offramp/ofr_01HX9N4R \
  -H "Authorization: Bearer rf_live_xxxx"
Response
{
  "id": "ofr_01HX9N4R...",
  "status": "settled",
  "amount": 2500,
  "source_currency": "USDC",
  "destination_currency": "EUR",
  "converted_amount": 2306.25,
  "fee": 6.25,
  "bank_account": {
    "account_holder_name": "Acme Corp GmbH",
    "account_number": "DE89370400440532013000",
    "bank_name": "Deutsche Bank",
    "bank_country": "DE"
  },
  "reference": "Payout batch #42",
  "estimated_settlement": "2024-01-16T18:00:00Z",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T14:22:10Z",
  "metadata": {}
}

​
Polling vs. Webhooks

Polling this endpoint works for one-off lookups, but for production systems you should subscribe to webhook events instead. RemitFlex emits offramp.settled when the bank transfer is initiated and offramp.delivered when the destination bank confirms receipt — eliminating the need to poll and reducing unnecessary API calls. See the webhook events reference to explore all available event types.