Emite (ou devolve o já aberto) Pix para quitar um saldo negativo
POST
/v1/balance/debt-settlementsAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Respostas
200Sucesso
idstringobrigatórioId público da quitação.
pixobjectobrigatóriopode ser nuloO Pix a pagar — só enquanto
pending.+1 campo de
pixqrCodeEmvstringobrigatóriopode ser nuloCódigo copia e cola do Pix.
amountintegerobrigatórioValor do Pix, em centavos.
objectstringobrigatórioSempre
debt_settlement.Valores:debt_settlementpaidAtstringobrigatóriopode ser nuloQuando foi pago;
nullaté lá.statusstringobrigatóriopending(Pix em aberto),paid,expired(não pago) ourefunded.Valores:pendingpaidexpiredrefundedcurrencystringobrigatórioSempre
BRL.Valores:BRLcreatedAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
expiresAtstringobrigatóriopode ser nuloQuando o Pix expira.
paidAmountintegerobrigatóriopode ser nuloO que foi pago, em centavos;
nullaté ser pago. O que passar da dívida vira saldo disponível.owedAtIssuanceintegerobrigatórioO que se devia quando o Pix foi emitido, em centavos.
refundedAmountintegerobrigatórioO que foi estornado dele, em centavos.
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