For the complete documentation index, see llms.txt. This page is also available as Markdown.

Meio de Pagamento: Pix

Create a QRCode

post

This endpoint creates a new qrcode with the provided data.

Body
amountnumberRequired
customer_codestringOptional
descriptionstringRequired
expirationinteger · min: 60Required
notification_urlstringOptional
Responses
201

Created

application/json
stringOptional
post/v1/pix

Get a QRCode

get

This endpoint return a qrcode.

Path parameters
qrcodeIDstringRequired

QRCode ID

Responses
200

OK

application/json
stringOptional
get/v1/pix/{qrcodeID}

Refund a QRCode

delete

This endpoint requests a refund for a qrcode with the provided data.

Path parameters
qrcodeIDstringRequired

QRCode ID

Body
amountnumberRequired
descriptionstringRequired
reasonintegerRequired
Responses
204

No Content

No content

delete/v1/pix/{qrcodeID}/refund

No content

Cancel a QRCode

delete

This endpoint requests a cancellation for an active qrcode with the provided data.

Path parameters
qrcodeIDstringRequired

QRCode ID

Responses
204

No Content

No content

delete/v1/pix/{qrcodeID}

No content

Last updated