Create Order

Withdrawal orders extract a fiat amount from your settlement account to a registered Outgoing Fiat Instruction.

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

A withdrawal order debits a fiat amount from your settlement account and transfers it to a registered Outgoing Fiat Instruction.

⚠️

Currency Must Match the Settlement Account

The withdrawal currency MUST be the same as your settlement account currency. Requesting a withdrawal in a different currency is rejected.

Withdrawal Destination

The only accepted destination is an Outgoing Fiat Instruction — a bank account you registered beforehand. Set withdrawal.type to outgoing_instruction and reference the instruction by its id in withdrawal.outgoing_instruction.instruction_id. Sending to an arbitrary bank account that was not whitelisted first is not possible.

FieldTypeRequiredDescription
currencystringYesMust match your settlement account currency.
amountstringYesAmount to debit from the settlement account.
typestringYesDestination type. Only outgoing_instruction is accepted.
outgoing_instruction.instruction_idstringYesID of a previously created Outgoing Fiat Instruction to transfer to.

Register the destination first with Create Outgoing Fiat Instruction, then pass the returned id here.

{
  "reference_id": "withdrawal-1",
  "operation": "withdrawal",
  "withdrawal": {
    "currency": "MXN",
    "amount": "1234.56",
    "type": "outgoing_instruction",
    "outgoing_instruction": {
      "instruction_id": "39c98c5ae53941449539074a2645dd85"
    }
  }
}

Response Amounts

The withdrawal object in the response breaks the requested amount down into what reaches the destination and what Lirium charged:

FieldTypeDescription
amountstringTotal debited from your settlement account — the amount you requested.
destination_amountstringAmount credited to the destination, i.e. amount minus fee_amount.
fee_amountstringFee charged for the withdrawal. "0" when no fee applies.
{
  "id": "b9e7324868524208baf2513570fc96cf",
  "state": "completed",
  "reference_id": "withdrawal-1",
  "operation": "withdrawal",
  "created_at": "2026-06-22T20:43:54.488922+00:00",
  "processed_at": "2026-06-22T20:43:54.488922+00:00",
  "last_updated_at": "2026-06-22T20:44:30.642796+00:00",
  "settlement": {
    "currency": "MXN",
    "amount": "1234.56",
    "operation": "debit"
  },
  "withdrawal": {
    "currency": "MXN",
    "amount": "1234.56",
    "destination_amount": "1224.56",
    "fee_amount": "10",
    "type": "outgoing_instruction",
    "outgoing_instruction": {
      "instruction_id": "39c98c5ae53941449539074a2645dd85"
    }
  }
}

An order created in a state that awaits confirmation must be confirmed with Confirm Order before it is processed.

Body Params
string

Your reference id, must be unique

string

Requested operation, right now only "withdrawal" is supported

withdrawal
object
Responses

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