Emitir Boleto




POST https://sandbox-api.openbank.stone.com.br/api/v1/barcode_payment_invoices

BODY PARAMS



account_id* string
Identificador da conta que irá gerar o documento.



amount* int32
Valor do boleto em centavos de Real, ou seja, 20 reais fica 2000.



expiration_date* string
Data de vencimento do boleto bancário. Mesmo depois dessa data expirar o pagamento ainda pode ser feito. Formato: yyyy-mm-dd



limit_date string
Data limite para pagamento do boleto bancário. Deve ser igual à data de vencimento para boletos de depósito e proposta. Para boletos de cobrança, deve ser maior que a data de vencimento. Se não informada, será usada a expiration_date, nos boletos de depósito e de proposta. Os boletos que forem pagos após a data limite serão devolvidos.



invoice_type* string
Tipo de boleto bancário. Valores suportados: proposal, deposit e bill_of_exchange.



customer object

    document string (obrigatório)
    Número do documento do pagador sem pontos. Não é obrigatório no tipo deposit.

    document_type string (opcional)

    legal_name string (obrigatório)
    É o nome que identifica o pagador para fins legais, administrativos e outros fins oficiais. Não é obrigatório no tipo deposit.

    trade_name string (obrigatório)
    Nome fantasia do pagador. Obrigatório no caso de pagador PJ.



discounts array_of_objects


    date string
    Data até a qual o desconto deve ser aplicado. Formato ISO8601 "YYYY-MM-DD". É aceito nos boletos de proposta e de cobrança.

    value string
    Valor percentual (%) do desconto que será aplicado ao boleto. O valor deve ser maior que 0.0 e até 90.0. Formato decimal. Ex: “20.0”. É aceito nos tipos de proposta e cobrança.



fine object


    date string (obrigatório)
    Data que define o dia a partir do qual a multa deve ser aplicada ao boleto. Caso não seja infromada será consiederada a data de validdade. Só é aceito no boleto de cobrança.

    value string (obrigatório)
    Valor percentual (%) da multa que será aplicada ao boleto. O valor do deve ser maior que 0.0 e até 2.0. Formato decimal. Ex: “2.0”. Só é aceito no boleto de cobrança.



interest object


    date string (obrigatório)
    Data que define o dia a partir do qual os juros passam a ser aplicados ao boleto. Só é aceito no boleto de cobrança.

    value string (obrigatório)
    Valor parcentual (%) dos juros que será aplicado ao boleto por mês. O valor do deve ser maior que 0.0 e até 1.0. Formato decimal. Ex: “1.0”. Só é aceito no boleto de cobrança.



receiver object


    legal_name string
    É o nome que identifica o sacado avalista para fins legais, administrativos e outros fins oficiais.

    document string
    Número do documento do sacador avalista.



address object


    city string (obrigatório)
    Cidade do beneficiário do boleto.

    country string (obrigatório)
    País do beneficiário do boleto.

    extra string
    Complemento do endereço do beneficiário do boleto.

    neighborhood string (obrigatório)
    Bairro do beneficiário do boleto.

    postal_code string (obrigatório)
    CEP do beneficiário do boleto.

    state string (obrigatório)
    UF do beneficiário do boleto.

    street string (obrigatório)
    Logradouro do beneficiário do boleto.

    street_number string
    Número do logradouro do beneficiário do boleto.



HEADERS



x-stone-idempotency-key string
Chave de idempotência


Data limite no tipo proposal
A limit_date será sempre igual a expiration_date para boletos do tipo proposal uma vez que a proposta é válida somente até a data do vencimento.


Responses

200 OK
content-type: application/json

Body


