PayZu CâmbioSaques

Criar saque

POST/v1/withdrawals

Confira o passo a passo → https://docs.payzu.com.br/docs/fx/create-the-withdrawal


Body Params

walletIdstringobrigatório
ID da carteira de destino.
amountstringobrigatório
Valor do saque.
statedNetAmountstringobrigatório
Valor que deve chegar à carteira, igual ao net da simulação.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
Idempotency-Keystringobrigatório
Seu identificador do pedido. Se repetir, retorna a resposta já criada.
acceptstring
Formato da resposta.

Responses

201Saque criado
codestringCódigo do saque.
statusstringStatus do saque. Valores atuais: pending, submitted, confirmed, failed e expired.
networkstring | nullRede do saque.
TRC20ERC20BEP20
addressstring | nullEndereço de destino.
walletLabelstring | nullNome da carteira de destino.
amountstringValor que chega à carteira.
feestringTaxa do saque.
createdAtstringData e hora do pedido.
submittedAtstring | nullData e hora do envio do saque.
confirmedAtstring | nullData e hora da confirmação.
txIdstring | nullHash da transação na rede.
explorerUrlstring | nullPágina da transação na rede.
400Requisição inválida
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
invalid_requestinvalid_jsonbelow_minimumdustinvalid_amountidempotency_key_required
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
401Chave de API ausente ou inválida
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
unauthorizedkey_revokedkey_expired
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
403Acesso negado
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
api_not_enabledip_not_allowedinsufficient_scopeaccount_blocked
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
404Carteira não encontrada
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
not_found
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
409Conflito
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
over_availablestated_net_stalerequest_id_reusedidempotency_in_progress
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
413Corpo grande demais
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
payload_too_large
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
415Content-Type não aceito
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
unsupported_media_type
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
422Operação recusada
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
idempotency_key_reused
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
429Limite de requisições atingido
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
rate_limited
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
500Erro interno
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
internal_error
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.
503Serviço indisponível
errorobjectDados do erro.
Campos do objeto 4
codestringCódigo do erro.
service_unavailable
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsobjectDados do erro, quando houver.
supportIdstringIdentificador para informar ao suporte, quando houver.

Linguagem

Credenciais Bearer

Token de API

curl --request POST \     --url https://api.exchange.payzu.com.br/v1/withdrawals \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json