Order Details

Gets a specific partner order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns a single partner order. The operation-specific detail is nested under a key named after operation — withdrawal, top_up, swap_referral, monthly_fee, commission_conversion — while partner_commission orders carry no extra object.

Withdrawal Orders

For withdrawal orders, the withdrawal object splits the debited amount into what reached the destination and what Lirium charged:

FieldTypeDescription
currencystringWithdrawal currency, matching your settlement account.
amountstringTotal debited from your settlement account.
destination_amountstringAmount credited to the destination, i.e. amount minus fee_amount.
fee_amountstringFee charged for the withdrawal. "0" when no fee applies.
typestringDestination type. outgoing_instruction for current orders.
outgoing_instruction.instruction_idstringID of the Outgoing Fiat Instruction the funds were sent to.
📘

Legacy Destinations

Orders placed before withdrawals routed through Outgoing Fiat Instructions may instead carry a ar_cvu, ar_cbu, ar_alias or address_book_item object with a matching type. These appear on historical orders only.

Partner Commission Orders

A partner_commission order pays the partner commission collected on a single order (see Fee collection). Its reference_id is the id of that order, and there is at most one per order. settlement.amount is the amount of that order's partner commission in fees.

To find the payment for an order, call Search Partner Orders with reference_id set to the order id.

Monthly Fee Orders

For monthly_fee orders, the monthly_fee object shows how the fee was calculated:

FieldTypeDescription
base_currencystringCurrency the fee is priced in.
base_amountstringFee charged, in base_currency: the larger of customers_amount and minimum_amount. settlement.amount is this amount in your settlement currency.
date_fromstringFirst day of the billed period (YYYY-MM-DD).
date_tostringLast day of the billed period (YYYY-MM-DD).
minimum_amountstringMinimum monthly fee, in base_currency.
transacting_customersintegerCustomers that transacted in the period.
customers_amountstringFee for transacting_customers at the price_ranges prices, in base_currency.
price_rangesarrayPrice per customer by tier. Each entry has count_from (integer, the customer count the price starts at) and price (string, in base_currency).

Commission Conversion Orders

For commission_conversion orders, settlement.amount is what Lirium credits to your settlement account, and the commission_conversion object shows what was converted:

FieldTypeDescription
base_currencystringCurrency of the converted fees.
base_amountstringAmount of fees converted, in base_currency.
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json