List the PSP's Pix QR codes

Lists the Pix QR codes the PSP created, filtered by type and a registration window (≤90 days). Returns the static and immediate-dynamic blocks; composite / cobv / recurrence QR codes are out of this context’s scope and not projected.

GET /v1/qrcodes/list

List the PSP's Pix QR codes

cURL

curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list \
  --header 'Authorization: Bearer <token>'

200

{
  "consultedAt": "<string>",
  "dynamicQrCodes": [
    {
      "amount": 123,
      "city": "<string>",
      "documentId": "<string>",
      "format": 123,
      "key": "<string>",
      "recipientName": "<string>",
      "status": 123,
      "categoryCode": "<string>",
      "conciliationId": "<string>",
      "description": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "expirationTime": 123,
      "payloadUrl": "<string>",
      "zipCode": "<string>"
    }
  ],
  "staticQrCodes": [
    {
      "amount": 123,
      "city": "<string>",
      "format": 123,
      "key": "<string>",
      "recipientName": "<string>",
      "additionalData": "<string>",
      "bankIdFss": "<string>",
      "categoryCode": "<string>",
      "conciliationId": "<string>",
      "zipCode": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Query Parameters

qrCodeType · integer<int64>

tpQRCode filter (11=static, 12=immediate dynamic, 13=cobv, 14-17=composite).

startDateTime · string

Window start (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ).

endDateTime · string

Window end (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90d from start).

page · integer<int64>

Page number (pagina; default 1).

pageSize · integer<int64>

Page size (tamanhoPagina; default 50, max 100).

Response

200

application/json

OK

consultedAt · string · required

The upstream consult timestamp (upstream timestamp).

dynamicQrCodes · object[] | null

The immediate-dynamic QR codes (qrCodeDinamico).

Show child attributes

staticQrCodes · object[] | null

The static QR codes (qrCodeEstatico).

Show child attributes