STstarkbank
Boleto

Create Boletos

This is how you create a new list of boletos. You can create up to 100 boletos per request. In case a boleto is paid after its due date and there is fine or interest, its amount will be updated with the paid amount. The same is valid if the boleto is paid with a discount.

post/v2/boleto

Request

  • Base URL
    https://api.starkbank.com
  • URL
    https://api.starkbank.com/v2/boleto
  • Auth
    API key in header Digital-Signature

Request body

amountinteger required

A positive integer that represents the amount in cents to be charged, with a minimum of 200 (R$2.00). Example: 1234 (R$12.34).

citystring required

Customer city name. Example: "São Paulo".

districtstring required

Customer district name. Example: "Itaim Bibi".

namestring required

Customer full name. Example: "Anthony Edward Stark".

stateCodestring required

Customer state code. Example: "SP".

streetLine1string required

Customer street address. Example: "Av. Faria Lima, 1844".

streetLine2string required

Customer street address complement. Example: "CJ 13".

taxIdstring required

Customer CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). Example: 012.345.678-90.

zipCodestring required

Customer zip code. Example: 01500-000.

descriptionsobject[]

List of up to 15 descriptions containing information to help the customer understand why he is being charged. You can add text and amount to create a table or you can just add text. When generating PDFs, if the 'booklet' layout is selected, only the text field of the first description will be considered and it will be used to fill the installment cell in the PDF. Example: [{"text": "Explaining first part of the value", "amount": 20000}, {"text": "More text to explaining something to the customer"}]

discountsobject[]

List of up to 2 discounts specifying the discount percentage and the limit date up to when the discount is valid. Example: [{"percentage": 5, "date": "2020-04-01"}, {"percentage": 3.5, "date": "2020-04-02"}]

duestring date-time

Due date of the boleto. Example: 2020-06-27. The default value is set to two days after creation date.

finenumber float

Percentage of the boleto amount charged if customer pays after the due date. Default value = 2.00 (2%).

interestnumber float

Monthly interest, in percentage, charged if customer pays after the due date. Default value = 1.00 (1%).

overdueLimitstring

Number of days after due date after which the boleto will no longer be payable. 0<=overdueLimit<=59. Default value=59.

receiverNamestring

Name of the credit receiver (Sacador Avalista). If none is informed, workspace owner name will be used. If informed, receiverTaxId must also be informed.

receiverTaxIdstring

Tax ID (CPF/CNPJ) of the credit receiver (Sacador Avalista). If none is informed, workspace owner tax ID will be used. If informed, receiverName must also be informed.

splitsobject[]

Array of Split objects to indicate payment receivers. Example: [{"receiverId": "5742447426535424", "amount": 100}, {"receiverId": "5743243941642240", "amount": 200}]

tagsstring[]

Filter entities that contain the specified tags.

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.