Skip to main content
An order is one action you take in PeerPesa, such as swapping cUSD to USDT or sending crypto to a wallet. Each order records what you sent, what the recipient received, the fees and exchange rate, and its status. It also lists the individual transactions that carried it out: a swap, for example, has one transaction debiting your wallet and one crediting the recipient, each with its own tx_hash.

GET /orders

Returns your orders, newest first. Supports all pagination and filter parameters plus order-specific filters.

Pagination

integer
default:"1"
Page number to return, starting at 1.
integer
default:"20"
Orders per page. Maximum is 100.
integer
default:"20"
Alias for size. If you send both, size is used.

Search and dates

Matches order_id, sender_address, recipient_address, account_number, asset symbols, and the tx_hash of any transaction in the order. Minimum 2 characters.
string
Only include orders created on or after this date (YYYY-MM-DD or ISO 8601).
string
Only include orders created on or before this date (YYYY-MM-DD or ISO 8601).

Filters

string
Filter by order type, for example swap, send, buy, withdraw, or deposit. Comma-separate to match several.
string
Filter by order status, for example successful. Comma-separate to match several.
string
Only include orders where from_asset or to_asset matches, for example cUSD or USDT.
string
Only include orders on this network code, for example cusd.
string
Only include fiat orders in this currency, for example KES.
string
Only include orders created by this recurring payment.
number
Only include orders with amount greater than or equal to this value.
number
Only include orders with amount less than or equal to this value.

Sorting

string
default:"created_at"
created_at, updated_at, or amount.
string
default:"desc"
desc or asc.
Response
Each item in data is a full order object, including its transactions array. See Order Details for the complete object, every field, and how to fetch a single order by order_id.

Errors

See Error Codes for the full list.

Order Details

Fetch one order and its transaction legs.

Pagination & Filters

Shared paging, search, and date parameters.