{
	"account_id": "ec363b21-113f-44e9-8cc3-dfcdb3cc2dc3",
    "amount": 2100,
    "barcode": "19797845600000021000000063139072468215929006",
    "beneficiary": {
      "account_code": "1085737",
      "address": {
        "city": "Rio de Janeiro",
        "country": "Brazil",
        "extra": null,
        "neighborhood": "Centro",
        "postal_code": "20021-290",
        "state": "RJ",
        "street": "Rua do Passeio",
        "street_number": null
      },
      "branch_code": "1",
      "document": "39809096038",
      "document_type": "cpf",
      "legal_name": "Pereira da Silva",
      "trade_name": null
    },
    "created_at": "2020-07-27T18:25:38Z",
    "created_by": "user:34a071d5-e1d4-4cb0-acf7-ca9b106fec65",
    "customer": {
      "document": "11121744590",
      "document_type": "cpf",
      "legal_name": "Pereira da Silva",
      "trade_name": null
    },
    "discounts": [
      {
        "date": "2020-11-20",
        "value": "0.1"
      }
    ],
    "expiration_date": "2020-12-01",
    "fee": 0,
    "fee_metadata": {
      "billing_exemption_participant": true,
      "fee": 0,
      "max_free": 5,
      "original_fee": 200,
      "remaining_free": 5
    },
    "fine": {
      "date": "2021-01-02",
      "value": "1"
    },
    "id": "172caf21-13de-4baa-9823-a21ac17ba8fa",
    "interest": {
      "date": "2021-01-02",
      "value": "1"
    },
    "invoice_type": "bill_of_exchange",
    "issuance_date": "2020-07-27",
    "limit_date": "2021-02-01",
    "our_number": "63139072468215929006",
    "customer": {
      "document": "11121740790",
      "document_type": "cpf",
      "legal_name": "Pereira da Silva",
      "trade_name": null
    },
   "receiver": null,
   "registered_at": null,
   "settled_at": null,
    "status": "CREATED",
    "writable_line": "19790000056313907246482159290061784560000002100"
}

201 Created

Body

{
  "account_id": "ec363b21-113f-44e9-8cc3-dfcdb3cc2dc3",
  "amount": 2100,
  "barcode": "19797845600000021000000063139072468215929006",
  "beneficiary": {
    "account_code": "1085737",
    "branch_code": "1",
    "document": "39809096038",
    "document_type": "cpf",
    "legal_name": "Pereira da Silva",
    "trade_name": null
  },
  "created_at": "2020-07-27T18:25:38Z",
  "created_by": "user:34a071d5-e1d4-4cb0-acf7-ca9b106fec65",
  "customer": {
    "document": "11121744590",
    "document_type": "cpf",
    "legal_name": "Pereira da Silva",
    "trade_name": null
  },
  "discounts": [
    {
      "date": "2020-11-20",
      "value": "0.1"
    }
  ],
  "expiration_date": "2020-12-01",
  "fee": 0,
  "fee_metadata": {
    "billing_exemption_participant": true,
    "fee": 0,
    "max_free": 5,
    "original_fee": 200,
    "remaining_free": 5
  },
  "fine": {
    "date": "2021-01-02",
    "value": "1"
  },
  "id": "172caf21-13de-4baa-9823-a21ac17ba8fa",
  "interest": {
    "date": "2021-01-02",
    "value": "1"
  },
  "invoice_type": "bill_of_exchange",
  "issuance_date": "2020-07-27",
  "limit_date": "2021-02-01",
  "our_number": "63139072468215929006",
  "payer": {
    "document": "11121740790",
    "document_type": "cpf",
    "legal_name": "Pereira da Silva",
    "trade_name": null
  },
  "receiver": null,
  "registered_at": null,
  "settled_at": null,
  "status": "CREATED",
  "writable_line": "19790000056313907246482159290061784560000002100"
}

400 Bad Request

Body

{
  "reason": [
    {
      "error": "is invalid",
      "path": [
        "customer",
        "trade_name"
      ]
    },
    {
      "error": "is invalid",
      "path": [
        "customer",
        "legal_name"
      ]
    }
  ],
  "type": "srn:error:validation"
}

401 Unauthorized

Body

{
  "type": "srn:error:unauthenticated"
}

403 Forbidden

Body

{
  "type": "srn:error:unauthorized"
}

409 Conflict

Body

{
  "type": "srn:error:conflict"
}

422 Unprocessable Entity

Body

{
  "reason": "barcode_payment_invoice_bill_of_exchange is not ena bled on this account",
  "type": "srn:error:product_not_enabled"
}


Última modificação: 14.10.2021