Create boleto payments
POST {{baseUrl}}/{{version}}/boleto-payment
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.
| Parameters | Value Type | Description |
|---|---|---|
| line | CONDITIONALY REQUIRED | Number sequence that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. |
| barCode | CONDITIONALY REQUIRED | Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. |
| 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. |
| 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. |
| amount | OPTIONAL | Amount to be paid. If none is informed, the current boleto value will be used. Example: 23456 (= R$ 234.56) |
Request Body
{"payments"=>[{"taxId"=>"02.657.507/0001-48", "description"=>"Payment for killing white walkers", "line"=>"34191.09008 69704.737308 71444.640008 1 83690000000208", "tags"=>["little girl", "no one"]}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"message":"Boleto Payment(s) successfully created","payments":[{"status":"created","scheduled":"2020-09-01T15:12:12.770273+00:00","description":"Payment for killing white walkers","tags":["little girl","no one"],"taxId":"02.657.507/0001-48","line":"34191.09008 69704.737308 71444.640008 1 83690000000208","id":"5686448233644032","fee":0,"created":"2020-09-01T15:12:12.949561+00:00","barCode":"34191836900000002081090069704737307144464000","amount":208}]}