SocredDocs

    Check Chargeback Status by Cash In Transaction

    Checks the current status of a PIX cash in chargeback previously requested, using the identifier returned when the refund was created.

    GEThttps://api.socredsa.com.br/v2/finance/chargeback/status
    curl --request GET \
  --url 'https://api.socredsa.com.br/v2/finance/chargeback/status' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>'
    Response200
    {
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "end_to_end_id": "E12345678202604251234567890AB12345",
  "amount": 100.5,
  "status": "SUCCESS"
}

    Endpoint

    GET /v2/finance/chargeback/status

    Headers

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

    Query Parameters

    ParameterTypeDescriptionRequired or Optional
    idStringIdentifier of the chargeback request (UUID). This is the id returned when the refund was requested.required

    Request Examples

    Check a chargeback status:

    GET /v2/finance/chargeback/status?id=550e8400-e29b-41d4-a716-446655440000
Authorization: Bearer <access_token>

    Response Details

    {
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "end_to_end_id": "E12345678202604251234567890AB12345",
  "amount": 100.50,
  "status": "SUCCESS"
}
    FieldTypeDescription
    idStringUnique identifier of the chargeback request (UUID). Matches the value sent in the id query parameter.
    end_to_end_idStringEndToEndId of the refund operation. Returned as an empty string while the refund has not been assigned one yet.
    amountFloatAmount of the refund.
    statusStringCurrent status of the chargeback request. See the Chargeback Status table below.

    Chargeback Status

    StatusDescription
    PENDINGThe refund is still being settled. Refunds to payers in the same institution never appear as PENDING - they are settled immediately.
    SUCCESSThe refund was completed and the funds were returned to the payer.
    REJECTEDThe refund could not be completed.

    Error Responses

    HTTP CodeError MessageDescription
    400Chargeback not foundNo chargeback was found for the informed id, or it is not available for the account you can access.
    400query.id: Field requiredThe id query parameter was not sent. Validation failures are returned as 400, and data carries the details.
    401Not authenticatedMissing, malformed or expired Bearer token.

    All errors are returned in the standard error envelope:

    {
  "worked": false,
  "detail": "Chargeback not found",
  "message": "Chargeback not found",
  "data": null
}

    Business Rules

    Validations:

    • The id query parameter is required and must be the identifier returned when the chargeback was requested
    • An id that is well formed but unknown is answered with Chargeback not found, not with a validation error
    • Chargebacks requested for cash ins received through a PIX QR Code and cash ins received without a QR Code are both queried through this same endpoint

    Important Notes:

    • A chargeback stays in PENDING until the refund is settled; poll this endpoint or rely on webhooks to detect the final status
    • end_to_end_id is filled in once the refund is assigned one, so it may be empty on a PENDING chargeback