Saques
Listar saques
GET/v1/withdrawalswithdrawals:readNOVO
Saques da conta com filtros por estado, external_id e período.
Cabeçalhos
Authorizationstringobrigatório
Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.
Parâmetros de consulta
limitinteger · 1–100opcional
cursorstring · 1–512opcional
Cursor opaco devolvido pela página anterior.
statusstringopcional
RESERVEDSUBMITTINGQUEUEDPROCESSINGCOMPLETEDFAILEDCANCELEDUNKNOWNMANUAL_REVIEW
external_idstring · 1–128opcional
created_fromdatetimeopcional
Criados a partir deste instante (inclusive).
created_todatetimeopcional
Criados antes deste instante.
Resposta 200
Página, mais novos primeiro
dataobject[]
16 campos
iduuid
external_idstring
method"PIX"
statusstring
RESERVEDSUBMITTINGQUEUEDPROCESSINGCOMPLETEDFAILEDCANCELEDUNKNOWNMANUAL_REVIEW
amount_centsinteger
Valor inteiro em centavos.
fee_centsinteger
Valor inteiro em centavos.
total_debit_centsinteger
Valor inteiro em centavos.
pix_keyobject
2 campos
typestring
CPFCNPJEMAILTELEFONECHAVE_ALEATORIA
maskedstring
created_atdatetime
descriptionstringNOVO
metadataobject · até 20 chavesNOVO
Pares chave-valor seus, até 20 chaves e 2 KB. Gravados uma vez na criação e devolvidos em toda consulta e webhook. Não guarde dados pessoais aqui.
recipientobject | nullNOVO
Recebedor confirmado pelo banco, quando informado.
2 campos
namestring | null
bankstring | null
end_to_end_idstring | nullNOVO
ID fim a fim do Pix enviado.
failure_reasonstring | nullNOVO
Motivo estável quando status é FAILED ou CANCELED.
destination_rejectedreturned_by_bankprocessing_failed
completed_atdatetime | nullNOVO
updated_atdatetimeNOVO
next_cursorstring | null
Códigos de resposta
| HTTP | Quando acontece |
|---|---|
| 200 | Página, mais novos primeiro |
| 400 | Requisição ou cursor inválido |
| 401 | Chave ausente, inválida ou sem o escopo exigido |
| 429 | Limite de requisições excedido |
Cada código de erro está explicado em Erros.