get
https://api.somossimpay.com.br/v2/finance/status-pix-copy-and-paste/?id=
Params (Query Params)
| Parameter | Value | Description | Example |
|---|---|---|---|
| id | Number | Fill in with the qr_code_id, the unique identifier generated in the response of the endpoint: Generate a PIX Cash In (Copy and Paste or QR Code Scanning). | EX: 113562 |
Headers
| Parameter | Type | Description | Example |
|---|---|---|---|
| Authorization | String | Bearer + Access_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo |
Response Details
{
"worked": true,
"pix_copy_and_paste": "00020101021226880014br.gov.bcb.pix2566qrcodes.saq.digital/v2/qr/cob/*********************************SAQ INSTITUICAO DE PAGAME6009SAO PAULO62070503***6304E10C",
"qr_code_id": 1,
"debtor_name": "Fulano de tal",
"debtor_document": "144******47",
"type_document": "CPF",
"debtor_institution": "BANCO S.A.",
"debtor_institution_number": "000001",
"expiration_date": "2024-01-01T12:00:00.000Z",
"due_date": null,
"amount_chargeback": 0.0,
"amount": 0.01,
"fee": 0.0,
"type_fine": "NONE",
"fine": null,
"fine_date": null,
"status": "PAID",
"base_64_image": null,
"base_64_image_url": "https://api.saq.digital/v2/finance/image/qrcode/316fe7d2b****77d8127cf08ca7.png",
"account_number": "900002",
"agency_number": "0001",
"endToEndId": "E303062942025090000000000003AAFM",
"payment_date": "2025-09-17T15:46:54.124Z",
"tax": 0.0,
"tx_id": "316fe7d2b****77d8127cf08ca7",
"tag": null
}
| Field | Description |
|---|---|
| worked | Returns true or false confirming whether the Generate a PIX Cash In (Copy and Paste Or QR Code) was successful or not. |
| pix_copy_and_paste | This field returns the generated copy and paste code that the customer can pay directly through their bank |
| qr_code_id | Unique payment identifier generated. This value never repeats, and it enables querying endpoints to confirm the payment status, refunds, etc. |
| debtor_name | Returns the Payer's name (the same information that was sent in the body) |
| debtor_document | Returns the Payer's document (the same information that was sent in the body) |
| debtor_institution | Returns the payer's debtor institution |
| debtor_institution_number | Returns the debtor institution number (ISPB) |
| type_document | Returns the Payer's type document (the same information that was sent in the body) |
| expiration_date | Returns the expiration date (the same information that was sent in the body) |
| due_date | Returns the due date (the same information that was sent in the body) |
| amount_chargeback | If a refund occurs, this field will be filled with the refunded amount. |
| amount | Returns the amount (the same information that was sent in the body) |
| fee | Returns the fee amount charged for the transaction (Deprecated) |
| fine_date | Returns the type_fine if applicable |
| status | NEW - Payment generated, awaiting payment by the customer PAID - Payment successfully completed CANCELED - Payment canceled / expired |
| base_64_image | This field returns the generated QRCode image in base64 format |
| base_64_image_url | This field returns the link with the generated QRCode image. The customer can scan it and pay directly through their bank. |
| account_number | Returns the account Number (the same information that was sent in the body) |
| agency_number | Returns the agency Number (the same information that was sent in the body) |
| endToEndId | Returns the Endtoend ID (the same information that was sent in the body) |
| payment_date | Returns the date and time at which the payment was completed |
| tx_id | Returns the conciliation ID QR Code |
| tax | Returns the fee amount charged for the transaction |
| tag | Returns the tag if applicable (the same information that was sent in the body) |