Create payment requests
POST {{baseUrl}}/{{version}}/payment-request
Use this route to verify the updated status of boletos generated at Stark Bank according to CIP.
| Parameters | Value Type | Description |
|---|---|---|
| centerId | REQUIRED | Unique ID of the targeted cost center. You can check out the cost center ID directly on its approval section on our Web Banking. Example: 5656565656565656 |
| type | REQUIRED | Payment type. The SDKs will take care of this parameter for you if you use their specialized objects. Examples: transfer, brcode-payment, boleto-payment, utility-payment, etc |
| payment | REQUIRED | JSON specifying the requested payment. The payment JSON is the same as those passed in the requests that create the payments without going through the approval flow (see transfer and boleto payment ). The only exception is that the scheduledparameter cannot be sent on these JSONs, as the PaymentRequest dueparameter already serves this purpose. |
| due | OPTIONAL | Suggested payment date. This parameter may be altered by the controllers of the cost center. Default is today. Example: 2020-08-01 |
| tags | OPTIONAL | Array of strings to tag the entity for future queries. All tags will be converted to lowercase. |
Request Body
{"requests"=>[{"centerId"=>"1234567890123456", "type"=>"transfer", "payment"=>{"amount"=>100000000, "taxId"=>"594.739.480-42", "name"=>"Daenerys Targaryen Stormborn", "bankCode"=>"341", "branchCode"=>"2201", "accountNumber"=>"76543-8"}}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
| `` | null |
RESPONSES
status: OK
{"message":"Payment request(s) successfully created","requests":[{"status":"pending","updated":"2020-11-24T07:50:50.120756+00:00","attachments":[],"tags":[],"centerId":"1234567890123456","actions":[{"pictureUrl":"","name":"Parker's API","action":"requested","type":"project","id":"5644554002759680","email":""},{"pictureUrl":"https://storage.googleapis.com/api-ms-workspace-sbx.appspot.com/pictures/member/5157234329780224?20200806005629","name":"Dalton Felipe de Menezes","action":"required","type":"member","id":"5157234329780224","email":"dalton.menezes@starkbank.com"},{"pictureUrl":"","name":"Matheus Ferraz","action":"required","type":"member","id":"5672009245655040","email":"matheus.ferraz@starkbank.com"},{"pictureUrl":"https://storage.googleapis.com/api-ms-workspace-sbx.appspot.com/pictures/member/5690930589859840?20200808003729","name":"Caio Dottori","action":"required","type":"member","id":"5690930589859840","email":"caio.dottori@starkbank.com"},{"pictureUrl":"","name":"Rafael Stark","action":"required","type":"member","id":"5792156111339520","email":"rafael@starkbank.com"}],"payment":{"name":"Daenerys Targaryen Stormborn","accountNumber":"76543-8","taxId":"594.739.480-42","amount":100000000,"bankCode":"341","branchCode":"2201"},"description":"Daenerys Targaryen Stormborn (594.739.480-42)","created":"2020-11-24T07:50:50.120749+00:00","due":"2020-11-24T04:50:50.080507+00:00","id":"6145679692922880","amount":100000000,"type":"transfer"}]}