Create brcode payments
POST {{baseUrl}}/{{version}}/brcode-payment
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.
| Parameters | Value Type | Description |
|---|---|---|
| brcode | REQUIRED | Brcode that describes the payment. |
| taxId | REQUIRED | Receiver CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). Example: 012.345.678-90 |
| description | REQUIRED | Text to be displayed in your statement. Min lenght = 10. |
| amount | CONDITIONALY REQUIRED | If the brcode does not provide an amount, this parameter is mandatory, else it is optional. Example: 23456 (R$ 234,56) |
| tags | OPTIONAL | Array of strings to tag the entity for future queries. All tags will be converted to lowercase. |
| scheduled | OPTIONAL | Schedule the payment for a specific date. Default value is the current day. |
| rules | OPTIONAL | list of rules for modifying brcodePayment behavior. |
Request Body
{"payments"=>[{"brcode"=>"00020101021226890014br.gov.bcb.pix2567invoice-h.sandbox.starkbank.com/v2/db86835d61274c7799a1f637b2b6f8b652040000530398654040.005802BR5915Stark Bank S.A.6009Sao Paulo62070503***6304FCCE", "taxId"=>"22.653.392/0001-20", "description"=>"BR Code Stark Bank", "rules"=>[{"key"=>"resendingLimit", "value"=>5}]}]}
RESPONSES
status: OK
{"message":"Payment(s) successfully created","payments":[{"status":"creating","scheduled":"2020-11-24T07:21:07.054849+00:00","updated":"2020-11-24T07:21:07.173837+00:00","description":"BR Code Stark Bank","tags":[],"taxId":"22.653.392/0001-20","transactionIds":[],"id":"5942041938755584","fee":50,"name":null,"rules":[{"key":"resendingLimit","value":5}],"created":"2020-11-24T07:21:07.173822+00:00","amount":0,"brcode":"00020101021226890014br.gov.bcb.pix2567invoice-h.sandbox.starkbank.com/v2/db86835d61274c7799a1f637b2b6f8b652040000530398654040.005802BR5915Stark Bank S.A.6009Sao Paulo62070503***6304FCCE","type":"dynamic"}]}