Find all

Este endpoint permite listar as transferências realizadas por um recebedor autenticado.
É possível aplicar filtros, paginação e ordenações para refinar os resultados retornados.

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/transfers

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
`limit`	string	Não	Quantidade de registros por página. Ex: `10`
`page`	string	Não	Página atual da listagem. Ex: `1`
`orderBy`	string	Não	Campo utilizado para ordenação. Ex: `id`
`orderDirection`	string	Não	Direção da ordenação: `asc` ou `desc`. Ex: `desc`
`id`	string	Não	Filtra uma transferência específica pelo seu UUID. Ex: `uuid`
`status`	array[string]	Não	Lista de status para filtrar transferências. Ex: `PROCESSING, PAID`
`destination`	string	Não	Documento do destinatário da transferência. Ex: `00.000.000/0000-00`

curl --location --request GET '/api/user/transfers?limit=10&page=1&orderBy=id&orderDirection=desc&id=uuid&status=PROCESSING&status=PAID&destination=00.000.000/0000-00' \ --header 'x-api-key: {Token}' \ --header 'User-Agent: AtivoB2B/1.0' \ --header 'Content-Type: application/json' \ --data-raw '{}'

{ "status": 200, "message": "Transferências encontradas com sucesso", "data": { "data": [ { "id": "********-****-****-****-************", "amount": 10000, "fixedFee": 530, "variableFee": 5, "status": "FAILED", "destination": "****-**", "type": "BANK_TRANSFER", "isSubAccount": false, "createdAt": "2025-04-09T10:37:19.336Z" }, { "id": "********-****-****-****-************", "amount": 10000, "fixedFee": 530, "fee": 3000, "status": "FAILED", "destination": "*************", "type": "PIX", "isSubAccount": false, "createdAt": "2025-04-09T10:35:15.956Z" } ], "pages": 2, "page": 1, "limit": 10, "total": 13 }, "error": null }

✅ Requisitos da Requisição

🧠 Header da requisição

🔎 Parâmetros de Consulta (Query Parameters)

Request

Responses

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)