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.
: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]: 1 to 3 digits of the receiver bank institution in Brazil. ex: "200" 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":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"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]: 1 to 3 digits of the receiver bank institution in Brazil. ex: "200" 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): - `: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 transfers)(create transfers user)Send a list of Transfer maps for creation in the Stark Bank API
transfers [list of Transfer maps]: list of Transfer maps to be created in the API:user [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.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]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - list of Transfer maps with updated attributes
(get id)(get id user)Receive a single Transfer map previously created in the Stark Bank API by passing its id
id [string]: map unique id. ex: "5656565656565656":user [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.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]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - Transfer map with updated attributes
(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.
id [string]: map unique id. ex: "5656565656565656":user [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.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]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - Transfer pdf file content
(query)(query params)(query params user)Receive a stream of Transfer maps previously created in the Stark Bank API
: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]:transaction-ids [list of strings, default nil]: list of transaction IDs linked to the desired transfers. ex: ["5656565656565656", "4545454545454545"]: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]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.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] - `:transaction-ids` [list of strings, default nil]: list of transaction IDs linked to the desired transfers. ex: ["5656565656565656", "4545454545454545"] - `: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]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - stream of Transfer maps with updated attributes
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |