Liking cljdoc? Tell your friends :D
Clojure only.
starkbank.utility-payment
When you initialize a UtilityPayment, 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 (conditionally required):
:line[string, default nil]: Number sequence that describes the payment. Either 'line' or 'bar-code' parameters are required. If both are sent, they must match. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062":bar-code[string, default nil]: Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. ex: "34195819600000000621090063571277307144464000"
Parameters (required):
:description[string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
Parameters (optional):
:scheduled[string, default today]: payment scheduled date. ex: ~D[2020-03-25]:tags[list of strings]: list of strings for tagging
Attributes (return-only):
:id[string, default nil]: unique id returned when the payment is created. ex: "5656565656565656":status[string, default nil]: current payment status. ex: "processing" or "success":amount[int, default nil]: amount automatically calculated from line or bar-code. ex: 23456 (= R$ 234.56):fee[integer, default nil]: fee charged when a utility payment is created. ex: 200 (= R$ 2.00):created[string, default nil]: creation datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00"
When you initialize a UtilityPayment, 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 (conditionally required): - `:line` [string, default nil]: Number sequence that describes the payment. Either 'line' or 'bar-code' parameters are required. If both are sent, they must match. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062" - `:bar-code` [string, default nil]: Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. ex: "34195819600000000621090063571277307144464000" ## Parameters (required): - `:description` [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC" ## Parameters (optional): - `:scheduled` [string, default today]: payment scheduled date. ex: ~D[2020-03-25] - `:tags` [list of strings]: list of strings for tagging Attributes (return-only): - `:id` [string, default nil]: unique id returned when the payment is created. ex: "5656565656565656" - `:status` [string, default nil]: current payment status. ex: "processing" or "success" - `:amount` [int, default nil]: amount automatically calculated from line or bar-code. ex: 23456 (= R$ 234.56) - `:fee` [integer, default nil]: fee charged when a utility payment is created. ex: 200 (= R$ 2.00) - `:created` [string, default nil]: creation datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00"
createclj
(create payments)(create payments user)Send a list of UtilityPayment maps for creation in the Stark Bank API
Parameters (required):
payments[list of UtilityPayment maps]: list of UtilityPayment 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 UtilityPayment maps with updated attributes
Send a list of UtilityPayment maps for creation in the Stark Bank API ## Parameters (required): - `payments` [list of UtilityPayment maps]: list of UtilityPayment 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 UtilityPayment maps with updated attributes
deleteclj
(delete id)(delete id user)Delete a UtilityPayment entity previously created in the Stark Bank API
Parameters (required):
id[string]: UtilityPayment 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:
- deleted UtilityPayment with updated attributes
Delete a UtilityPayment entity previously created in the Stark Bank API ## Parameters (required): - `id` [string]: UtilityPayment 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: - deleted UtilityPayment with updated attributes
getclj
(get id)(get id user)Receive a single UtilityPayment map previously created by 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:
- UtilityPayment map with updated attributes
Receive a single UtilityPayment map previously created by 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: - UtilityPayment map with updated attributes
pdfclj
(pdf id)(pdf id user)Receive a single UtilityPayment pdf file generated in the Stark Bank API by passing its id. Only valid for utility payments with "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:
- UtilityPayment pdf file content
Receive a single UtilityPayment pdf file generated in the Stark Bank API by passing its id. Only valid for utility payments with "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: - UtilityPayment pdf file content
queryclj
(query)(query params)(query params user)Receive a stream of UtilityPayment 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 only after specified date. ex: "2020-3-10":before[string, default nil]: date filter for maps created only before specified date. ex: "2020-3-10":tags[list of strings, default nil]: tags to filter retrieved maps. ex: ["tony", "stark"]:ids[list of strings, default nil]: list of ids to filter retrieved maps. ex: ["5656565656565656", "4545454545454545"]:status[string, default nil]: filter for status of retrieved maps. ex: "success":user[Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.
Return:
- stream of UtilityPayment maps with updated attributes
Receive a stream of UtilityPayment 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 only after specified date. ex: "2020-3-10" - `:before` [string, default nil]: date filter for maps created only before specified date. ex: "2020-3-10" - `:tags` [list of strings, default nil]: tags to filter retrieved maps. ex: ["tony", "stark"] - `:ids` [list of strings, default nil]: list of ids to filter retrieved maps. ex: ["5656565656565656", "4545454545454545"] - `:status` [string, default nil]: filter for status of retrieved maps. ex: "success" - `:user` [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - stream of UtilityPayment maps with updated attributes
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close