Consult PIX QR Code Chargeback Status

This API allows you to consult the status of a previously created chargeback. The query can be made using either the numeric ID or the End-to-End ID (UUID) of the chargeback.

Headers

Parameter	Type	Description	Example
Authorization	String	Bearer + Access_token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo
hmac	String	HMAC (Hash-based Message Authentication Code) is an authentication algorithm that combines a private key with a message to create a Message Authentication Code (MAC).	hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6

Query Parameters

Important: You must provide exactly one of the parameters below (not both, not neither).

Parameter	Type	Description	Required or Optional	Example
id	Integer	Chargeback ID returned when creating the chargeback. Use this for internal system queries.	Optional	67890
end_to_end_id	String	UUID of the chargeback (end_to_end_id) returned when creating. Use this for reconciliation and tracking.	Optional	E123456789abcdef

Response Details

{
  "worked": true,
  "id": 67890,
  "end_to_end_id": "E123456789abcdef",
  "amount": 100.50,
  "status": "SUCCESS",
  "fee": 0.00
}

{
  "worked": true,
  "id": 67890,
  "end_to_end_id": "E123456789abcdef",
  "amount": 100.50,
  "status": "PENDING",
  "fee": 0.00
}

{
  "worked": true,
  "id": 67890,
  "end_to_end_id": "E123456789abcdef",
  "amount": 100.50,
  "status": "REJECTED",
  "fee": 0.00
}

Field	Description
worked	Returns true or false confirming whether the query was successfully submitted or not.
id	Unique chargeback identifier. This value never repeats.
end_to_end_id	UUID (Universally Unique Identifier) of the chargeback. Can be used for external reconciliation and tracking.
amount	Chargeback amount value
status	PENDING - Chargeback is being processed. Query again after a few minutes. SUCCESS - Chargeback successfully completed. The refund has been processed and the amount returned to the payer. REJECTED - Chargeback was rejected. The refund could not be completed. Contact support for details.
fee	Fee amount charged for the chargeback transaction

Error Responses

HTTP Code	Error Message	Description
400	Either 'id' or 'end_to_end_id' parameter is required	No parameter was provided. You must send either the id or end_to_end_id query parameter.
400	Only one parameter should be provided: 'id' or 'end_to_end_id'	Both parameters were provided simultaneously. Send only one parameter (id OR end_to_end_id).
400	Chargeback not found	The chargeback was not found or does not belong to your company. Verify the ID/UUID and ensure you are using the correct authentication token.

Business Rules

Authorization:

The chargeback must belong to the company of the authenticated token
Only the company that created the chargeback can query its status

Query Identifiers:

Use id for internal system queries and database lookups
Use end_to_end_id for reconciliation, external tracking, and customer-facing references
Both identifiers are unique and valid for querying

Polling Recommendations:

For chargebacks with PENDING status, wait at least 30 seconds between queries
External chargebacks typically complete within 5-10 minutes
If a chargeback remains PENDING for more than 30 minutes, contact support
Consider implementing webhooks for real-time status notifications instead of constant polling