STstarkbank
Dynamic Brcode

Create Dynamic Brcodes

Use this route to create up to 100 new dynamic brcodes at a time.

post/v2/dynamic-brcode

Request

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

Request body

amountinteger required

A non-negative integer that represents the amount in cents to be received. Example: 100 (R$1.00).

displayDescriptionstring

Description to be shown in the payer bank interface. ex: "Payment for service #1234"

expirationinteger

Time in seconds counted from the creation datetime until the brcode expires. After expiration, the brcode cannot be paid anymore. Default value: 3600 (1 hour).

rulesstring[]

List of rules for modifying dynamic brcode behavior. Example: [{"key": "allowedTaxIds", "value": ["012.345.678-90", "45.059.493/0001-73"]}]

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.