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

Params (Query Params)

ParameterValueDescriptionExample
tagNumberFill in the tag ID, a custom identifier generated by the client. This is a custom field that the client can use to input values or their own identifiers for internal control.EX: w000196980001

Headers

ParameterTypeDescriptionExample
AuthorizationStringBearer + Access_tokenBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo

Response Details

{
    "worked": true,
    "pix_copy_and_paste": "000201************eba9bc35204000053039865802BR5925SAQ***********6304B150",
    "qr_code_id": 2168101,
    "debtor_name": "Lu***********ha",
    "debtor_document": "348********",
    "type_document": "C**",
    "debtor_institution": "MERCADOP*******************LTDA.",
    "debtor_institution_number": "105*****",
    "expiration_date": "2025-07-03T13:20:59.892Z",
    "due_date": null,
    "amount_chargeback": 0.0,
    "amount": 0.01,
    "fee": 0.0,
    "type_fine": "N***",
    "fine": null,
    "fine_date": null,
    "status": "P***",
    "base_64_image": "iVBORw0K******************ORK5CYII=",
    "base_64_image_url": "https://api.saq.digital/v2/finance/image/qrcode/cdd*********bc3.png",
    "account_number": "900***",
    "agency_number": "00**",
    "endToEndId": "E1057352********************9s6",
    "payment_date": "2025-06-19T13:21:15.509Z",
    "tax": 0.0,
    "tag": "364********"
}
FieldDescription
workedReturns true or false confirming whether the query was successfully submitted or not.
pix_copy_and_pasteThis field returns the generated copy and paste code that the customer can pay directly through their bank
qr_code_idUnique payment identifier generated. This value never repeats, and it enables querying endpoints to confirm the payment status, refunds, etc.
debtor_nameReturns the Payer's name (the same information that was sent in the body)
debtor_documentReturns the Payer's document (the same information that was sent in the body)
type_documentReturns the Payer's type document (the same information that was sent in the body)
expiration_dateReturns the expiration date if applicable (same as provided in the request body)
debtor_institutionReturns the payer's debtor institution
debtor_institution_numberReturns the debtor institution number (ISPB)
due_dateReturns the due date (the same information that was sent in the body)
amount_chargebackIf a refund occurs, this field will be filled with the refunded amount.
amountReturns the amount (the same information that was sent in the body)
feeThis field returns the fee charged to the SaQ.Digital customer when using the Generate PIX Cash In (Copy and Paste or QR Code Scanning) endpoint.
type_fineReturns the type_fine if applicable
fineReturns the fine if applicable
fine_dateReturns the fine_date if applicable
statusNEW - Payment generated, awaiting payment by the customer
PAID - Payment successfully completed
CANCELED - Payment canceled / expired
base_64_imageThis field returns the generated QRCode image in base64 format
base_64_image_urlThis field returns the link with the generated QRCode image. The customer can scan it and pay directly through their bank.
account_numberReturns the account Number (the same information that was sent in the body)
agency_numberReturns the agency Number (the same information that was sent in the body)
endToEndIdReturns the Endtoend ID (the same information that was sent in the body)
payment_dateReturns the date and time at which the payment was completed
taxReturns the fee amount charged for the transaction
tagReturns the tag if applicable (the same information that was sent in the body)
Language
Click Try It! to start a request and see the response here!