Create and track withdrawals

Create a quote before each withdrawal. The quote validates limits and recipient fields without reserving balance.

POSThttps://lirpay.org/api/v2/integration/withdrawal-quotes

Calculate fees, debit amount, recipient amount, and review requirements.

API key requiredwithdrawals:readIdempotency-Key required

Parameter	Type	In	Required	Description
Idempotency-Key	string	header	yes	Unique key for this monetary operation. Maximum 255 characters.
method_id	string	body	yes	Stable method identifier from GET /withdrawal-methods.
amount_minor	integer	body	yes	Positive requested amount in minor units.
network_fee_mode	string	body	no	deduct by default, or add.
receiver_address	string	body	yes	Address or provider recipient identifier.
provider_fields	object	body	no	Fields required by the selected method schema.

Request

{
  "method_id": "tron:USDT",
  "amount_minor": 25000,
  "network_fee_mode": "deduct",
  "receiver_address": "TQn6LN6gkVJy4Hc3v1jK8RkXWkY2kDgH2m"
}

Response

{
  "quote": {
    "id": "20ad5f37-5076-4ae8-bb3d-d9a198fd092d",
    "amount_minor": 25000,
    "amount": "250.00",
    "debit_amount_minor": 25000,
    "net_amount_minor": 24700,
    "network_fee_minor": 300,
    "network_fee_mode": "deduct",
    "decimals": 2,
    "expires_at": "2026-07-27T18:05:00Z"
  }
}

POSThttps://lirpay.org/api/v2/integration/withdrawals

Create a withdrawal from an unexpired quote.

API key requiredwithdrawals:writeIdempotency-Key required

Parameter	Type	In	Required	Description
Idempotency-Key	string	header	yes	Unique key for this monetary operation. Maximum 255 characters.
quote_id	uuid	body	yes	Quote from POST /withdrawal-quotes.
external_id	string	body	no	Unique merchant-side payout reference.

{
  "quote_id": "20ad5f37-5076-4ae8-bb3d-d9a198fd092d",
  "external_id": "payout_2026_000184"
}

GEThttps://lirpay.org/api/v2/integration/withdrawals

List withdrawals with public statuses and provider references.

API key requiredwithdrawals:read

Parameter	Type	In	Required	Description
status	string	query	no	Filter by a normalized public status.
currency	string	query	no	Filter by balance currency.
method_id	string	query	no	Filter by stable withdrawal method.
created_from	RFC3339	query	no	Include records created at or after this timestamp.
created_to	RFC3339	query	no	Include records created at or before this timestamp.
page	integer	query	no	Page number. Defaults to 1.
limit	integer	query	no	Items per page. Maximum 100.

GEThttps://lirpay.org/api/v2/integration/withdrawals/{id}

Read fees, recipient, provider state, and transaction identifiers.

API key requiredwithdrawals:read

Parameter	Type	In	Required	Description
id	uuid	path	yes	Resource identifier returned by a list or create operation.

Public statuses are pending, requires_review, processing, completed, failed, cancelled, and rejected. Live withdrawals always start as requires_review until an admin approves them.

POSThttps://lirpay.org/api/v2/integration/withdrawals/{id}/cancel

Cancel an eligible withdrawal and return its debit to available balance.

API key requiredwithdrawals:writeIdempotency-Key required

Parameter	Type	In	Required	Description
id	uuid	path	yes	Resource identifier returned by a list or create operation.
Idempotency-Key	string	header	yes	Unique key for this monetary operation. Maximum 255 characters.

Only pending and requires_review withdrawals can be cancelled.