STstarkbank
Boleto Payment

Create Boleto Payments

Use this route to pay registered boletos generated at Stark Bank or at other financial institutions using the available balance in your Stark Bank account.

post/v2/boleto-payment

Request

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

Request body

descriptionstring required

Text to be displayed in your statement. Min length = 10.

taxIdstring required

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

amountinteger

Amount to be paid. If none is informed, the current boleto value will be used. Example: 23456 (= R$ 234.56)

barCodestring required

Bar code number that describes the payment. Either "line" or "barCode" parameters are required. If both are sent, they must match.

linestring required

Number sequence that describes the payment. Either "line" or "barCode" parameters are required. If both are sent, they must match.

scheduledstring date-time

Schedule the payment for a specific date. Default value is the current day.

tagsstring[]

Array of strings to tag the entity for future queries. All tags will be converted to lowercase.

Response

Successful operation

object required

Changes

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