STstarkbank
Brcode Payment

Create Brcode Payments

Use this route to pay registered brcodes generated at Stark Bank or at other financial institutions using the available balance in your Stark Bank account. NOTE:Initially, the brcode entity amount will be zero because the brcode is processed asynchronously.

post/v2/brcode-payment

Request

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

Request body

brcodestring required

Brcode that describes the payment.

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 required

If the brcode does not provide an amount, this parameter is mandatory, else it is optional. Example: 23456 (R$ 234,56).

rulesstring[]

List of rules for modifying brcodePayment behavior. Example: [{"key": "resendingLimit", "value": 5}]

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.