Pular para o conteúdo principal
GET
/
v1
/
cashouts
Listar saques
curl --request GET \
  --url https://api-payment.safefypay.com.br/v1/cashouts \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
        "amount": 50000,
        "fee": 200,
        "netAmount": 49800,
        "status": "Completed",
        "pixKeyType": "CPF",
        "pixKey": "***456789**",
        "endToEndId": "E12345678202501151600xyz789abc012",
        "failureReason": null,
        "requestedAt": "2025-01-15T16:00:00Z",
        "completedAt": "2025-01-15T16:05:00Z",
        "createdAt": "2025-01-15T16:00:00Z"
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  },
  "message": null,
  "error": null
}
Retorna uma lista paginada de saques com opcoes de filtragem.

​
Parametros de Query

​
page
integer
Numero da pagina. Padrao: 1.
​
pageSize
integer
Quantidade de itens por pagina. Padrao: 20. Maximo: 100.
​
status
string
Filtrar por status: Pending, Processing, Completed, Failed, Rejected, Cancelled.
​
externalId
string
Filtrar por ID externo.
​
startDate
string
Data inicial no formato ISO 8601.
​
endDate
string
Data final no formato ISO 8601.

Autorizações

​
Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Parâmetros de consulta

​
page
integer
padrão:1

Numero da pagina

Exemplo:

1

​
pageSize
integer
padrão:20

Itens por pagina (max: 100)

Exemplo:

20

​
status
enum<string>

Filtrar por status

Opções disponíveis:
Pending,
Processing,
Completed,
Failed,
Rejected,
Cancelled
Exemplo:

"Completed"

​
startDate
string<date-time>

Data inicial (ISO 8601)

Exemplo:

"2025-01-01T00:00:00Z"

​
endDate
string<date-time>

Data final (ISO 8601)

Exemplo:

"2025-01-31T23:59:59Z"

Resposta

Lista de saques

​
data
object
​
message
string | null
​
error
object