Get Off Ramp Order(s)
Get detailed offramp order(s) data associated with your partner account. In an offramp order, the user sells USDC for a USD payout to their bank account. Sync offramp transaction records directly into your existing infrastructure to power internal financial dashboards, programmatically reconcile fiat bank payouts against crypto deposits, track order lifecycle statuses, equip support teams to investigate payout delays, display sell history to your end-users, and more. Tailor your requests to fit your specific workflow using flexible querying and filtering parameters.
Endpoints
| Environment | Method | Endpoint |
|---|---|---|
| Sandbox | GET | https://partner-sandbox.wert.io/api/external/offramp-orders |
| Production | GET | https://partner.wert.io/api/external/offramp-orders |
Limits
- Partner Account Scope: You can only query orders that were created by with your partner account.
Query Parameters
Configure your request using the parameters below to search and filter offramp order results.
Pagination Reference
- Orders are returned newest first.
- Pass the next_cursor_id from the previous response as cursor_id to get the next page. An empty next_cursor_id means there are no more orders.
- The maximum is 20 orders per request.
numberThe number of orders you want to retrieve. Defaults to 20. Values from 1 to 19 are applied as given. Any other value returns up to 20 orders.
Possible values: 1 to 20
stringFetches the next page of results using the next_cursor_id from a previous response.
Defaults to an empty string.
Possible values: 01KAQWBNWWGG06HR5T9Z35A3WD
stringFinds orders by one value: an exact order_id, or the beginning of an external_order_id or click_id.
Prefix matching is case-insensitive.
Possible values: Single value, for example 2FX6Yz (comma-separated values are not supported).
enum <string>Filters orders by their current status, the same value returned in the status field.
Possible values: See Offramp Order Statuses.
string (ISO 8601 date-time format)Filters orders with created_at at or after this timestamp.
Note: Use
start_dateandend_datetogether to return orders for a specific period. Orders are returned newest first, with a maximum of 20 orders per request.
Possible values: YYYY-MM-DDTHH:MM:SSZ, for example 2025-11-19T00:00:00Z.
string (ISO 8601 date-time format)Filters orders with created_at up to this timestamp.
Note: Use
start_dateandend_datetogether to return orders for a specific period. Orders are returned newest first, with a maximum of 20 orders per request.
Possible values: YYYY-MM-DDTHH:MM:SSZ, for example 2025-11-19T00:00:00Z.
Example Requests
# 1. Get the 20 most recent offramp orders (default)
curl -X GET 'https://partner-sandbox.wert.io/api/external/offramp-orders' \
-H 'X-Api-Key: your-unique-api-key'
# 2. Retrieve the next 10 orders using a cursor
curl -X GET -G 'https://partner-sandbox.wert.io/api/external/offramp-orders' \
-H 'X-Api-Key: your-unique-api-key' \
-d 'limit=10' \
-d 'cursor_id=01KAQWBNWWGG06HR5T9Z35A3WD'
# 3. Find an order by its order_id
curl -X GET -G 'https://partner-sandbox.wert.io/api/external/offramp-orders' \
-H 'X-Api-Key: your-unique-api-key' \
-d 'search_by=01KAQWBNWWGG06HR5T9Z35A3WD'
# 4. Search by the beginning of an external_order_id or click_id
curl -X GET -G 'https://partner-sandbox.wert.io/api/external/offramp-orders' \
-H 'X-Api-Key: your-unique-api-key' \
-d 'search_by=2FX6'
# 5. Filter orders by status
curl -X GET -G 'https://partner-sandbox.wert.io/api/external/offramp-orders' \
-H 'X-Api-Key: your-unique-api-key' \
-d 'status=completed'
# 6. Filter orders by date range
curl -X GET -G 'https://partner-sandbox.wert.io/api/external/offramp-orders' \
-H 'X-Api-Key: your-unique-api-key' \
-d 'start_date=2025-11-19T00:00:00Z' \
-d 'end_date=2025-11-19T23:59:59Z'Response
booleanIndicates if the request was successfully processed.
object[]Show child attributes
string
The unique identifier for the order in Wert's database.
string
The short identifier for the order. Omitted when the order has none.
string
The click ID passed when the order was opened. Always present, and can be an empty string.
string
The unique identifier for the user in Wert's database.
enum <string>
The current status of the order.
Possible values: See Offramp Order Statuses.
string
Timestamp of when the order was created (UTC), in YYYY-MM-DD HH:MM:SS format.
See Example Response for the time format.
string
Timestamp of when the order was last updated (UTC), in YYYY-MM-DD HH:MM:SS format.
See Example Response for the time format.
string
The USDC amount set when the order was created.
string
The USDC amount received from the user. Omitted if no deposit has been recorded.
string
The fee deducted from the payout, in USD. Omitted if it has not been calculated.
string
The amount paid out to the user's bank account, in USD. Omitted if it has not been calculated.
string
Blockchain transaction hash of the user's deposit. Omitted if no deposit has been recorded.
string
The last four digits of the bank account the order pays out to.
enum <string>
The blockchain network of the deposit.
Possible values: ethereum, polygon, or base.
string
The crypto asset sold: USDC.
stringThe cursor string used to fetch the next page of results. An empty string means there are no more orders.
numberThe count of offramp orders matching the search criteria. The count does not depend on cursor_id.
Example Response
{
"success": true,
"data": [
{
"account_number_last4": "6789",
"asset": "USDC",
"changed_at": "2026-06-02 09:12:05",
"click_id": "click_id",
"created_at": "2026-06-02 08:44:43",
"external_order_id": "zvLHq",
"fee_amount": "1.5",
"incoming_amount": "100",
"network": "ethereum",
"order_id": "01KT3R3BQ2ZRBHZN58E6VVY5F3",
"outgoing_amount": "98.5",
"quoted_amount": "100",
"status": "completed",
"tx_id": "0xe6456e64a1e6d7f226deb7ff344cb5321a3a997165ea24569465493ff7385216",
"user_id": "01HQRBTDW17YQSZFBWZY7807B1"
}
],
"next_cursor_id": "",
"total": 1
}References
Offramp Order Status
The status field and the status filter use the following values:
createdawaiting_depositcrypto_receivedtransfer_pendingcompletedfailedexpiredon_holdcancelled
If Wert support overrides the status of an order, status returns the overridden value and the status filter matches it.
Offramp Order Errors
Possible error responses from the Offramp Orders endpoint.
{
"message": "search_by accepts one order id or external id prefix"
}{
"message": "unknown offramp order status"
}A missing X-Api-Key header, or a parameter in the wrong format (for example, a non-numeric limit or a malformed date), also returns 400, with the reason in a message field.
{
"error": "ERR_UNAUTHORIZED",
"success": false
}Updated about 15 hours ago

