Simulação de pagamento
simulação
Este endpoint permite que parceiro Bankly simule a realização do pagamento de um boleto.
Importante
Esse endpoint é para uso exclusivo do ambiente de sandbox. Ele não funciona em ambiente de produção.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O boleto tenha sido registrado com sucesso (status Registered).
Requisição (Request)
Requisição HTTP
POST https://api.sandbox.bankly.com.br/bankslip/settlementpayment
--request POST
--url 'https://api.sandbox.bankly.com.br/bankslip/settlementpayment' \
--header 'Content-Type: application/json' \
--header 'api-version: 2.0' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
"account": {
"number": "15164",
"branch": "0001"
},
"authenticationCode": "af5a79f0-cfe8-4d12-be4d-352db3bd0000"
}'
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
boleto.create | Concede acesso para simular o pagamento de boletos. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API, que, neste caso, é 2.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
Não é necessário enviar parâmetros no path desta requisição.
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
account | object | Obrigatório. Objeto que contém informações sobre a conta do beneficiário final do boleto. |
account.number | string | Obrigatório. Número da conta. |
account.branch | string | Obrigatório. Número da agência bancária. |
authenticationCode | string | Obrigatório. Identificador único do boleto. |
{
"account": {
"number": "15164",
"branch": "0001"
},
"authenticationCode": "af5a79f0-cfe8-4d12-be4d-352db3bd0000"
}'
Importante
É necessário informar todos os campos para que a simulação de pagamento seja efetuada com sucesso.
Resposta (Response)
O status code 200 indicará que o boleto foi pago com sucesso.
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | MAKE_DEPOSIT_ERROR | There is a problem to MakeDeposit | Houve uma falha no depósito para conta do beneficiário final. |
| 400 | BANKSLIP_INVALID_STATUS_OPERATION | Invalid bankslip status to perform this operation | O boleto está com status diferente de “Registered”. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago