Cria um saque
/v1/withdrawalsAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Corpo da requisição
amountintegerobrigatórioValor a sacar, em centavos (debitado do saldo disponível no pedido).
walletIdstringA conta bancária que o recebe. Omitida = a principal; a parte das vendas no Pix vai sempre para a chave Pix do seu próprio CPF/CNPJ.
Respostas
201Criado
idstringobrigatórioIdentificador público (cash_…)
feeintegerobrigatórioTaxa do saque, em centavos.
_linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).amountintegerobrigatórioValor sacado, em centavos.
methodstringobrigatóriopode ser nuloComo é pago (ex.:
pix,ted).paidAtstringobrigatóriopode ser nuloQuando foi pago;
nullaté lá.statusstringobrigatórioStatus:
pending,processing,paid,canceled,failed…currencystringobrigatórioMoeda (ISO 4217).
merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
walletIdstringobrigatóriopode ser nuloA conta bancária em que é pago;
nullquando pago na sua chave Pix.createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
updatedAtstringobrigatórioQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
approvedAtstringobrigatóriopode ser nuloQuando foi aprovado para pagamento;
nullaté lá.transferCodestringobrigatóriopode ser nuloIdentificador da transferência no banco;
nullaté ser pago.receivingBankAccountobjectpode ser nuloRetrato da conta bancária de destino, tirado quando o saque foi pedido.
+8 campos de
receivingBankAccounttypestringobrigatóriopode ser nuloTipo da conta.
pixKeystringobrigatóriopode ser nuloChave Pix, quando pago a uma.
bankCodestringobrigatóriopode ser nuloCódigo do banco.
bankNamestringobrigatóriopode ser nuloNome do banco.
documentstringobrigatóriopode ser nuloCPF/CNPJ do titular.
holderNamestringobrigatóriopode ser nuloNome do titular da conta.
accountNumberstringobrigatóriopode ser nuloNúmero da conta.
routingNumberstringobrigatóriopode ser nuloAgência.
400Requisição inválida (validação)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
409Conflito (idempotência ou estado)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
422Regra de negócio impede o processamento
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório