get
https://api.adopay.com.br/v2/finance/cashin/
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.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Endpoint
GET /v2/finance/cashin/{e2e}
Headers
| Parameter | Type | Description | Example |
|---|---|---|---|
| Authorization | String | Bearer + Access_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo |
Path Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| e2e | String | EndToEndId 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": "12345678900",
"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"
}| Field | Type | Description |
|---|---|---|
| id | Integer | Unique identifier of the cash in transaction. Use this value as the transaction_id when requesting a chargeback. |
| transaction_amount | Float | Amount received in the cash in. |
| transaction_chargeback_value | Float | Total amount already refunded for this cash in. Returns 0.00 when no refund has been made. |
| tax | Float | Fee charged on this cash in. Returns 0.00 when no fee was charged. |
| pix_qr_code_id | Integer | Identifier 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_id | String | EndToEndId of the cash in. Matches the value sent in the path. |
| payer_document | String | CPF or CNPJ of the payer. null when not informed by the payer's institution. |
| payer_name | String | Name of the payer. null when not informed by the payer's institution. |
| payer_ispb | String | ISPB code of the payer's institution. null when not informed. |
| payer_agency | String | Branch/agency of the payer's account. null when not informed. |
| payer_account | String | Account number of the payer. null when not informed. |
| internal_transfer | Boolean | true when the payment came from an account within the same institution, false when it came from an external institution. |
| created_at | DateTime | Date and time when the cash in was received. |
Error Responses
| HTTP Code | Error Message | Description |
|---|---|---|
| 404 | Transaction not found | No PIX cash in was found for the informed EndToEndId, or the cash in is not available for the account you can access. |
| 401 | Unauthorized | Invalid or missing authentication token. Ensure you are sending a valid Bearer token. |
| 500 | Internal Server Error | Unexpected 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
e2epath 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
idreturned here is the value expected by the chargeback endpoint in thetransaction_idfield - Use
transaction_chargeback_valueto 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
400Bad request - Invalid parameters
401Unauthorized - Invalid or missing authentication
404Transaction not found
500Internal server error
