Skip to main content
GET
List orders for the authenticated organization

Authorizations

x-api-key
string
header
required

Query Parameters

cursor
string

Opaque cursor from a previous response. Send meta.nextCursor with direction=forward to read the next page, or meta.previousCursor with direction=backward to read the previous page.

limit
number
default:20

Maximum number of results to return (1-100)

Required range: 1 <= x <= 100
direction
enum<string>

Which side of the cursor to read: forward returns the rows after it, backward the rows before it. Rows come back in list order either way. Without a cursor, forward starts at the first row and backward at the end of the list.

Available options:
forward,
backward
status
enum<string>[]
Available options:
pending,
succeeded,
failed,
cancelled
pairId
string
type
enum<string>[]
Available options:
onramp,
offramp,
conversion,
fiat_conversion
destinationCountry
string
paymentRail
enum<string>
Available options:
rtp,
fedwire,
ach,
ach_same_day,
swift,
fednow,
sepa,
faster_payments,
chaps
createdFrom
string
createdTo
string
clientReferenceId
string

Client-supplied reference, unique per resource within your organization. 1-255 characters from A-Za-z, 0-9, underscore, hyphen, colon, and period — no spaces.

Response

data
object[]
required
meta
object
required