Create transfers
POST {{baseUrl}}/{{version}}/transfer
This route is used to send your transfers to their receivers. You can create up to 100 transfers in a single request.
| 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 whether 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. |
| accountType | OPTIONAL | Receiver bank account type. Options are checking, savingsand salary. checkingis the default. This parameter only has effect on Pix Transfers. |
| description | OPTIONAL | Optional description to override default description to be shown in the bank statement. Example: Payment for service #1234 |
| externalId | OPTIONAL | Unique ID to avoid duplicate transfers. Repeated externalIds should cause failures by duplication. By default, it blocks transfers to the same bank account with the same amount on the same day. Example: my-internal-id-123456 |
| rules | OPTIONAL | list of rules for modifying transfer behavior. Example: [ { key: resendingLimit, value: 5 } ] |
Request Body
{"transfers"=>[{"amount"=>10000, "name"=>"Steve Rogers", "taxId"=>"330.731.970-10", "bankCode"=>"001", "branchCode"=>"1234", "accountNumber"=>"123456-0", "accountType"=>"checking", "scheduled"=>"2023-11-30", "externalId"=>"my_external_id", "description"=>"Payment for service #1234", "tags"=>["debts", "food"], "rules"=>[{"key"=>"resendingLimit", "value"=>5}]}, {"amount"=>20000, "name"=>"Tony Stark", "taxId"=>"330.731.970-10", "bankCode"=>"001", "branchCode"=>"1234", "accountNumber"=>"123456-0", "accountType"=>"checking", "scheduled"=>"2023-11-30", "externalId"=>"my_external_id_2", "description"=>"Payment for service #5678", "tags"=>["services", "internet"], "rules"=>[{"key"=>"resendingLimit", "value"=>5}]}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"message":"Transfer(s) successfully created","transfers":[{"accountNumber":"123456-0","accountType":"checking","amount":10000,"bankCode":"001","branchCode":"1234","created":"2023-02-21T19:41:59.418526+00:00","description":"Payment for service #1234","externalId":"my_external_id","fee":0,"id":"6061905001054208","name":"Steve Rogers","rules":[{"key":"resendingLimit","value":5}],"scheduled":"2023-11-30T10:00:00+00:00","status":"created","tags":["debts","food"],"taxId":"330.731.970-10","transactionIds":[],"updated":"2023-02-21T19:41:59.418540+00:00"}]}