Check Status and Details of a Generated PIX Cash In by Tag

This API retrieves a list of all PIX QR Codes associated with a specific tag. Returns an array of QR Codes with their status, amounts, debtor information, dates, and account details. Useful for querying multiple QR Codes grouped by a common reference.

GEThttps://api.saq.digital/v2/finance/status-pix-copy-and-paste/tag

curl --request GET \
  --url 'https://api.saq.digital/v2/finance/status-pix-copy-and-paste/tag' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>'

Response200

[
  {
    "id": 12345,
    "amount": 100.5,
    "status": "PAID",
    "pix_copy_and_paste": "00020126580014br.gov.bcb.pix0136...",
    "qr_code_url": "https://example.com/qrcode/12345.png",
    "debtor_name": "João da Silva",
    "debtor_document": "***.316.848-**",
    "created_at": "2026-04-25T10:30:00Z",
    "paid_at": "2026-04-25T11:45:00Z",
    "expiration_date": "2026-04-30T23:59:59Z",
    "tag": "Order #12345",
    "account_branch": "0001",
    "account_number": "12345678-9",
    "tax_value": 0.5,
    "end_to_end_id": "E12345678202604251234567890AB12345"
  },
  {
    "id": 12346,
    "amount": 50,
    "status": "NEW",
    "pix_copy_and_paste": "00020126580014br.gov.bcb.pix0136...",
    "qr_code_url": "https://example.com/qrcode/12346.png",
    "debtor_name": "Maria Santos",
    "debtor_document": "***.316.848-**",
    "created_at": "2026-04-25T14:20:00Z",
    "paid_at": null,
    "expiration_date": "2026-04-30T23:59:59Z",
    "tag": "Order #12345",
    "account_branch": "0001",
    "account_number": "12345678-9",
    "tax_value": null,
    "end_to_end_id": null
  }
]

Query Parameters

Parameter	Type	Description	Required
tag	String	Tag used to group QR Codes (e.g., order number, invoice ID)	Yes

Authentication

Header	Type	Description	Required
Authorization	String	Bearer token for authentication	Yes

Request Example

GET /v2/finance/status-pix-copy-and-paste/tag?tag=Order%20%2312345
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response Example

[
  {
    "id": 12345,
    "amount": 100.50,
    "status": "PAID",
    "pix_copy_and_paste": "00020126580014br.gov.bcb.pix0136...",
    "qr_code_url": "https://example.com/qrcode/12345.png",
    "debtor_name": "João da Silva",
    "debtor_document": "***.316.848-**",
    "created_at": "2026-04-25T10:30:00Z",
    "paid_at": "2026-04-25T11:45:00Z",
    "expiration_date": "2026-04-30T23:59:59Z",
    "tag": "Order #12345",
    "account_branch": "0001",
    "account_number": "12345678-9",
    "tax_value": 0.50,
    "end_to_end_id": "E12345678202604251234567890AB12345"
  },
  {
    "id": 12346,
    "amount": 50.00,
    "status": "NEW",
    "pix_copy_and_paste": "00020126580014br.gov.bcb.pix0136...",
    "qr_code_url": "https://example.com/qrcode/12346.png",
    "debtor_name": "Maria Santos",
    "debtor_document": "***.316.848-**",
    "created_at": "2026-04-25T14:20:00Z",
    "paid_at": null,
    "expiration_date": "2026-04-30T23:59:59Z",
    "tag": "Order #12345",
    "account_branch": "0001",
    "account_number": "12345678-9",
    "tax_value": null,
    "end_to_end_id": null
  }
]

Response Fields

Each object in the array contains:

Field	Type	Description
id	Integer	QR Code unique identifier
amount	Float	Payment amount
status	String	QR Code status (NEW, PAID, EXPIRED, CHARGEBACK)
pix_copy_and_paste	String	PIX copy and paste code
qr_code_url	String	URL to QR Code image
debtor_name	String	Name of the payer
debtor_document	String	CPF/CNPJ of the payer
created_at	DateTime	QR Code creation timestamp
paid_at	DateTime	Payment timestamp (null if not paid)
expiration_date	DateTime	QR Code expiration date
tag	String	Custom tag or reference
account_branch	String	Receiving account branch/agency
account_number	String	Receiving account number
tax_value	Float	Service tax charged (null if not paid)
end_to_end_id	String	EndToEndId of the transaction (null if not paid)

Status Values

Status	Description
NEW	QR Code created and waiting for payment
PAID	Payment completed successfully
EXPIRED	QR Code expired without payment
CHARGEBACK	Payment was refunded/charged back

Error Responses

Status Code	Description
400	Bad request - No QR Codes found with this tag
401	Unauthorized - Invalid or missing authentication
500	Internal server error

Use Cases

Order Management: Query all QR Codes for a specific order
Invoice Tracking: Get all QR Codes generated for an invoice
Batch Processing: Monitor multiple QR Codes in a payment batch
Reconciliation: Match QR Codes with business transactions using custom tags

Notes

Returns only QR Codes from your company
Results are filtered based on user permissions for associated accounts
Empty array is returned if no QR Codes match the tag or user has no access
Tags are case-sensitive
Only QR Codes with matching tag are included in the response

curl --request GET \
  --url 'https://api.saq.digital/v2/finance/status-pix-copy-and-paste/tag' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>'

Response200

[
  {
    "id": 12345,
    "amount": 100.5,
    "status": "PAID",
    "pix_copy_and_paste": "00020126580014br.gov.bcb.pix0136...",
    "qr_code_url": "https://example.com/qrcode/12345.png",
    "debtor_name": "João da Silva",
    "debtor_document": "***.316.848-**",
    "created_at": "2026-04-25T10:30:00Z",
    "paid_at": "2026-04-25T11:45:00Z",
    "expiration_date": "2026-04-30T23:59:59Z",
    "tag": "Order #12345",
    "account_branch": "0001",
    "account_number": "12345678-9",
    "tax_value": 0.5,
    "end_to_end_id": "E12345678202604251234567890AB12345"
  },
  {
    "id": 12346,
    "amount": 50,
    "status": "NEW",
    "pix_copy_and_paste": "00020126580014br.gov.bcb.pix0136...",
    "qr_code_url": "https://example.com/qrcode/12346.png",
    "debtor_name": "Maria Santos",
    "debtor_document": "***.316.848-**",
    "created_at": "2026-04-25T14:20:00Z",
    "paid_at": null,
    "expiration_date": "2026-04-30T23:59:59Z",
    "tag": "Order #12345",
    "account_branch": "0001",
    "account_number": "12345678-9",
    "tax_value": null,
    "end_to_end_id": null
  }
]