STstarkbank
Transfer

Create Transfers

This route is used to send your transfers to their receivers. You can create up to 100 transfers in a single request.

post/v2/transfer

Request

  • Base URL
    https://api.starkbank.com
  • URL
    https://api.starkbank.com/v2/transfer
  • Auth
    API key in header Digital-Signature

Request body

accountNumberstring required

Receiver bank account number. Use "-" before the validation digit. Example: 876543-2.

amountinteger required

A positive integer that represents the amount in cents to be transferred. Example: 100 (R$1.00)

bankCodestring 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: 665 = Stark

branchCodestring required

Receiver bank account branch. Use "-" in case there is a validation digit. Example: 1234-5

namestring required

Receiver full name. Example: "Joana da Silva"

taxIdstring required

Receiver CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). Example: 012.345.678-90

accountTypestring

Receiver bank account type. Options are "checking", "payment", "savings" and "salary". "checking" is the default. This parameter only has effect on Pix Transfers.

descriptionstring

Optional description to override default description to be shown in the bank statement. Example: "Payment for service #1234"

displayDescriptionstring

Description to be shown in the receiver bank interface. ex: "Payment for service #1234"

externalIdstring

Unique ID to prevent 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"

rulesstring[]

List of rules for modifying transfer behavior. Example: [{"key": "resendingLimit", "value": 5}]

scheduledstring date-time

Schedule the transfer for a specific date. Today is the default. Ted Transfer's schedules for today will be accepted until 16:00 (BRT) and will be pushed to the next business day afterwards. Pix Transfers are available 24/7 and can be scheduled for any date and time. Example: "2020-08-14T15:23:26+00:00" or "2020-08-14"

tagsstring[]

Array of strings to tag the entity for future queries. All tags will be converted to lowercase.

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.