Jump to Content

Check Status and Details of a Generated PIX Cash In by ID or EndToEnd

get

https://api.somossimpay.com.br/v2/finance/status-pix-copy-and-paste

This API retrieves the status and comprehensive details of a previously generated PIX QR Code. Query by QR Code ID or EndToEndId. Returns payment status, amounts, debtor information, dates, and associated account details.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Parameters

Parameter	Type	Description	Required
id	Integer	QR Code ID. Either `id` or `e2e_id` must be provided, but not both.	Optional
e2e_id	String	EndToEndId (loc_id) of the QR Code. Either `id` or `e2e_id` must be provided, but not both.	Optional

Authentication

Header	Type	Description	Required
Authorization	String	Bearer token for authentication	Yes
hmac	String	HMAC signature for request authentication	Yes

Request Examples

Query by ID:

GET /v2/finance/status-pix-copy-and-paste?id=12345
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b...

Query by EndToEndId:

GET /v2/finance/status-pix-copy-and-paste?e2e_id=E12345678202604251234567890AB12345
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b...

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": "12345678900",
  "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"
}

Response Fields

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 (if 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 (if applicable)
end_to_end_id	String	EndToEndId of the transaction

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 - Invalid parameters or QR Code not found
401	Unauthorized - Invalid or missing authentication
500	Internal server error

Notes

Either id or e2e_id parameter must be provided, but not both
If both parameters are provided, a 400 error will be returned
If neither parameter is provided, a 400 error will be returned
Only QR Codes from your company can be queried
Access is validated based on user permissions for the associated account

Responses

400

Bad request - Invalid parameters or QR Code not found

401

Unauthorized - Invalid or missing authentication

500

Internal server error

Language

Loading…

Response

Choose an example:

application/json