--- updatedAt: 2026-06-11T16:02:00.000Z --- Fetch the complete documentation index at: https://simpay-prod.readme.io/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version. # Status Cashout Retrieves the status and details of a cashout transaction. You can query by transaction ID, EndToEndId (e2e_id), or idempotency key. This endpoint provides comprehensive information about the transaction including status, amounts, recipient details, and timestamps. ## Endpoint ``` GET /status-cashout ``` ## Headers | Parameter | Type | Description | Required or Optional | Example | | :---------------- | :----- | :--------------------- | :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authorization** | String | Bearer + Access\_token | required | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo | ## Query Parameters | Parameter | Type | Description | Required | Example | | :------------------- | :------ | :------------------------------------------------------------------------------------------------------- | :---------- | :----------------------------------- | | **id** | Integer | Transaction ID. Only one parameter (id, e2e\_id, or idempotency\_key) should be provided. | conditional | 123456 | | **e2e\_id** | String | EndToEndId of the transaction. Only one parameter (id, e2e\_id, or idempotency\_key) should be provided. | conditional | E60701190202301011200123456789012 | | **idempotency\_key** | UUID | Idempotency key used when creating the transaction. Only one parameter should be provided. | conditional | 550e8400-e29b-41d4-a716-446655440000 | **Important**: Exactly one of the three parameters must be provided. If none or multiple parameters are provided, the API will return a 400 error. ## Request Examples **Query by transaction ID:** ```http GET /status-cashout?id=123456 Authorization: Bearer ``` **Query by EndToEndId:** ```http GET /status-cashout?e2e_id=E60701190202301011200123456789012 Authorization: Bearer ``` **Query by idempotency key:** ```http GET /status-cashout?idempotency_key=550e8400-e29b-41d4-a716-446655440000 Authorization: Bearer ``` ## Response ### Success Response (200 OK) ```json { "id": 123456, "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "company_id": 100, "account_id": 789, "account_mirror_id": null, "source_account_branch": "0001", "source_account_number": "123456", "amount": 100.50, "recipient_name": "João da Silva", "recipient_legal_id": "12345678900", "recipient_institution": "60701190", "recipient_institution_name": "Itaú Unibanco S.A.", "recipient_branch": "0001", "recipient_account": "654321", "recipient_account_type": "CONTA_CORRENTE", "key": "joao@example.com", "key_type": "EMAIL", "status": "PROCESSING", "tag": "payment-reference-123", "e2e_id": "E60701190202301011200123456789012", "idempotency_key": "550e8400-e29b-41d4-a716-446655440000", "created_at": "2023-01-01T12:00:00Z", "updated_at": "2023-01-01T12:01:00Z" } ``` ### Response Fields | Field | Type | Description | | :------------------------------- | :------- | :------------------------------------------------------------------------------- | | **id** | Integer | Unique transaction identifier | | **uuid** | UUID | UUID of the transaction | | **company\_id** | Integer | Company identifier | | **account\_id** | Integer | Source account identifier | | **account\_mirror\_id** | Integer | Mirror account identifier (if applicable) | | **source\_account\_branch** | String | Branch identifier of the source account | | **source\_account\_number** | String | Account number of the source account | | **amount** | Decimal | Transaction amount | | **recipient\_name** | String | Name of the recipient | | **recipient\_legal\_id** | String | CPF or CNPJ of the recipient | | **recipient\_institution** | String | ISPB code of recipient's bank | | **recipient\_institution\_name** | String | Name of recipient's bank | | **recipient\_branch** | String | Branch/agency of recipient's account | | **recipient\_account** | String | Account number of the recipient | | **recipient\_account\_type** | String | Type of recipient's account (CONTA\_CORRENTE, CONTA\_POUPANCA, CONTA\_PAGAMENTO) | | **key** | String | PIX key used (if applicable) | | **key\_type** | String | Type of PIX key (EMAIL, PHONE, CPF, CNPJ, EVP) | | **status** | String | Transaction status (NEW, PROCESSING, APPROVED, REJECTED, CANCELED, ERROR) | | **tag** | String | Custom reference tag | | **e2e\_id** | String | EndToEndId assigned by the payment system | | **idempotency\_key** | UUID | Idempotency key used when creating the transaction | | **created\_at** | DateTime | Timestamp when the transaction was created | | **updated\_at** | DateTime | Timestamp when the transaction was last updated | ## Error Responses ### 400 Bad Request - No Parameter Provided ```json { "detail": "Either 'id', 'e2e_id' or 'idempotency_key' parameter is required" } ``` ### 400 Bad Request - Multiple Parameters Provided ```json { "detail": "Only one parameter should be provided: 'id', 'e2e_id' or 'idempotency_key'" } ``` ### 400 Bad Request - Transaction Not Found ```json { "detail": "Transaction not found" } ``` ### 401 Unauthorized ```json { "detail": "Invalid or expired token" } ``` ## Business Rules 1. **Parameter Exclusivity**: Only one query parameter (id, e2e\_id, or idempotency\_key) can be used per request 2. **Company Scope**: Users can only query transactions belonging to their company 3. **Authentication**: Requires valid Bearer token with Cashout.READ permission 4. **Audience Support**: Available for both WEB and API audiences ## Use Cases * **Transaction Tracking**: Monitor the status of cashout operations * **Reconciliation**: Match transactions using idempotency keys * **Customer Support**: Look up transaction details using EndToEndId * **Webhook Verification**: Confirm transaction status after webhook notifications ## Related Endpoints * [POST Create Cashout](create-cashout) - Create a new cashout transaction * [POST Approve Cashout](approve-cashout) - Approve a pending cashout * [GET Status Cashout by Tag](get-status-cashout-by-tag) - Query multiple transactions by tag # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "3.0.0", "title": "Banking & PIX API", "description": "Complete API documentation for the banking and PIX payment platform." }, "servers": [ { "url": "https://api.somossimpay.com.br/" } ], "security": [], "tags": [ { "name": "Cashout-API", "description": "Cashout-API endpoints" } ], "paths": { "/v2/finance/status-cashout": { "get": { "operationId": "get_cashout_status-cashout", "summary": "Status Cashout", "description": "Retrieves the status and details of a cashout transaction. You can query by transaction ID, EndToEndId (e2e_id), or idempotency key. This endpoint provides comprehensive information about the transaction including status, amounts, recipient details, and timestamps.", "tags": [ "Cashout-API" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request - Invalid parameters" }, "401": { "description": "Unauthorized - Invalid or missing authentication" }, "500": { "description": "Internal server error" } } } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": true, "samples-languages": [ "curl", "python", "javascript", "java", "go" ] } } ```