Saques
Consultar saque Pix
GET/v1/withdrawals/{withdrawalId}withdrawals:read
Ciclo de vida
- RESERVEDSUBMITTING · QUEUEDreservado
- SUBMITTING · QUEUEDPROCESSINGenviado
- PROCESSINGCOMPLETEDwithdrawal.completed
- PROCESSINGFAILED · UNKNOWN · MANUAL_REVIEWfalha devolve o valor
Cabeçalhos
Authorizationstringobrigatório
Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.
Parâmetros de caminho
withdrawalIduuidobrigatório
Resposta 200
Saque encontrado
iduuid
external_idstring
method"PIX"
statusstring
RESERVEDSUBMITTINGQUEUEDPROCESSINGCOMPLETEDFAILEDCANCELEDUNKNOWNMANUAL_REVIEW
amount_centsinteger
Valor inteiro em centavos.
exemplo 150000 = R$ 1.500,00fee_centsinteger
Valor inteiro em centavos.
exemplo 150 = R$ 1,50total_debit_centsinteger
Valor inteiro em centavos.
exemplo 150150 = R$ 1.501,50pix_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
Códigos de resposta
| HTTP | Quando acontece |
|---|---|
| 200 | Saque encontrado |
| 400 | Requisição ou cursor inválido |
| 401 | Chave ausente, inválida ou sem o escopo exigido |
| 404 | Recurso não encontrado para o estabelecimento autenticado |
| 429 | Limite de requisições excedido |
Cada código de erro está explicado em Erros.