Find by ID

GET

/api/user/cashout/{id}

Este endpoint permite consultar os detalhes de um cashout específico, utilizando seu identificador único (id).

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/cashout/{id}

Content-Type: application/json

Autenticação: api_token

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	UMBRELLAB2B/1.0	Sim

📥 Parâmetros de Caminho (Path Parameters)

Campo	Tipo	Obrigatório	Descrição
`id`	string	Sim	Identificador único do cashout

Request

Path Params

Query Params

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/user/cashout/?limit=10&page=1&orderDirection=desc&orderBy=id&value'

Response Example

200 - Success

{
    "status": 200,
    "message": "Cashouts buscado(s) com sucesso",
    "data": {
        "data": [
            {
                "id": "2fa01877-c654-55de-983f-efffe71dd506",
                "amount": 500,
                "fee": 0,
                "pixKey": "000000000000",
                "pixType": "CPF",
                "beneficiaryName": "nome completo",
                "beneficiaryDocument": "000000000000",
                "creditorName": null,
                "creditorDocument": null,
                "endToEndId": null,
                "receiptUrl": null,
                "description": "Saque de R$ 5,00.",
                "postbackUrl": "teste",
                "externalRef": null,
                "error": null,
                "status": "FAILED",
                "sellerId": "056515c0-c8e9-4c7b-96ae-a24e4c5c08f7",
                "gatewayProviderId": "0e1880c8-bb99-49f2-9ad1-d2c66837a3b3",
                "gatewayId": "2f08cdbb-9713-59a56-800c-e868168c2d6d",
                "createdAt": "2025-05-19T13:44:50.221Z",
                "updatedAt": "2025-05-19T13:44:52.576Z"
            }
        ],
        "pages": 1,
        "page": 1,
        "limit": 10,
        "total": 1
    },
    "error": null
}

Modified at 2026-03-30 04:13:59

Find all

Find by ID

✅ Requisitos da Requisição#

🧠 Header da requisição#

📥 Parâmetros de Caminho (Path Parameters)#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

📥 Parâmetros de Caminho (Path Parameters)