Static QRCODE

Request Body:

property	type	required	description
amount	`integer`	yes	Valor para recebimento do PIX em centavos.
type	`string`	yes	Tipo do PIX: "dynamic" ou "static".
external_id	`string`	no	TXID de referência. Utilizado para idenficação do PIX na sua plataforma. Esse campo deve conter no máximo 25 caracretes
expiration_date	`datetime`	no	Data de expiração do PIX.

Observações:
1. Quando o expiration_date for menor que o tempo atual, será considerado PIX com tempo de expiração padrão do banco.

Response Body:

	type	description
pix_id	`integer`	Id do PIX.
type	`string`	Tipo do PIX: "dynamic" ou "static".
paid	`bool`	Flag para identificar o pagamento do PIX.
base64	`string`	Imagem em BASE64 do QRCode PIX.
qrcode	`string`	QRCode PIX. Também conhecido como PIX Copia e Cola.
amount	`integer`	Valor em centavos;
expiration_date	`datetime`	Data de expiração do PIX.
created_at	`datetime`	Data de criação do PIX.

Habilitando retorno da imagem PIX
O Campo base64 funciona para facilitar o retorno do PIX, já retornando da API com a imagem para recebimento. Para habilitar essa funcionalidade deve enviar na QueryString o parâmetro withImage com o valor true.
Assim o response vai conter o campo base64, caso contrário esse campo será nulo.

curl --location '/v2/pix/qrcode?withImage=false' \ --header 'Content-Type: application/json' \ --data '{ "amount": 92, "type": "static", "external_id": "15f5170b-a64e-47a3-8727-6608305728b3", "expiration_date": "2024-08-17 19:48:44", "key": "297fbcd9-cfb2-4b15-a138-35b88f8f9a4b" }'

{ "pix_id": "1112229912249ce869381ede361b7af", "type": null, "paid": false, "base64": null, "qrcode": "string", "amount": 5049, "expiration_date": "2022-01-12T14:50:35.0682132-03:00", "created_at": "2022-01-12T14:50:35.2221029-03:00" }

Requisição

Respostas