SimPayDocs

    Find a PIX Cash In by EndToEndId

    Retrieves the full details of a received PIX cash in using its EndToEndId, including the amount, the fee charged, how much has already been refunded and the payer's identification.

    GEThttps://api.somossimpay.com.br/v2/finance/cashin/{e2e}
    curl --request GET \
  --url 'https://api.somossimpay.com.br/v2/finance/cashin/{e2e}' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>'
    Response200
    {
  "id": 987654,
  "transaction_amount": 100.5,
  "transaction_chargeback_value": 0,
  "tax": 0.5,
  "pix_qr_code_id": 12345,
  "end_to_end_id": "E12345678202604251234567890AB12345",
  "payer_document": "***.316.848-**",
  "payer_name": "João da Silva",
  "payer_ispb": "60701190",
  "payer_agency": "0001",
  "payer_account": "654321",
  "internal_transfer": false,
  "created_at": "2026-04-25T11:45:00Z"
}

    Endpoint

    GET /v2/finance/cashin/{e2e}

    Headers

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

    Path Parameters

    ParameterTypeDescriptionExample
    e2eStringEndToEndId of the received PIX cash in you want to retrieve.E12345678202604251234567890AB12345

    Request Examples

    Retrieve a cash in by EndToEndId:

    GET /v2/finance/cashin/E12345678202604251234567890AB12345
Authorization: Bearer <access_token>

    Response Details

    {
  "id": 987654,
  "transaction_amount": 100.50,
  "transaction_chargeback_value": 0.00,
  "tax": 0.50,
  "pix_qr_code_id": 12345,
  "end_to_end_id": "E12345678202604251234567890AB12345",
  "payer_document": "***.316.848-**",
  "payer_name": "João da Silva",
  "payer_ispb": "60701190",
  "payer_agency": "0001",
  "payer_account": "654321",
  "internal_transfer": false,
  "created_at": "2026-04-25T11:45:00Z"
}
    FieldTypeDescription
    idIntegerUnique identifier of the cash in transaction. Use this value as the transaction_id when requesting a chargeback.
    transaction_amountFloatAmount received in the cash in.
    transaction_chargeback_valueFloatTotal amount already refunded for this cash in. Returns 0.00 when no refund has been made.
    taxFloatFee charged on this cash in. Returns 0.00 when no fee was charged.
    pix_qr_code_idIntegerIdentifier of the PIX QR Code that originated the payment. null when the payment was not made through a QR Code you generated.
    end_to_end_idStringEndToEndId of the cash in. Matches the value sent in the path.
    payer_documentStringCPF or CNPJ of the payer. null when not informed by the payer's institution.
    payer_nameStringName of the payer. null when not informed by the payer's institution.
    payer_ispbStringISPB code of the payer's institution. null when not informed.
    payer_agencyStringBranch/agency of the payer's account. null when not informed.
    payer_accountStringAccount number of the payer. null when not informed.
    internal_transferBooleantrue when the payment came from an account within the same institution, false when it came from an external institution.
    created_atDateTimeDate and time when the cash in was received.

    Error Responses

    HTTP CodeError MessageDescription
    404Transaction not foundNo PIX cash in was found for the informed EndToEndId, or the cash in is not available for the account you can access.
    401UnauthorizedInvalid or missing authentication token. Ensure you are sending a valid Bearer token.
    500Internal Server ErrorUnexpected error while processing the request.

    All errors are returned in the standard error envelope:

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

    Business Rules

    Validations:

    • The e2e path parameter is required and must be the EndToEndId of a received PIX cash in
    • Only PIX cash in transactions are returned. EndToEndIds of transfers you sent will not be found by this endpoint

    Important Notes:

    • The id returned here is the value expected by the chargeback endpoint in the transaction_id field
    • Use transaction_chargeback_value to know how much of the cash in has already been refunded before requesting a new chargeback
    • Payer fields depend on the information supplied by the payer's institution and may be returned as null