Creates a withdrawal: you fund a blockchain address that this endpoint returns, and we pay the amount out to a Pix key with the fees already deducted.

How to use this API correctly

Use EXACTLY ONE of the following amount parameters:

Only depositAmountInCents if you want to specify the amount you want to send in DePix.

OR only payoutAmountInCents if you want to specify the amount you want to receive in Pix (Reais).

By sending one of the two parameters, the other will be automatically calculated according to our fees and will be returned in the response.

It is not possible to use both amount parameters in the same request, and you cannot leave both empty.

Both amount parameters are bounded per withdrawal: from R$ 2,00 to 6.000,00.

The bound is checked on whichever of the two you send, and it is per operation, never a daily total. Outside it the request is rejected with 'depositAmountInCents' must be between the allowed min (200) and max (600000) withdrawal amounts, or with the same message naming 'payoutAmountInCents'.

Withdrawals are also capped per day for each recipient tax number. When a withdrawal is refused for it, the message states the day's volume and the cap in cents:

Daily withdrawal limit exceeded for pix key '<pixKey>'. Daily volume in cents: <volume>. Withdrawal limit in cents: <limit>.

A withdrawal fee of at least R$ 1,00 always applies. On small withdrawals the percentage rate is not what you pay: whichever is larger between the rate and that floor is deducted. The rate in force on your account is answered by /help on Telegram.

All withdrawal requests must include the beneficiary identification.

You must send at least one of the following identification parameters:

taxNumber: the CPF or CNPJ of the Pix key owner.

euid: the Eulen User Identification.

The request will be rejected if neither taxNumber nor euid is provided.

If both taxNumber and euid are provided, the informed taxNumber must match the corresponding euid. If they do not match, the request will be rejected.

The Pix key must belong to the informed taxNumber.

If the Pix key ownership does not match the provided identification, the withdrawal may be automatically rejected by the banking system.

The DePix you send must match what the withdrawal expects, within 5%.

Within 5%, in either direction, the withdrawal still goes through and the payout is recalculated from the amount that actually arrived. What is paid in Pix is then no longer the payoutAmountInCents returned when the withdrawal was created; read GET /api/withdraw-status for the amount actually paid.

Above 5%, the deposit is ignored and the withdrawal is left untouched. You are notified on Telegram, and the notification names the withdrawal id and the transaction id.

A recalculated payout is checked again against the R$ 2,00 to 6.000,00 range. Falling outside it also ignores the deposit, which is why a deposit slightly under the expected amount can be dropped: after fees there is less than the minimum left.

An ignored deposit is returned to refundAddress automatically when one was declared, in full and with no fee withheld.

Send refundAddress if you want the DePix back when a payout cannot be completed.

refundAddress is an optional Liquid address, and it is where your DePix is returned if this withdrawal cannot go through.

It has to be declared here, on the request, because it cannot be recovered afterwards. Liquid is a confidential chain and does not reveal who sent a transaction, so there is no way for us to work out where the DePix came from. A withdrawal created without refundAddress can still be refunded, but only after our team reaches you to ask for an address, and the funds stay put until that happens.

Any Liquid address you control works, including the one you send the DePix from.

Maximum 128 characters, no spaces. The address is checked when the request is made; an invalid one is rejected with invalid 'refundAddress' param, and a non-string value with 'refundAddress' should be a string.

The recorded value comes back on GET /api/withdraw-status, so you can confirm what was stored.

What returns is DePix on the Liquid Network. It is never Reais, and it never reaches the beneficiary's Pix key. The withdrawal then reports the refunded status, listed on Possible Statuses.

A 1 DePix fee is withheld when the payout could not be completed because of the request itself: the Pix key does not belong to the informed taxNumber, or the Pix key is invalid or was rejected at payout. It is also withheld when the recipient was past the daily withdrawal limit. The fee is reported in refund.feeInCents on GET /api/withdraw-status, next to the amount returned in refund.netAmountInCents: what arrives at refundAddress is the DePix that actually arrived for this withdrawal, minus it.

No fee is withheld when the failure was not on the request: our side or the banking processor broke, or the DePix that arrived did not match what the withdrawal expected. Those return in full.

Do not send the DePix after the withdrawal has expired.

DePix that arrives late is not paid out. What happens to it depends on refundAddress: with one declared on the request, the DePix can be returned there; without one, the funds stay put until our team reaches you to ask where to send them.

application/json

Headers

Bodyapplication/json

Example

{
    "response": {
        "withdrawalId": "019b76daa800700000000000000000a1",
        "depositAddress": "lq1qqtkuz7nwp3cymteg0px5pcltrm26uvsak32t04fawfsacafutjg22fhvc8xhj0ue96cevuatnmt757rf4z2r5cwntsemgngcr",
        "depositAmountInCents": 124647,
        "payoutAmountInCents": 123400
    },
    "async": false
}

Withdraw

How to use this API correctly

Request

Request Code Samples

Responses

Withdraw

How to use this API correctly#

Request

Request Code Samples

Responses

How to use this API correctly