Skip to main content
GET
List Orders By Date Range

Query Parameters

start_date
string<date>
required
end_date
string<date>
required
page_id
integer
required
Required range: x >= 1
page_size
integer
required
Required range: 1 <= x <= 100

Response

200 - application/json

Orders in date range

id
string<uuid>
customer_id
string<uuid>
vendor_id
string<uuid>

Liquidity provider (publisher). API name vendor_id.

offer_id
string<uuid> | null

Liquidity listing id. API name offer_id. Nullable for custodial remittance orders.

asset
string | null
crypto_amount
string
usdt_amount
string | null

Backward-compatible alias for crypto_amount

fiat_amount
string
fiat_currency
string
wallet_address
string
status
enum<string>
Available options:
pending,
processing,
confirming,
completed,
cancelled,
failed
payment_method
string

e.g., mpesa

payment_txn_id
object

Database-style nullable string wrapper

blockchain_txn_hash
object

Database-style nullable string wrapper

expires_at
string<date-time>
completed_at
object

Database-style nullable time wrapper

created_at
string<date-time>
updated_at
string<date-time>
deleted_at
object

Database-style nullable time wrapper

merchant_request_id
object

Database-style nullable string wrapper

checkout_request_id
object

Database-style nullable string wrapper

mpesa_receipt_number
object

Database-style nullable string wrapper

payment_phone_number
object

Database-style nullable string wrapper

order_type
enum<string>
Available options:
ON_RAMP_BUY,
ON_RAMP_SELL,
OFF_RAMP_BUY,
OFF_RAMP_SELL
order_subtype
enum<string>

Distinguishes marketplace, remittance, custodial remittance, and company fiat-on-demand off-ramp flows. Legacy rows are backfilled as standard_onramp/standard_offramp. treasury_offramp has no offer_id. Vendor is the platform treasury.

Available options:
standard_onramp,
standard_offramp,
remittance_offramp,
custodial_remittance_offramp,
treasury_offramp
sender_name
object

Database-style nullable string wrapper

sender_country
object

Database-style nullable string wrapper

sender_phone
object

Database-style nullable string wrapper

beneficiary_bank_name
object

Database-style nullable string wrapper

beneficiary_bank_code
object

Database-style nullable string wrapper

beneficiary_bank_branch
object

Database-style nullable string wrapper

beneficiary_bank_address
object

Database-style nullable string wrapper

beneficiary_account_name
object

Database-style nullable string wrapper

beneficiary_account_number
object

Database-style nullable string wrapper

beneficiary_swift_code
object

Database-style nullable string wrapper

escrow_wallet_address
object

Database-style nullable string wrapper

escrow_network
object

Database-style nullable string wrapper

escrow_reference
object

Database-style nullable string wrapper

deposit_tx_hash
object

Database-style nullable string wrapper

deposit_confirmations
integer
deposit_detected_at
object

Database-style nullable time wrapper