Simulate Billing Payment (Sandbox Only)

PUT {{url_contbank}}/s2s/billings/settle/:billing_id/paid

Este endpoint permite simular pagamentos de cobranças. A função de simulação permite que você teste e valide o processo de pagamento sem realizar transações reais. Este recurso é exclusivo do ambiente de sandbox e não afetará transações em produção.

Ao realizar a simulação de baixa, a cobrança correspondente ao ID em questão, constará como Paga na tela de Gestão de Cobranças, acessada via Dashboard Bancário.

Ao mesmo tempo, caso seja efetuada qualquer consulta desta cobrança via API (endpoints de GET By ID ou List), teremos o status **PAID_OUT** retornado.

Tabela de Responses

CódigoDescriçãoConteúdo
204Sucesso (Sem Conteúdo)Nenhum conteúdo retornado
403Proibidojson schema

Tabela de Schema

CampoTipoDescrição
codeInteiroO código de erro HTTP (403 neste caso).
keyStringA chave que identifica o erro (SETTLEMENT_NOT_ALLOWED). Esse erro indica que a cobrança não esta registrada, e não pode ser simulado o pagamento.
messagesArrayUma lista de mensagens de erro, contendo o(s) motivo(s) do(s) erro(s).

HEADERS

KeyDatatypeRequiredDescription
X-Current-IdentitynumberCPF ou CNPJ do cliente emissor da cobrança