STstarkbank
Verified Transfer

Create Verified Transfers

This route is used to send transfers to receivers you have already verified. You can create up to 100 Verified Transfers in a single request. NOTE:The receiver data (name, taxId, bankCode, branchCode, accountNumber and accountType) is always copied from the Verified Account identified by accountId, so it cannot be sent in the request. NOTE:The Verified Account must not be canceled or failed. Accounts in the "creating", "created", "processing" and "active" statuses are accepted. NOTE:The response carries Transfer objects. The accountId you sent is not echoed back as a field, but every created transfer is tagged with "verified-account/<accountId>".

post/v2/verified-transfer

Request

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

Request body

accountIdstring required

Id of the Verified Account that will receive the money. Example: "5155165527080960"

amountinteger required

A positive integer that represents the amount in cents to be transferred. Must be lower than 10^15. Example: 1000 (R$10.00)

descriptionstring

Optional description to override the default description shown in the bank statement. Must have between 10 and 300 characters. Example: "Payment for service #1234"

displayDescriptionstring

Description to be shown in the receiver bank interface. Max = 300 characters. Example: "Payment for service #1234"

externalIdstring

Unique url-safe ID to prevent duplicate transfers. Max = 170 characters. By default, it blocks transfers of the same amount to the same Verified Account on the same day. Example: "my-external-id"

rulesstring[]

List of up to 3 rules for modifying transfer behavior. Keys are "resendingLimit" (integer from 0 to 10), "isReversalAllowed" (boolean) and "isPartialReversalAllowed" (boolean). Each key can be used only once. Example: [{"key": "resendingLimit", "value": 5}]

scheduledstring date-time

Schedule the transfer for a specific date. Today is the default. A date without a time is scheduled for 07:00 (BRT). Example: "2020-08-14T15:23:26+00:00" or "2020-08-14"

tagsstring[]

Array of up to 100 strings to tag the entity for future queries. Each tag can have up to 100 characters and all tags will be converted to lowercase. Example: ["iron", "suit"]

Response

Successful operation

object required

Changes

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