Simulação de pagamento

📘

Nota

A documentação da nova versão deste endpoint está disponível na aba v2 deste manual. Para acessá-la, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página.

Este endpoint permite que parceiro Bankly simule a realização do pagamento de um boleto.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

• O boleto tenha sido emitido com sucesso;
• O status do boleto esteja como Registered.

Requisição

Requisição HTTP

POST https://api.sandbox.bankly.com.br/bankslip/settlementpayment

--location --request POST 'https://api.sandbox.bankly.com.br/bankslip/settlementpayment' \ 
--header 'Content-Type: application/*+json' \ 
--header 'api-version: 1.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:

Cabeçalhos (Headers)

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:

{ 
    "account": { 
        "number": "15164", 
        "branch": "0001" 
    }, 
    "authenticationCode": "af5a79f0-cfe8-4d12-be4d-352db3bd0000" 
}'

Resposta (Response)

O status code 200 indicará que o boleto foi pago com sucesso.

🚧

Importante

Esse endpoint é para uso exclusivo do ambiente de homologação. Ele não funciona em ambiente de produção.

👍

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:

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 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.