Deposit (PIX ➔ DePix)

⚠️ Arkade and Spark are in beta. Paying out on the Arkade network (an ark1… address in depixAddress) or on the Spark network (a spark1… address) is live in this endpoint, but still a beta: please do not use them in production yet, and do not test them with substantial amounts. We will announce on the Changelog when they are ready for production use.

The system generates a dynamic QR code designed for deposits in Reais (BRL) through the PIX banking system. The QR code is provided in two formats: text format, which allows for easy copy-and-paste into banking applications, and PNG format, displaying a scannable QR code image for convenience.

When a deposit is successfully made using the generated QR code, our system automatically processes the transaction, converting the deposited amount into DePix. The converted DePix can then be sent to a default partner address or to a custom address specified as a parameter during the QR code generation.

The payout address, whether the one sent in depixAddress or your configured default, can be a Liquid address (lq1…, ex1…), an Arkade address (ark1…) or a Spark address (spark1…). The network the DePix is paid out on is read from the address itself; no parameter names a network. An address on none of the three is refused at QR creation with messageCode DEPOSIT_ADDRESS_NETWORK_UNKNOWN. When the wallet of that network is unavailable at that moment the QR is refused with NETWORK_WALLET_UNAVAILABLE: that one is transient, so retry later. Networks and payout addresses gathers the three networks, what each one costs and every message code.

Amounts, split, and what is actually credited

The value in amountInCents is what the payer pays in Reais. It is not what arrives in DePix.

The minimum is the fixed deposit fee charged on the network, not the minimum: 1 in the schema. Below it the request is rejected with The amount provided is below the minimum of <fee>, and the message names the fee in force. When splitFee is used, this check runs on amountInCents minus the split portion.

The ceiling that binds in practice is the payer's daily limit, not the maximum in the schema. Read maxDailyInCents and dailyVolumeInCents from GET /api/user-info with the payer's euid before sending a large amount.

When splitFee is used, the split is taken from amountInCents first, and the deposit fee is charged on what remains. depixSplitAddress receives its full portion, and the fee comes out of what goes to depixAddress.

On top of the 20% limit on splitFee itself, a further ceiling limits the split against what is left after the split and the fee. A percentage inside the accepted range can still be refused on a small deposit, with

The split portion exceeds the maximum allowed for this amount. Increase the deposit amount or reduce the split percentage.

Raising amountInCents or lowering splitFee clears it.

No field reports the fee or the net. valueInCents, on GET /api/deposit-status and on the deposit webhook, is always the gross Reais paid. The DePix credited to depixAddress is amountInCents minus the split portion minus the deposit fee charged on that remainder.

application/json

Headers

Bodyapplication/json

Example

{
    "response": {
        "qrCopyPaste": "00020101021226790014br.gov.bcb.pix2557qr.exemplo.com.br/pix/v2/019b76daa8007000000000000000000d5204000053039865802BR5925EXEMPLO SOLUCOES EM TECNO6009SAO PAULO62070503***630456C6",
        "qrImageUrl": "https://resources.eulen.app/qr/pix/019b76daa8007000000000000000000d",
        "id": "019b76daa8007000000000000000000d",
        "delayInHours": 24
    },
    "async": false
}

Amounts, split, and what is actually credited

Request

Request Code Samples

Responses

Deposit (PIX ➔ DePix)

Amounts, split, and what is actually credited#

Request

Request Code Samples

Responses

Amounts, split, and what is actually credited