Create utility payments
POST {{baseUrl}}/{{version}}/utility-payment
Use this route to pay utility bills 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. |
| 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. |
Request Body
{"payments"=>[{"description"=>"Electricity for the Long Night", "line"=>"83660000001 9 98480138007 7 41190025511 7 00010601813 8", "barCode"=>"83660000001984801380074119002551100010601813", "scheduled"=>"2020-09-25", "tags"=>["Energy", "Winterfell"]}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"message":"Utility payment(s) successfully created","payments":[{"status":"created","scheduled":"2020-09-25T15:00:00+00:00","updated":"2020-09-01T16:59:46.271372+00:00","description":"Electricity for the Long Night","tags":["energy","winterfell"],"line":"83660000001 9 98480138007 7 41190025511 7 00010601813 8","id":"5123150740193280","fee":0,"created":"2020-09-01T16:59:46.271363+00:00","barCode":"83660000001984801380074119002551100010601813","amount":19848,"type":"utility","transactionIds":[]}]}