API Reference

Consultar transação Cashout

get
https://api.voidxpay.com/v1/cashout

Endpoint dual-purpose para consulta e listagem de transações Cashout.

Modo 1 — Busca unitária

Se id ou reference for informado, retorna uma única transação. O campo reference busca pelo ID do provider (providerTransactionId) e pelo código end-to-end.

Modo 2 — Listagem com filtros

Se nenhum dos parâmetros de busca unitária for informado, retorna uma lista paginada de transações com filtros opcionais por status, startDate e endDate.

Os resultados são ordenados do mais recente para o mais antigo. A paginação é baseada em cursor (pageToken).

Query Params
uuid

(Busca unitária) ID interno da transação (UUID). Se informado, retorna apenas a transação correspondente.

string

(Busca unitária) ID do provider ou código end-to-end do PIX. Busca primeiro por providerTransactionId, depois por endToEnd.

string
enum

(Listagem) Filtrar transações por status.

Allowed:
date-time

(Listagem) Data início do período (ISO 8601). Filtra pelo campo createdAt.

date-time

(Listagem) Data fim do período (ISO 8601). Filtra pelo campo createdAt.

integer
1 to 100
Defaults to 20

(Listagem) Máximo de resultados por página. Padrão: 20, máximo: 100.

string

(Listagem) Cursor para a próxima página, retornado no campo pagination.nextPageToken da resposta anterior. Quando nextPageToken for null, não há mais resultados.

Responses

Updated about 2 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago