Skip to main content
GET
When a payment made now goes out, and lands

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

source_type
string
required

As on request-payload.

Maximum string length: 40
Example:

"bank"

destination_type
string
required

As on request-payload.

Maximum string length: 40
Example:

"wallet"

delivery_speed
enum<string>
default:standard

The speed to time. Defaults to standard.

Available options:
standard,
same_day,
instant
amount

The amount you intend to move, in major units. Optional; 100.00 is assumed.

Required range: x > 0
Example:

250

currency
string
default:USD

ISO-4217 code. Defaults to USD.

Required string length: 3
destination_country
string | null

Required for bank_international; ignored otherwise.

Required string length: 2
destination_currency
string | null

Required for bank_international; ignored otherwise.

Required string length: 3

Response

Delivery windows

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.