Initiate a payment by QR Code.

This endpoint allows the request of a Pix payment order (cash-out) using data that follow the specifications of the Banco Central do Brasil and that can be expressed in a QRCode. This data is also known as 'Copy and paste', as it can be copied in text format and inserted as the creditor's identifier.

curl --location --request POST 'https://infopago.apidog.io//pix/payments/qrc' \ --header 'x-idempotency-key;' \ --header 'Content-Type: application/json' \ --data-raw '{ "qrCode": "string", "creditorDocument": "string", "priority": "HIGH", "description": "string", "paymentFlow": "INSTANT", "expiration": 600, "payment": { "currency": "BRL", "amount": 0 }, "ispbDeny": [ "string" ] }'

Requisição

Parâmetros Header

x-idempotency-key

string

requerido

Unique request identifier to support idempotency.

Parâmetros Bodyapplication/json

qrCode

string

requerido

creditorDocument

string

opcional

priority

enum<string>

opcional

When the parameter is set to 'HIGH,' it is processed instantly (bypassing the processing queue). The value 'HIGH' is only allowed when the 'creditorDocument' field is defined.

Valores permitidos:

HIGHNORM

description

string

opcional

paymentFlow

enum<string>

opcional

Default value is INSTANT.

INSTANT - Payment will happen immediately

APPROVAL_REQUIRED - Payment only will happen when the order was approved.

Valores permitidos:

INSTANTAPPROVAL_REQUIRED

Padrão:

INSTANT

expiration

integer <int64>

opcional

Maximum time (seconds) that an operation can remain in the queue waiting for processing before being cancelled.

>= 1<= 10800

Padrão:

600

payment

object

requerido

currency

enum<string>

opcional

Valores permitidos:

BRL

amount

number <double>

opcional

ispbDeny

array[string]

opcional

List of codes ISPB (Identificador de Sistema de Pagamentos Brasileiro) to which payments will not be allowed.

Examples

Respostas

🟢202Accepted

application/json

Accepted

Body

endToEndId

string

opcional

The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

eventDate

string <date-time>

opcional

number

opcional

payment

object

opcional

currency

enum<string>

opcional

Valores permitidos:

BRL

amount

number <double>

opcional

type

string

opcional

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠412412

🟠422Parameter Error

🟠429429

🔴500Server Error

🔴503Service Unavailable

🔴504Gateway Timeout