starkbank.boleto-payment

Liking cljdoc? Tell your friends :D

Clojure only.

apply-java-hashmap
create
created-java-payments
delete
get
java-params
java-payments
pdf
query

When you initialize a BoletoPayment, 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):

:tax-id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
: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 boleto 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 BoletoPayment, 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):
  - `:tax-id` [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
  - `: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 boleto 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"

raw docstring

apply-java-hashmap^clj

(apply-java-hashmap x)

source

create^clj

(create payments)

(create payments user)

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

Parameters (required):

payments [list of BoletoPayment maps]: list of BoletoPayment maps to be created in the API

Options:

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

Return:

list of BoletoPayment maps with updated attributes

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

## Parameters (required):
  - `payments` [list of BoletoPayment maps]: list of BoletoPayment maps to be created in the API

## Options:
  - `:user` [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.settings/user has not been set.

## Return:
  - list of BoletoPayment maps with updated attributes

source raw docstring

created-java-payments^clj

source

delete^clj

(delete id)

(delete id user)

Delete a BoletoPayment entity previously created in the Stark Bank API

Parameters (required):

id [string]: BoletoPayment unique id. ex: "5656565656565656"

Options:

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

Return:

deleted BoletoPayment map with updated attributes

Delete a BoletoPayment entity previously created in the Stark Bank API

## Parameters (required):
  - `id` [string]: BoletoPayment unique id. ex: "5656565656565656"

## Options:
  - `:user` [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.settings/user has not been set.

## Return:
  - deleted BoletoPayment map with updated attributes

source raw docstring

get^clj

(get id)

(get id user)

Receive a single BoletoPayment 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.settings/user has not been set.

Return:

BoletoPayment map with updated attributes

Receive a single BoletoPayment 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.settings/user has not been set.

## Return:
  - BoletoPayment map with updated attributes

source raw docstring

java-params^clj

source

java-payments^clj

source

pdf^clj

(pdf id)

(pdf id user)

Receive a single BoletoPayment pdf file generated in the Stark Bank API by passing its id. Only valid for boleto 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.settings/user has not been set.

Return:

BoletoPayment pdf file content

Receive a single BoletoPayment pdf file generated in the Stark Bank API by passing its id.
Only valid for boleto 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.settings/user has not been set.

## Return:
  - BoletoPayment pdf file content

source raw docstring

query^clj

(query)

(query params)

(query params user)

Receive a stream of BoletoPayment 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 null]: list of ids to filter retrieved objects. 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.settings/user has not been set.

Return:

stream of BoletoPayment maps with updated attributes

Receive a stream of BoletoPayment 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 null]: list of ids to filter retrieved objects. 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.settings/user has not been set.

## Return:
  - stream of BoletoPayment maps with updated attributes

source raw docstring