Gets a specific partner order
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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:
| Field | Type | Description |
|---|---|---|
currency | string | Withdrawal currency, matching your settlement account. |
amount | string | Total debited from your settlement account. |
destination_amount | string | Amount credited to the destination, i.e. amount minus fee_amount. |
fee_amount | string | Fee charged for the withdrawal. "0" when no fee applies. |
type | string | Destination type. outgoing_instruction for current orders. |
outgoing_instruction.instruction_id | string | ID of the Outgoing Fiat Instruction the funds were sent to. |
Legacy DestinationsOrders placed before withdrawals routed through Outgoing Fiat Instructions may instead carry a
ar_cvu,ar_cbu,ar_aliasoraddress_book_itemobject with a matchingtype. 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:
| Field | Type | Description |
|---|---|---|
base_currency | string | Currency the fee is priced in. |
base_amount | string | Fee charged, in base_currency: the larger of customers_amount and minimum_amount. settlement.amount is this amount in your settlement currency. |
date_from | string | First day of the billed period (YYYY-MM-DD). |
date_to | string | Last day of the billed period (YYYY-MM-DD). |
minimum_amount | string | Minimum monthly fee, in base_currency. |
transacting_customers | integer | Customers that transacted in the period. |
customers_amount | string | Fee for transacting_customers at the price_ranges prices, in base_currency. |
price_ranges | array | Price 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:
| Field | Type | Description |
|---|---|---|
base_currency | string | Currency of the converted fees. |
base_amount | string | Amount of fees converted, in base_currency. |
