Create transfers
POST {{baseUrl}}/{{version}}/transfer
You can create transactions to send money to other Stark Bank accounts.
| Parameters | Value Type | Description |
|---|---|---|
| amount | REQUIRED | A positive integer that represents the amount in cents to be transferred. Example: amount=100 (R$1.00). |
| name | REQUIRED | Receiver full name. Example: Joana da Silva |
| taxId | REQUIRED | Receiver CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). Example: 012.345.678-90 |
| bankCode | REQUIRED | Besides informing the receiver bank, this parameter specifies wether this will be a PIX or a TED transfer. If you wish to send a PIX, pass the bank ISPB (8 digits). Example: 20018183 = StarkBank If you wish to send a TED, pass the usual bank code (1 to 3 digits). Example: 341 = Itaú |
| branchCode | REQUIRED | Receiver bank account branch. Use -in case there is a validation digit. Example: 1234-5 |
| accountNumber | REQUIRED | Receiver bank account number. Use -before the validation digit. Example: 876543-2 |
| scheduled | OPTIONAL | Schedule the transfer for a specific date. \nToday is the default. Schedules for today will be accepted until 16:00 (BRT) and will be pushed to next business day afterwards. Example: 2020-08-14 |
| tags | OPTIONAL | Array of strings to tag the entity for future queries. All tags will be converted to lowercase. |
Request Body
{"transfers"=>[{"amount"=>10000, "name"=>"Steve Rogers", "taxId"=>"330.731.970-10", "bankCode"=>"001", "branchCode"=>"1234", "accountNumber"=>"123456-0", "scheduled"=>"2020-11-30", "tags"=>["debts", "food"]}, {"amount"=>20000, "name"=>"Tony Stark", "taxId"=>"845.353.790-92", "bankCode"=>"001", "branchCode"=>"5432", "accountNumber"=>"12345-2", "scheduled"=>"2020-11-29", "tags"=>["tip", "food"]}, {"amount"=>30000, "name"=>"Peter Parker", "taxId"=>"811.439.540-09", "bankCode"=>"18236120", "branchCode"=>"0001", "accountNumber"=>"54321-0", "tags"=>["pix-transfer"]}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"transfers":[{"status":"created","scheduled":"2020-11-30T10:00:00+00:00","updated":"2020-11-23T22:27:13.401041+00:00","tags":["debts","food"],"taxId":"330.731.970-10","transactionIds":[],"bankCode":"001","id":"4714075397292032","fee":200,"name":"Steve Rogers","created":"2020-11-23T22:27:13.401027+00:00","accountNumber":"123456-0","branchCode":"1234","amount":10000},{"status":"created","scheduled":"2020-11-30T10:00:00+00:00","updated":"2020-11-23T22:27:13.401294+00:00","tags":["tip","food"],"taxId":"845.353.790-92","transactionIds":[],"bankCode":"001","id":"5839975304134656","fee":200,"name":"Tony Stark","created":"2020-11-23T22:27:13.401284+00:00","accountNumber":"12345-2","branchCode":"5432","amount":20000},{"status":"created","scheduled":"2020-11-23T22:27:13.332048+00:00","updated":"2020-11-23T22:27:13.401407+00:00","tags":["pix-transfer"],"taxId":"811.439.540-09","transactionIds":[],"bankCode":"18236120","id":"5277025350713344","fee":50,"name":"Peter Parker","created":"2020-11-23T22:27:13.401398+00:00","accountNumber":"54321-0","branchCode":"0001","amount":30000}],"message":"Transfer(s) successfully created"}