Deposit (PIX ➔ DePix) - Pix2DePix API

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.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Header Params

X-Nonce

string <uuid>

optional

A random uuid string to identify an CLIENT INTENTION as unique. In case of retrying the same request, always use the same nonce. For new operations, use a new one. By default, if this param is empty, a new nonce would be generated.

X-Async

string

write-onlyoptional

Can be true, false or auto. If not auto forces API async or sync behavior.

Default:

auto

Body Params application/json

DepositRequest

amountInCents

integer

Amount in cents

write-onlyrequired

Integer value in cents of reais. For R$ 1,00 for example: the number passed must be 100.

>= 1<= 10000000

depixAddress

string

write-onlyoptional

Optional DePix Address

endUserFullName

string

write-onlyoptional

End user full name

endUserTaxNumber

string

write-onlyoptional

End user tax number

Example

{
    "amountInCents": 100,
    "depixAddress": "ex1qhuq5u7udzwskhaz45fy80kdaxjytqd99ju5yfn",
    "endUserFullName": "Jasmine Lubowitz",
    "endUserTaxNumber": "22078522238"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Headers

X-Request-ID

string

required

UUID for each request

Example:

8ddc3426-1425-4d80-b588-a05371119da0

X-Nonce

string

required

The same nonce sent by user

Example:

3e5f32c10786

Body

response

DepositObjOrError

required

Custom object response

One of

DepositObj

ErrorObj

DepositObj

qrImageUrl

string

read-onlyrequired

URL for a PNG image representing the QR Code.

qrCopyPaste

string

read-onlyrequired

Text for the feature to copy/paste the QR Code.

string

required

The entry ID to be used on deposit-status API

async

enum<boolean>

read-onlyrequired

Always false in sync responses

Allowed value:

false

Default:

false

Examples

SuccessException

{
    "response": {
        "qrCopyPaste": "0002XPTO1226880014br.gov.bcb.pix2566qrcode-h.fitbank.com.br/QR/cob/44CFA7690F47CXPTO2BR5925PLEBANK SOLUCOES EM TECNO6007BAXPTO00062070503***6304345A",
        "qrImageUrl": "https://response.eulen.app/api-response/nonce-qr.png",
        "id": "ac34bd0a6f1d426fba001dca27b9d137"
    },
    "async": false
}

🟠400Bad request

🟠401Unauthorized

🟢202OK Accepted

🟠403Forbidden

🔴500Server Error

🔴503Service Unavailable