starkbank.boleto

Liking cljdoc? Tell your friends :D

Clojure only.

apply-java-hashmap
create
created-java-boletos
delete
get
java-boletos
java-hashmap-to-map
java-params
pdf
query

When you initialize a Boleto map, the entity will not be automatically sent to 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]: Boleto value in cents. Minimum amount = 200 (R$2,00). ex: 1234 (= R$ 12.34)
:name [string]: payer full name. ex: "Anthony Edward Stark"
:tax-id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
:street-line-1 [string]: payer main address. ex: Av. Paulista, 200
:street-line-2 [string]: payer address complement. ex: Apto. 123
:district [string]: payer address district / neighbourhood. ex: Bela Vista
:city [string]: payer address city. ex: Rio de Janeiro
:state-code [string]: payer address state. ex: GO
:zip-code [string]: payer address zip code. ex: 01311-200

Parameters (optional):

:due [string, default today + 2 days]: Boleto due date in ISO format. ex: 2020-04-30
:fine [float, default 0.0]: Boleto fine for overdue payment in %. ex: 2.5
:interest [float, default 0.0]: Boleto monthly interest for overdue payment in %. ex: 5.2
:overdue-limit [integer, default 59]: limit in days for payment after due date. ex: 7 (max: 59)
:descriptions [list of maps, default nil]: list of maps with :text (string) and :amount (int, optional) pairs
:discounts [list of maps, default nil]: list of maps with :percentage (float) and :date (string) pairs
:tags [list of strings]: list of strings for tagging

Attributes (return-only):

:id [string, default nil]: unique id returned when the Boleto is created. ex: "5656565656565656"
:fee [integer, default nil]: fee charged when the Boleto is paid. ex: 200 (= R$ 2.00)
:line [string, default nil]: generated Boleto line for payment. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062"
:bar-code [string, default nil]: generated Boleto bar-code for payment. ex: "34195819600000000621090063571277307144464000"
:status [string, default nil]: current Boleto status. ex: "registered" or "paid"
:created [string, default nil]: creation datetime for the Boleto. ex: "2020-03-26T19:32:35.418698+00:00"

When you initialize a Boleto map, the entity will not be automatically
sent to 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]: Boleto value in cents. Minimum amount = 200 (R$2,00). ex: 1234 (= R$ 12.34)
  - `:name` [string]: payer full name. ex: "Anthony Edward Stark"
  - `:tax-id` [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
  - `:street-line-1` [string]: payer main address. ex: Av. Paulista, 200
  - `:street-line-2` [string]: payer address complement. ex: Apto. 123
  - `:district` [string]: payer address district / neighbourhood. ex: Bela Vista
  - `:city` [string]: payer address city. ex: Rio de Janeiro
  - `:state-code` [string]: payer address state. ex: GO
  - `:zip-code` [string]: payer address zip code. ex: 01311-200

## Parameters (optional):
  - `:due` [string, default today + 2 days]: Boleto due date in ISO format. ex: 2020-04-30
  - `:fine` [float, default 0.0]: Boleto fine for overdue payment in %. ex: 2.5
  - `:interest` [float, default 0.0]: Boleto monthly interest for overdue payment in %. ex: 5.2
  - `:overdue-limit` [integer, default 59]: limit in days for payment after due date. ex: 7 (max: 59)
  - `:descriptions` [list of maps, default nil]: list of maps with :text (string) and :amount (int, optional) pairs
  - `:discounts` [list of maps, default nil]: list of maps with :percentage (float) and :date (string) pairs
  - `:tags` [list of strings]: list of strings for tagging

## Attributes (return-only):
  - `:id` [string, default nil]: unique id returned when the Boleto is created. ex: "5656565656565656"
  - `:fee` [integer, default nil]: fee charged when the Boleto is paid. ex: 200 (= R$ 2.00)
  - `:line` [string, default nil]: generated Boleto line for payment. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062"
  - `:bar-code` [string, default nil]: generated Boleto bar-code for payment. ex: "34195819600000000621090063571277307144464000"
  - `:status` [string, default nil]: current Boleto status. ex: "registered" or "paid"
  - `:created` [string, default nil]: creation datetime for the Boleto. ex: "2020-03-26T19:32:35.418698+00:00"

raw docstring

apply-java-hashmap^clj

(apply-java-hashmap x)

source

create^clj

(create boletos)

(create boletos user)

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

Parameters (required):

boletos [list of Boleto maps]: list of Boleto 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 Boleto maps with updated attributes

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

## Parameters (required):
  - `boletos` [list of Boleto maps]: list of Boleto 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 Boleto maps with updated attributes

source raw docstring

created-java-boletos^clj

source

delete^clj

(delete id)

(delete id user)

Delete a list of Boleto entities previously created in the Stark Bank API

Parameters (required):

id [string]: Boleto 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 Boleto map with updated attributes

Delete a list of Boleto entities previously created in the Stark Bank API

## Parameters (required):
  - `id` [string]: Boleto 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 Boleto map with updated attributes

source raw docstring

get^clj

(get id)

(get id user)

Receive a single Boleto 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:

Boleto map with updated attributes

Receive a single Boleto 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:
  - Boleto map with updated attributes

source raw docstring

java-boletos^clj

source

java-hashmap-to-map^clj

(java-hashmap-to-map x)

source

java-params^clj

source

pdf^clj

(pdf id)

(pdf id user)

Receive a single Boleto pdf file generated 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:

Boleto pdf file content

Receive a single Boleto pdf file generated 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:
  - Boleto pdf file content

source raw docstring

query^clj

(query)

(query params)

(query params user)

Receive a stream of Boleto 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"
:status [string, default nil]: filter for status of retrieved maps. ex: "paid" or "registered"
: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"]
:user [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.

Return:

stream of Boleto maps with updated attributes

Receive a stream of Boleto 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"
  - `:status` [string, default nil]: filter for status of retrieved maps. ex: "paid" or "registered"
  - `: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"]
  - `:user` [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.

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

source raw docstring