Meio de Pagamento: Pix

Create a QRCode

This endpoint creates a new qrcode with the provided data.

POSTv1/pix

Body

application/json

QRCode data

amount*number

description*string

expiration*integer

metadataarray of models.QRCodeMetadata (object)

payer*models.QRCodePayer (object)

Response

201400401500

Created

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('v1/pix', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 0,
      "description": "text",
      "payer": {
        "document": "text",
        "name": "text"
      }
    }),
});
const data = await response.json();

Response

201400401500

text

Get a QRCode

This endpoint return a qrcode.

GETv1/pix/{qrcodeid}

Body

application/json

QRCode data

amount*number

description*string

expiration*integer

metadataarray of models.QRCodeMetadata (object)

payer*models.QRCodePayer (object)

Response

200400401404500

OK

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('v1/pix/{qrcodeid}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 0,
      "description": "text",
      "payer": {
        "document": "text",
        "name": "text"
      }
    }),
});
const data = await response.json();

Response

200400401404500

text

Cancel a QRCode

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

DELETEv1/pix/{qrcodeid}

Response

204400401500

No Content

Request

JavaScriptCurlPython

const response = await fetch('v1/pix/{qrcodeid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401500

{
  "error": "text",
  "errors": [
    "text"
  ]
}

Refund a QRCode

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

DELETEv1/pix/{qrcodeid}/refund

Body

application/json

Refund data

amount*number

description*string

reason*integer

Response

204400401500

No Content

Request

JavaScriptCurlPython

const response = await fetch('v1/pix/{qrcodeid}/refund', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 0,
      "description": "text"
    }),
});
const data = await response.json();

Response

400401500

{
  "error": "text",
  "errors": [
    "text"
  ]
}