Iniciar um pagamento usando dados do boleto.

POST

/billets/payments

Billets

Este endpoint permite solicitar uma ordem de pagamento de boleto (boleto bancário brasileiro) (cash-out) usando o código do boleto (linha digitável).
1 - O pagamento sempre será feito usando um valor ajustado (juros e multas).
2 - Boletos cujo valor de pagamento possa ser alterado pelo pagador só podem ser pagos via web (Finance).

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

billets.write-Access create billets

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢202

application/json

Aceito

Bodyapplication/json

🟠400

🟠401

🟠403

🟠412

🟠422

🟠429

🔴500

🔴503

🔴504

Request Example

Shell

JavaScript

Java

Swift

curl --location '/billets/payments' \
--header 'x-idempotency-key;' \
--header 'Content-Type: application/json' \
--data '{
    "digitableCode": "string",
    "description": "string",
    "paymentFlow": "INSTANT",
    "payment": {
        "currency": "BRL",
        "amount": 0
    }
}'

Response Example

202 - Exemplo 1

{
    "id": 0,
    "idempotencyKey": "string",
    "eventDate": "2019-08-24T14:15:22.123Z",
    "digitableCode": "string",
    "description": "string",
    "status": "CANCELED",
    "transactionType": "PIX",
    "creditDebitType": "CREDIT",
    "payment": {
        "currency": "BRL",
        "amount": 0
    }
}

Página anterior

Verificar informações do QRCode via Copia e Cola

Próxima página

Obter uma lista de pagamentos de boletos.