starkbank.transfer — starkbank/sdk 2.3.1

When you initialize a Transfer, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the maps to the Stark Bank API and returns the list of created maps.

Parameters (required):

• :amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
• :name [string]: receiver full name. ex: "Anthony Edward Stark"
• :tax-id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
• :bank-code [string]: code of the receiver bank institution in Brazil. If an ISPB (8 digits) is informed, a PIX transfer will be created, else a TED will be issued. ex: "20018183" or "341"
• :branch-code [string]: receiver bank account branch. Use '-' in case there is a verifier digit. ex: "1357-9"
• :account-number [string]: receiver bank account number. Use '-' before the verifier digit. ex: "876543-2"

Parameters (optional):

• :account-type [string, "checking"]: receiver bank account type. This parameter only has effect on Pix Transfers. ex: "checking", "savings" or "salary"
• :external-id [string, default nil]: url safe string that must be unique among all your transfers. Duplicated external-ids will cause failures. By default, this parameter will block any transfer that repeats amount and receiver information on the same date. ex: "my-internal-id-123456"
• :scheduled [string, default now]: date or datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: "2021-03-11T08:00:00.000000+00:00"
• :tags [list of strings]: list of strings for reference when searching for transfers. ex: ["employees", "monthly"]

Attributes (return-only):

• :id [string, default nil]: unique id returned when the transfer is created. ex: "5656565656565656"
• :fee [integer, default nil]: fee charged when the transfer is created. ex: 200 (= R$ 2.00)
• :status [string, default nil]: current transfer status. ex: "processing" or "success"
• :transaction-ids [list of strings, default nil]: ledger transaction ids linked to this transfer (if there are two, second is the chargeback). ex: ["19827356981273"]
• :created [string, default nil]: creation datetime for the transfer. ex: "2020-03-26T19:32:35.418698+00:00"
• :updated [string, default nil]: latest update datetime for the transfer. ex: "2020-03-26T19:32:35.418698+00:00"

create clj

(create transfers)

(create transfers user)

Send a list of Transfer maps for creation in the Stark Bank API

Parameters (required):

• transfers [list of Transfer maps]: list of Transfer maps to be created in the API

Options:

• :user [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

• list of Transfer maps with updated attributes

created-java-transfers clj

delete clj

(delete id)

(delete id user)

Cancel a single scheduled Transfer entity previously created in the Stark Bank API by passing its id

Parameters (required):

• id [string]: entity unique id. ex: "5656565656565656"

Options:

• :user [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

• canceled Transfer entity with updated attributes

get clj

(get id)

(get id user)

Receive a single Transfer map previously created in the Stark Bank API by passing its id

Parameters (required):

• id [string]: map unique id. ex: "5656565656565656"

Options:

• :user [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

• Transfer map with updated attributes

java-params clj

java-transfers clj

pdf clj

(pdf id)

(pdf id user)

Receive a single Transfer pdf receipt file generated in the Stark Bank API by passing its id. Only valid for transfers with "processing" or "success" status.

Parameters (required):

• id [string]: map unique id. ex: "5656565656565656"

Options:

• :user [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

• Transfer pdf file content

query clj

(query)

(query params)

(query params user)

Receive a stream of Transfer maps previously created in the Stark Bank API

Options:

• :limit [integer, default nil]: maximum number of maps to be retrieved. Unlimited if nil. ex: 35
• :after [string, default nil]: date filter for maps created or updated only after specified date. ex: ~D[2020-03-25]
• :before [string, default nil]: date filter for maps created or updated only before specified date. ex: ~D[2020-03-25]
• :ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
• :transaction-ids [list of strings, default nil]: list of transaction IDs linked to the desired transfers. ex: ["5656565656565656", "4545454545454545"]
• :tax-id [string, default nil]: filter for transfers sent to the specified tax ID. ex: "012.345.678-90"
• :status [string, default nil]: filter for status of retrieved maps. ex: "processing" or "success"
• :sort [string, default "-created"]: sort order considered in response. Valid options are "created", "-created", "updated" or "-updated".
• :tags [list of strings, default nil]: tags to filter retrieved maps. ex: ["tony", "stark"]
• :user [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

• stream of Transfer maps with updated attributes