get
https://api.cartwavehub.com.br/v2/finance/chargebacks-pix-copy-and-paste/status
This API allows you to consult the status of a previously created chargeback. The query can be made using either the chargeback ID or the End-to-End ID.
Headers
| Parameter | Type | Description | Example |
|---|---|---|---|
| Authorization | String | Bearer + Access_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo |
Query Parameters
| Parameter | Type | Description | Required or Optional | Example |
|---|---|---|---|---|
| id | Integer | Chargeback ID returned when creating the chargeback. Provide either id OR end_to_end_id, not both. | optional | 98765 |
| end_to_end_id | String | End-to-End ID (UUID) of the chargeback returned when creating. Provide either id OR end_to_end_id, not both. | optional | E6070119020210521123456789012345678 |
Request Examples
Check status by chargeback ID:
GET /chargebacks-pix-copy-and-paste/status?id=98765
Authorization: Bearer <access_token>
Check status by End-to-End ID:
GET /chargebacks-pix-copy-and-paste/status?end_to_end_id=E6070119020210521123456789012345678
Authorization: Bearer <access_token>
Response Details
{
"worked": true,
"id": 98765,
"end_to_end_id": "E6070119020210521123456789012345678",
"amount": 50.00,
"status": "PENDING",
"fee": 0.00
}
| Field | Type | Description |
|---|---|---|
| worked | Boolean | Always true for successful requests. |
| id | Integer | Unique chargeback identifier. |
| end_to_end_id | String | End-to-End ID of the refund transaction. Can be used for external reconciliation and tracking. May be empty for pending chargebacks. |
| amount | Decimal | Chargeback amount value. |
| status | String | 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. |
| fee | Decimal | Transaction fee. Usually 0.00 for chargebacks. |
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 account. Verify the ID/UUID and ensure you are using the correct authentication token. |
| 401 | Unauthorized | Invalid or missing authentication token. Ensure you are sending a valid Bearer token. |
| 422 | Validation error | Query parameter validation failed. Ensure the parameters are in the correct format. |
Business Rules
Authentication:
- Requires valid authentication token
- User must be authenticated
Parameter Requirements:
- Exactly one parameter must be provided: either
idORend_to_end_id - Cannot provide both parameters
- Cannot omit both parameters
Query Identifiers:
- Use
idfor queries using the chargeback ID returned when creating the chargeback - Use
end_to_end_idfor queries using the End-to-End ID (UUID) for reconciliation and tracking - Both identifiers are unique and valid for querying
Authorization:
- The chargeback must belong to your account
- Only the account that created the chargeback can query its status
Polling Recommendations:
- For chargebacks with
PENDINGstatus, wait at least 30 seconds between queries - External chargebacks typically complete within 5-10 minutes
- If a chargeback remains
PENDINGfor more than 30 minutes, contact support - Consider implementing webhooks for real-time status notifications instead of constant polling