Find all

GET

/api/user/cashout

Este endpoint permite listar todos os cashouts vinculados ao usuário autenticado.
É possível utilizar paginação para controlar a quantidade de dados retornados.

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/cashout

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`	AtivoB2B/1.0	Sim

🔎 Parâmetros de Consulta (Query Parameters)

Campo	Tipo	Obrigatório	Descrição
`page`	string	Não	Página atual da listagem. Ex: `1`
`limit`	string	Não	Quantidade de clientes por página. Ex: `10`

Request

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": "za5556ad1a-da65-da54-a98d-efffe71dd506",
                "amount": 500,
                "fee": 0,
                "pixKey": "00000000000",
                "pixType": "CPF",
                "beneficiaryName": "João Pereira",
                "beneficiaryDocument": "00000000000",
                "creditorName": null,
                "creditorDocument": null,
                "endToEndId": null,
                "receiptUrl": null,
                "description": "Saque de R$ 5,00.",
                "postbackUrl": "teste",
                "externalRef": null,
                "error": "Cannot read properties of undefined (reading 'cashoutClientCert')",
                "status": "FAILED",
                "sellerId": "056515c0-d564-4c7b-d564-a24e4c5c08f7",
                "gatewayProviderId": "0e1880c8-bb99-49f2-9ad1-d2c66837a3b3",
                "gatewayId": "2f08cdbb-84a1-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 2025-07-23 19:02:40

Create

Find by ID

Find all

✅ Requisitos da Requisição#

🧠 Header da requisição#

🔎 Parâmetros de Consulta (Query Parameters)#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

🔎 Parâmetros de Consulta (Query Parameters)