Simulação de cenários

Esta página descreve como simular a efetivação de ações feitas por agentes externos para testar o fluxo de liquidação de boletos. Essas simulações são úteis para homologação e testes de integração.

Informação

Não há payload de retorno (response body) nessas requisições. Elas simulam ações externas e retornam apenas o status HTTP.

1 - Simulação de aviso de pagamento

Simula o aviso de pagamento de um boleto, alterando seu status para payment_notice.

ENDPOINT

/mock/bank_slip/payment_notice

MÉTODO

POST

Request Body

{
    "bank_slip_key": "0d00b0e2-af11-472f-11f0-11f3330bae33",
    "paid_amount": 12.0,
    "payment_method": "cash",
    "payment_type": "full_interbank"
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
bank_slip_key*	string	Chave unitária do boleto	36
paid_amount	float	Valor do pagamento. Se não informado, usa o valor original do boleto	-
payment_method	string	Método de pagamento utilizado	-
payment_type	string	Tipo de pagamento interbancário	-

Enumeradores payment_method

Enumerador	Descrição
cash	Dinheiro
account_debit	Débito em conta
credit_card	Cartão de crédito
check	Cheque

Enumeradores payment_type

Enumerador	Descrição
full_interbank	Pagamento integral interbancário
partial_interbank	Pagamento parcial interbancário

Comportamento

• Se paid_amount não for informado, será utilizado o valor original do boleto
• Se payment_type não for informado, será considerado como pagamento integral (full_interbank)
• A simulação cria uma ocorrência de aviso de pagamento
• O boleto será movido para o status payment_notice após a simulação
• Importante: Para partial_interbank, o status do boleto não é alterado. Esta opção é utilizada para simular casos de boletos de pagamento parcial, conforme explicado na introdução

2 - Simulação de liquidação de boleto

Simula o pagamento e liquidação financeira de um boleto, alterando seu status para paid.

ENDPOINT

/mock/bank_slip/settlement

MÉTODO

POST

Request Body

{
    "bank_slip_key": "0d00b0e2-af11-472f-11f0-11f3330bae33",
    "paid_amount": 12.0,
    "payment_method": "cash"
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
bank_slip_key*	string	Chave unitária do boleto	36
paid_amount	float	Valor do pagamento da liquidação. Se não informado, usa o valor original do boleto	-
payment_method	string	Método de pagamento utilizado	-

Enumeradores payment_method

Enumerador	Descrição
cash	Dinheiro
account_debit	Débito em conta
credit_card	Cartão de crédito
check	Cheque

Comportamento

• Se paid_amount não for informado, será utilizado o valor original do boleto
• A simulação cria uma ocorrência de pagamento com código 65 (pagamento) por padrão
• O boleto será movido para o status paid após a simulação