HomeSiteDashboardInternet Bank
HomeSiteDashboardInternet Bank
  1. Boletos
  • Core
    • oAuth
      • oauth2/token
      • oauth2/refresh_token
      • account/forgot_password
      • account/change_password
    • account
      • notifications
        • account/notifications
        • account/notifications/config
        • account/notifications/config
        • account/notifications/{id}/read
      • account/me
      • account/balance
      • account/balances
      • account/statement
      • account/last_statement
      • account/products
      • account/send_phone_code
      • account/register (cpf)
      • account/register (cnpj)
      • account/verifie_phone_code
      • account/upload_docs
      • account/transactional_password
      • account/check_document
      • account/profile_photo
      • account/rating
      • account/transactional_password
      • account/verifie_transactional_password
      • account/phone
      • account/phone/validate
      • account/password
      • account/tooltip
      • account/profile_photo
      • account/country
      • account/report
      • account/active
    • health
      • status
    • id
      • id/token
      • id/verifie_token
      • id/transactional_password
      • id/verifie_essential
    • version
      • version/app
    • Ultils
      • country
    • Representative
      • Add Lead
      • Add Lead Copy
      • root_account
    • validations
      • account/check_phone_number
      • account/check_email
      • account/search_postal_code
    • banking
      • institutions
      • /institutions/{id}
      • /institutions/{bankId}/branch/{code}
  • OpenBanking
    • Autenticação
      • Recebendo um token de acesso
    • Conta
      • Dados da conta
      • Visualizar saldo na conta
    • PIX
      • Pagamento
        • Iniciando e Confirmando o PIX
        • Listando Pagamentos de PIX
        • Detalhe de um Pagamento PIX
      • Recebimento
        • Criando QRCode PIX
        • Listando QRCodes
        • Detalhe de um QRCode
        • Devolvendo PIX Recebido
        • Encontrando pix pelo EndToEndId
        • Inativando um QRCode
    • Transferências
      • Consulta conta disponível transferências
      • Transferências entre contas P2P
      • Transferências entre contas P2P por Lote
      • Transferências entre contas TED
    • Boletos
      • Retornando lista de boleto emitidos
        GET
      • Emitindo um boleto
        POST
      • Cancelando um boleto
        DELETE
    • Pagamentos de Títulos
      • Consulta código de barras
      • Pagamento código de barras
    • Webhook
      • Criando um webhook
      • Listando webhooks
      • Removendo webhook
    • HealthCheck
      GET
  1. Boletos

Emitindo um boleto

Production
https://api.valut.app/openbank/v1
Production
https://api.valut.app/openbank/v1
POST
https://api.valut.app/openbank/v1
/boleto
Gera um novo token de acesso

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo
{
    "max_payment_date": "2023-09-30T23:59:59-03:00",
    "description": "teste",
    "payer": {
        "document_type": "CPF",
        "document": "01234567890",
        "address": {
            "city": "Barueri",
            "district": "Teste",
            "complement": "asdDA",
            "number": "SN",
            "state": "SP",
            "postal_code": "01624-680",
            "address": "RUA PAMPLONA"
        },
        "name": "Teste Brasilcash"
    },
    "penalty": {
        "penalty_date": "2022-08-31T23:59:59-03:00",
        "fee": 5.0,
        "amount": 200.0
    },
    "amount": 2500,
    "expiration": "2022-08-31T23:59:59-03:00"
}

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.valut.app/openbank/v1/boleto' \
--header 'Session-id: teste' \
--header 'branch-id: {{branchId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "max_payment_date": "2023-09-30T23:59:59-03:00",
    "description": "teste",
    "payer": {
        "document_type": "CPF",
        "document": "01234567890",
        "address": {
            "city": "Barueri",
            "district": "Teste",
            "complement": "asdDA",
            "number": "SN",
            "state": "SP",
            "postal_code": "01624-680",
            "address": "RUA PAMPLONA"
        },
        "name": "Teste Brasilcash"
    },
    "penalty": {
        "penalty_date": "2022-08-31T23:59:59-03:00",
        "fee": 5.0,
        "amount": 200.0
    },
    "amount": 2500,
    "expiration": "2022-08-31T23:59:59-03:00"
}'

Respostas

🟢200Emitindo um boleto
application/json
Body

Exemplo
{
    "id": "9fe33432-690b-ec11-981f-e42aac92f420",
    "barcode_line": "21890010070311673580855503438982787350000005100",
    "code": "iXqqfn",
    "amount": 5100,
    "share_description": "Para abastecer sua conta, você deve pagar seu boleto com o código. 21890010070311673580855503438982787350000005100, ou se preferir compartilhe o link. https://api.brasilcash.com.br/cdn/v1/boleto/9fe33432-690b-ec11-981f-e42aac92f420/print",
    "expiration": "2021-09-06T23:59:59Z",
    "link": "https://api.brasilcash.com.br/cdn/v1/boleto/9fe33432-690b-ec11-981f-e42aac92f420/print",
    "payer": null
}
🟢200Emitindo um boleto - Com multa fixa
🟢200Emitindo um boleto - Com Juros
🟢200Emitindo um boleto - Com multa e juros
Modificado em 2024-12-09 08:26:00
Página anterior
Retornando lista de boleto emitidos
Próxima página
Cancelando um boleto
Built with