The Balance map displays the current balance of the workspace, which is the result of the sum of all transactions within this workspace. The balance is never generated by the user, but it can be retrieved to see the information available.
:id
[string, default nil]: unique id returned when Balance is created. ex: "5656565656565656":amount
[integer, default nil]: current balance amount of the workspace in cents. ex: 200 (= R$ 2.00):currency
[string, default nil]: currency of the current workspace. Expect others to be added eventually. ex: "BRL":updated
[string, default nil]: update datetime for the balance. ex: "2020-03-26T19:32:35.418698+00:00"The Balance map displays the current balance of the workspace, which is the result of the sum of all transactions within this workspace. The balance is never generated by the user, but it can be retrieved to see the information available. ## Attributes (return-only): - `:id` [string, default nil]: unique id returned when Balance is created. ex: "5656565656565656" - `:amount` [integer, default nil]: current balance amount of the workspace in cents. ex: 200 (= R$ 2.00) - `:currency` [string, default nil]: currency of the current workspace. Expect others to be added eventually. ex: "BRL" - `:updated` [string, default nil]: update datetime for the balance. 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.
: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: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):receiver-name
[string]: receiver (Sacador Avalista) full name. ex: "Anthony Edward Stark":receiver-tax-id
[string]: receiver (Sacador Avalista) tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80":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:id
[string, default nil]: unique id returned when the Boleto is created. ex: "5656565656565656":our-number
[string, default nil]: Reference number registered at the settlement bank. ex: "10131474":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":transaction-ids
[list of strings, default nil]: ledger transaction ids linked to this boleto. ex: ["19827356981273"]: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) - `:receiver-name` [string]: receiver (Sacador Avalista) full name. ex: "Anthony Edward Stark" - `:receiver-tax-id` [string]: receiver (Sacador Avalista) tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80" - `: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" - `:our-number` [string, default nil]: Reference number registered at the settlement bank. ex: "10131474" - `: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" - `:transaction-ids` [list of strings, default nil]: ledger transaction ids linked to this boleto. ex: ["19827356981273"] - `:created` [string, default nil]: creation datetime for the Boleto. ex: "2020-03-26T19:32:35.418698+00:00"
When you initialize a BoletoHolmes, 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.
:boleto-id
[string]: investigated boleto entity ID. ex: "5656565656565656":tags
[list of strings]: list of strings for tagging:id
[string, default nil]: unique id returned when the holmes is created. ex: "5656565656565656":status
[string, default nil]: current holmes status. ex: "solving" or "solved":result
[string, default nil]: result of boleto status investigation. ex: "paid" or "cancelled":updated
[string, default nil]: latest update datetime for the holmes. ex: "2020-03-26T19:32:35.418698+00:00":created
[string, default nil]: creation datetime for the holmes. ex: "2020-03-26T19:32:35.418698+00:00"When you initialize a BoletoHolmes, 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): - `:boleto-id` [string]: investigated boleto entity ID. ex: "5656565656565656" ## Parameters (optional): - `:tags` [list of strings]: list of strings for tagging ## Attributes (return-only): - `:id` [string, default nil]: unique id returned when the holmes is created. ex: "5656565656565656" - `:status` [string, default nil]: current holmes status. ex: "solving" or "solved" - `:result` [string, default nil]: result of boleto status investigation. ex: "paid" or "cancelled" - `:updated` [string, default nil]: latest update datetime for the holmes. ex: "2020-03-26T19:32:35.418698+00:00" - `:created` [string, default nil]: creation datetime for the holmes. 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.
: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":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":scheduled
[string, default today]: payment scheduled date. ex: ~D[2020-03-25]:tags
[list of strings]: list of strings for tagging: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
[integer, 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` [integer, 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 BrcodePayment, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects.
:brcode
[string]: String loaded directly from the QRCode or copied from the invoice. ex: "00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A":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":amount
[integer, default nil]: amount automatically calculated from line or barCode. ex: 23456 (= R$ 234.56):scheduled
[string, default now]: payment scheduled date or datetime. ex: "2020-11-25T17:59:26.249976+00:00":tags
[list of strings, default nil]: list of strings for tagging:id
[string, default nil]: unique id returned when payment is created. ex: "5656565656565656":status
[string, default nil]: current payment status. ex: "success" or "failed":type
[string, default nil]: brcode type. ex: "static" or "dynamic":fee
[integer, default nil]: fee charged when the brcode payment is created. ex: 200 (= R$ 2.00):transaction-ids
[list of strings, default nil]: ledger transaction ids linked to this boleto. ex: ["19827356981273"]:updated
[string, default nil]: latest update datetime for the payment. ex: "2020-11-25T17:59:26.249976+00:00":created
[string, default nil]: creation datetime for the payment. ex: "2020-11-25T17:59:26.249976+00:00"When you initialize a BrcodePayment, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects. ## Parameters (required): - `:brcode` [string]: String loaded directly from the QRCode or copied from the invoice. ex: "00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A" - `: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): - `:amount` [integer, default nil]: amount automatically calculated from line or barCode. ex: 23456 (= R$ 234.56) - `:scheduled` [string, default now]: payment scheduled date or datetime. ex: "2020-11-25T17:59:26.249976+00:00" - `:tags` [list of strings, default nil]: list of strings for tagging ## Attributes (return-only): - `:id` [string, default nil]: unique id returned when payment is created. ex: "5656565656565656" - `:status` [string, default nil]: current payment status. ex: "success" or "failed" - `:type` [string, default nil]: brcode type. ex: "static" or "dynamic" - `:fee` [integer, default nil]: fee charged when the brcode payment is created. ex: 200 (= R$ 2.00) - `:transaction-ids` [list of strings, default nil]: ledger transaction ids linked to this boleto. ex: ["19827356981273"] - `:updated` [string, default nil]: latest update datetime for the payment. ex: "2020-11-25T17:59:26.249976+00:00" - `:created` [string, default nil]: creation datetime for the payment. ex: "2020-11-25T17:59:26.249976+00:00"
DEPRECATED A BrcodePreview is used to get information from a BR Code you received to check the informations before the payment.
:id
[string]: BrcodePreview object unique id and PIX key itself. ex: "tony@starkbank.com", "722.461.430-04", "20.018.183/0001-80", "+5511988887777", "b6295ee1-f054-47d1-9e90-ee57b74f60d9":status
[string]: Payment status. ex: "active", "paid", "canceled" or "unknown":name
[string]: Payment receiver name. ex: "Tony Stark":tax-id
[string]: Payment receiver tax ID. ex: "012.345.678-90":bank-code
[string]: Payment receiver bank code. ex: "20018183":branch-code
[string]: Payment receiver branch code. ex: "0001":account-number
[string]: Payment receiver account number. ex: "1234567":account-type
[string]: Payment receiver account type. ex: "checking":allow-change
[bool]: If True, the payment is able to receive amounts that are diferent from the nominal one. ex: True or False:amount
[integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23):reconciliation-id
[string]: Reconciliation ID linked to this payment. ex: "tx-id", "payment-123"DEPRECATED A BrcodePreview is used to get information from a BR Code you received to check the informations before the payment. ## Parameters (required): - `:id` [string]: BrcodePreview object unique id and PIX key itself. ex: "tony@starkbank.com", "722.461.430-04", "20.018.183/0001-80", "+5511988887777", "b6295ee1-f054-47d1-9e90-ee57b74f60d9" ## Attributes (return-only): - `:status` [string]: Payment status. ex: "active", "paid", "canceled" or "unknown" - `:name` [string]: Payment receiver name. ex: "Tony Stark" - `:tax-id` [string]: Payment receiver tax ID. ex: "012.345.678-90" - `:bank-code` [string]: Payment receiver bank code. ex: "20018183" - `:branch-code` [string]: Payment receiver branch code. ex: "0001" - `:account-number` [string]: Payment receiver account number. ex: "1234567" - `:account-type` [string]: Payment receiver account type. ex: "checking" - `:allow-change` [bool]: If True, the payment is able to receive amounts that are diferent from the nominal one. ex: True or False - `:amount` [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23) - `:reconciliation-id` [string]: Reconciliation ID linked to this payment. ex: "tx-id", "payment-123"
SDK to facilitate Clojure integrations with the StarkBank API.
SDK to facilitate Clojure integrations with the StarkBank API.
No vars found in this namespace.
When you initialize a DarfPayment, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects.
:description
[string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC":revenue-code
[string]: 4-digit tax code assigned by Federal Revenue. ex: "5948":tax-id
[string]: tax id (formatted or unformatted) of the payer. ex: "12.345.678/0001-95":competence
[string]: competence month of the service. ex: "2021-4-30":nominal-amount
[long]: amount due in cents without fee or interest. ex: 23456 (= R$ 234.56):fine-amount
[long]: fixed amount due in cents for fines. ex: 234 (= R$ 2.34):interest-amount
[long]: amount due in cents for interest. ex: 456 (= R$ 4.56):due
[string]: due date for payment. ex: "2021-5-17":reference-number
[string]: number assigned to the region of the tax. ex: "08.1.17.00-4":scheduled
[string, default today]: payment scheduled date. ex: "2020-03-25":tags
[list of strings]: list of strings for taggingAttributes (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
[integer, 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):updated
[string, default nil]: latest update datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00":created
[string, default nil]: creation datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00"When you initialize a DarfPayment, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects. ## Parameters (required): - `:description` [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC" - `:revenue-code` [string]: 4-digit tax code assigned by Federal Revenue. ex: "5948" - `:tax-id` [string]: tax id (formatted or unformatted) of the payer. ex: "12.345.678/0001-95" - `:competence` [string]: competence month of the service. ex: "2021-4-30" - `:nominal-amount` [long]: amount due in cents without fee or interest. ex: 23456 (= R$ 234.56) - `:fine-amount` [long]: fixed amount due in cents for fines. ex: 234 (= R$ 2.34) - `:interest-amount` [long]: amount due in cents for interest. ex: 456 (= R$ 4.56) - `:due` [string]: due date for payment. ex: "2021-5-17" ## Parameters (optional): - `:reference-number` [string]: number assigned to the region of the tax. ex: "08.1.17.00-4" - `:scheduled` [string, default today]: payment scheduled date. ex: "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` [integer, 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) - `:updated` [string, default nil]: latest update datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00" - `:created` [string, default nil]: creation datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00"
Deposits represent non-reconciled cash-ins received by your account from external transfers or payments
:id
[string]: unique id associated with a Deposit when it is created. ex: "5656565656565656":name
[string]: payer name. ex: "Iron Bank S.A.":tax-id
[string]: payer tax ID (CPF or CNPJ). ex: "012.345.678-90" or "20.018.183/0001-80":bank-code
[string]: payer bank code in Brazil. ex: "20018183" or "341":branch-code
[string]: payer bank account branch. ex: "1357-9":account-number
[string]: payer bank account number. ex: "876543-2":amount
[integer]: Deposit value in cents. ex: 1234 (= R$ 12.34):type
[string]: type of settlement that originated the deposit. ex: "pix" or "ted":status
[string]: current Deposit status. ex: "created":tags
[list of strings]: list of strings that are tagging the deposit. ex: ["reconciliationId", "taxId"]:fee
[integer]: fee charged when a deposit is created. ex: 50 (= R$ 0.50):transaction-ids
[list of strings]: ledger transaction ids linked to this deposit (if there are more than one, all but first are reversals). ex: ["19827356981273"]:created
[string]: creation datetime for the Deposit. ex: "2020-03-10 10:30:00.000":updated
[string]: latest update datetime for the Deposit. ex: "2020-03-10 10:30:00.000"Deposits represent non-reconciled cash-ins received by your account from external transfers or payments ## Parameters (required): - `:id` [string]: unique id associated with a Deposit when it is created. ex: "5656565656565656" - `:name` [string]: payer name. ex: "Iron Bank S.A." - `:tax-id` [string]: payer tax ID (CPF or CNPJ). ex: "012.345.678-90" or "20.018.183/0001-80" - `:bank-code` [string]: payer bank code in Brazil. ex: "20018183" or "341" - `:branch-code` [string]: payer bank account branch. ex: "1357-9" - `:account-number` [string]: payer bank account number. ex: "876543-2" - `:amount` [integer]: Deposit value in cents. ex: 1234 (= R$ 12.34) - `:type` [string]: type of settlement that originated the deposit. ex: "pix" or "ted" - `:status` [string]: current Deposit status. ex: "created" - `:tags` [list of strings]: list of strings that are tagging the deposit. ex: ["reconciliationId", "taxId"] - `:fee` [integer]: fee charged when a deposit is created. ex: 50 (= R$ 0.50) - `:transaction-ids` [list of strings]: ledger transaction ids linked to this deposit (if there are more than one, all but first are reversals). ex: ["19827356981273"] - `:created` [string]: creation datetime for the Deposit. ex: "2020-03-10 10:30:00.000" - `:updated` [string]: latest update datetime for the Deposit. ex: "2020-03-10 10:30:00.000"
DictKey represents a PIX key registered in Bacen's DICT system.
:id
[string, default nil]: DictKey object unique id and PIX key itself. ex: "tony@starkbank.com", "722.461.430-04", "20.018.183/0001-80", "+5511988887777", "b6295ee1-f054-47d1-9e90-ee57b74f60d9":type
[string, default nil]: PIX key type. ex: "email", "cpf", "cnpj", "phone" or "evp":name
[string, default nil]: account owner full name. ex: "Tony Stark":owner-type
[string, default nil]: PIX key owner type. ex "naturalPerson" or "legalPerson":bank-name
[string, default nil]: bank name associated with the DICT key. ex: "Stark Bank":ispb
[string, default nil]: ISPB code used for transactions. ex: "20018183":branch-code
[string, default nil]: bank account branch code associated with the PIX key. ex: "9585":account-number
[string, default nil]: bank account number associated with the PIX key. ex: "9828282578010513":account-type
[string, default nil]: bank account type associated with the PIX key. ex: "checking", "saving", "salary" or "payment":status
[string, default nil]: current PIX key status. ex: "created", "registered", "canceled" or "failed":account-created
[string, default nil]: creation datetime of the bank account associated with the PIX key. ex: "2020-11-05T14:55:08.812665+00:00":owned
[string, default nil]: datetime since when the current owner hold this PIX key. ex : "2020-11-05T14:55:08.812665+00:00":created
[string, default nil]: creation datetime for the PIX key. ex: "2020-11-05T14:55:08.812665+00:00"DictKey represents a PIX key registered in Bacen's DICT system. ## Parameters (optional): - `:id` [string, default nil]: DictKey object unique id and PIX key itself. ex: "tony@starkbank.com", "722.461.430-04", "20.018.183/0001-80", "+5511988887777", "b6295ee1-f054-47d1-9e90-ee57b74f60d9" ## Attributes (return-only): - `:type` [string, default nil]: PIX key type. ex: "email", "cpf", "cnpj", "phone" or "evp" - `:name` [string, default nil]: account owner full name. ex: "Tony Stark" - `:tax-id [string, default nil]: tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80" - `:owner-type` [string, default nil]: PIX key owner type. ex "naturalPerson" or "legalPerson" - `:bank-name` [string, default nil]: bank name associated with the DICT key. ex: "Stark Bank" - `:ispb` [string, default nil]: ISPB code used for transactions. ex: "20018183" - `:branch-code` [string, default nil]: bank account branch code associated with the PIX key. ex: "9585" - `:account-number` [string, default nil]: bank account number associated with the PIX key. ex: "9828282578010513" - `:account-type` [string, default nil]: bank account type associated with the PIX key. ex: "checking", "saving", "salary" or "payment" - `:status` [string, default nil]: current PIX key status. ex: "created", "registered", "canceled" or "failed" - `:account-created` [string, default nil]: creation datetime of the bank account associated with the PIX key. ex: "2020-11-05T14:55:08.812665+00:00" - `:owned` [string, default nil]: datetime since when the current owner hold this PIX key. ex : "2020-11-05T14:55:08.812665+00:00" - `:created` [string, default nil]: creation datetime for the PIX key. ex: "2020-11-05T14:55:08.812665+00:00"
An Event is the notification received from the subscription to the Webhook. Events cannot be created, but may be retrieved from the Stark Bank API to list all generated updates on entities.
:id
[string]: unique id returned when the event is created. ex: "5656565656565656":log
[Log]: a Log map from one of the subscribed services (Transfer.Log, Boleto.Log, BoletoPayment.log, DarfPayment.log, TaxPayment.Log or UtilityPayment.Log):created
[string]: creation datetime for the notification event. ex: "2020-03-26T19:32:35.418698+00:00":is-delivered
[bool]: true if the event has been successfully delivered to the user url. ex: false:workspace-id
[string]: ID of the Workspace that generated this event. Mostly used when multiple Workspaces have Webhooks registered to the same endpoint. ex: "4545454545454545":subscription
[string]: service that triggered this event. ex: "transfer", "utility-payment"An Event is the notification received from the subscription to the Webhook. Events cannot be created, but may be retrieved from the Stark Bank API to list all generated updates on entities. ## Attributes: - `:id` [string]: unique id returned when the event is created. ex: "5656565656565656" - `:log` [Log]: a Log map from one of the subscribed services (Transfer.Log, Boleto.Log, BoletoPayment.log, DarfPayment.log, TaxPayment.Log or UtilityPayment.Log) - `:created` [string]: creation datetime for the notification event. ex: "2020-03-26T19:32:35.418698+00:00" - `:is-delivered` [bool]: true if the event has been successfully delivered to the user url. ex: false - `:workspace-id` [string]: ID of the Workspace that generated this event. Mostly used when multiple Workspaces have Webhooks registered to the same endpoint. ex: "4545454545454545" - `:subscription` [string]: service that triggered this event. ex: "transfer", "utility-payment"
This resource is used to get information on the institutions that are recognized by the Brazilian Central Bank. Besides the display name and full name, they also include the STR code (used for TEDs) and the SPI Code (used for Pix) for the institutions. Either of these codes may be empty if the institution is not registered on that Central Bank service.
:display-name
[string]: short version of the institution name that should be displayed to end users. ex: "Stark Bank":name
[string]: full version of the institution name. ex: "Stark Bank S.A.":spi-code
[string]: SPI code used to identify the institution on Pix transactions. ex: "20018183":str-code
[string]: STR code used to identify the institution on TED transactions. ex: "123"This resource is used to get information on the institutions that are recognized by the Brazilian Central Bank. Besides the display name and full name, they also include the STR code (used for TEDs) and the SPI Code (used for Pix) for the institutions. Either of these codes may be empty if the institution is not registered on that Central Bank service. ## Parameters: - `:display-name` [string]: short version of the institution name that should be displayed to end users. ex: "Stark Bank" - `:name` [string]: full version of the institution name. ex: "Stark Bank S.A." - `:spi-code` [string]: SPI code used to identify the institution on Pix transactions. ex: "20018183" - `:str-code` [string]: STR code used to identify the institution on TED transactions. ex: "123"
When you initialize an Invoice 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. To create scheduled Invoices, which will display the discount, interest, etc. on the final users banking interface, use dates instead of datetimes on the "due" and "discounts" fields.
:amount
[integer]: Invoice value in cents. Minimum amount = 0 (any value will be accepted). ex: 1234 (= R$ 12.34):name
[string]: payer name. ex: "Iron Bank S.A.":tax-id
[string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80":due
[string, default now + 2 days]: Invoice due date in ISO format. ex: "2020-11-27T01:24:01.665-00:00":expiration
[integer, default 5097600 (59 days)]: time interval in seconds between due date and expiration date. ex 123456789:fine
[float, default 2.0]: Invoice fine for overdue payment in %. ex: 2.5:interest
[float, default 1.0]: Invoice monthly interest for overdue payment in %. ex: 5.2:discounts
[list of maps, default nil]: list of maps with :percentage (float) and :due (string) pairs:tags
[list of strings, default nil]: list of strings for tagging:descriptions
[list of maps, default nil]: list of maps with :key (string) and :value (string) pairs:fee
[integer, default nil]: fee charged by this Invoice. ex: 65 (= R$ 0.65):pdf
[string, default nil]: public Invoice PDF URL. ex: "https://invoice.starkbank.com/pdf/d454fa4e524441c1b0c1a729457ed9d8":link
[string, default nil]: public Invoice webpage URL. ex: "https://my-workspace.sandbox.starkbank.com/invoicelink/d454fa4e524441c1b0c1a729457ed9d8":nominal-amount
[integer, default nil]: Invoice emission value in cents (will change if invoice is updated, but not if it's paid). ex: 400000:fine-amount
[integer, default nil]: Invoice fine value calculated over nominal-amount. ex: 20000:interest-amount
[integer, default nil]: Invoice interest value calculated over nominal-amount. ex: 10000:discount-amount
[integer, default nil]: Invoice discount value calculated over nominal-amount. ex: 3000:transaction-ids
[list of strings]: ledger transaction ids linked to this invoice (if there are more than one, all but first are reversals). ex: ["19827356981273"]:id
[string, default nil]: unique id returned when the Invoice is created. ex: "5656565656565656":brcode
[string, default nil]: BR Code for the Invoice payment. ex: "00020101021226800014br.gov.bcb.pix2558invoice.starkbank.com/f5333103-3279-4db2-8389-5efe335ba93d5204000053039865802BR5913Arya Stark6009Sao Paulo6220051656565656565656566304A9A0":status
[string, default nil]: current Invoice status. ex: "registered" or "paid":created
[string, default nil]: creation datetime for the Invoice. ex: "2020-03-26T19:32:35.418698+00:00":updated
[string, default nil]: latest update datetime for the Invoice. ex: "2020-03-26T19:32:35.418698+00:00"When you initialize an Invoice 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. To create scheduled Invoices, which will display the discount, interest, etc. on the final users banking interface, use dates instead of datetimes on the "due" and "discounts" fields. ## Parameters (required): - `:amount` [integer]: Invoice value in cents. Minimum amount = 0 (any value will be accepted). ex: 1234 (= R$ 12.34) - `:name` [string]: payer name. ex: "Iron Bank S.A." - `:tax-id` [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80" ## Parameters (optional): - `:due` [string, default now + 2 days]: Invoice due date in ISO format. ex: "2020-11-27T01:24:01.665-00:00" - `:expiration` [integer, default 5097600 (59 days)]: time interval in seconds between due date and expiration date. ex 123456789 - `:fine` [float, default 2.0]: Invoice fine for overdue payment in %. ex: 2.5 - `:interest` [float, default 1.0]: Invoice monthly interest for overdue payment in %. ex: 5.2 - `:discounts` [list of maps, default nil]: list of maps with :percentage (float) and :due (string) pairs - `:tags` [list of strings, default nil]: list of strings for tagging - `:descriptions` [list of maps, default nil]: list of maps with :key (string) and :value (string) pairs ## Attributes (return-only): - `:fee` [integer, default nil]: fee charged by this Invoice. ex: 65 (= R$ 0.65) - `:pdf` [string, default nil]: public Invoice PDF URL. ex: "https://invoice.starkbank.com/pdf/d454fa4e524441c1b0c1a729457ed9d8" - `:link` [string, default nil]: public Invoice webpage URL. ex: "https://my-workspace.sandbox.starkbank.com/invoicelink/d454fa4e524441c1b0c1a729457ed9d8" - `:nominal-amount` [integer, default nil]: Invoice emission value in cents (will change if invoice is updated, but not if it's paid). ex: 400000 - `:fine-amount` [integer, default nil]: Invoice fine value calculated over nominal-amount. ex: 20000 - `:interest-amount` [integer, default nil]: Invoice interest value calculated over nominal-amount. ex: 10000 - `:discount-amount` [integer, default nil]: Invoice discount value calculated over nominal-amount. ex: 3000 - `:transaction-ids` [list of strings]: ledger transaction ids linked to this invoice (if there are more than one, all but first are reversals). ex: ["19827356981273"] - `:id` [string, default nil]: unique id returned when the Invoice is created. ex: "5656565656565656" - `:brcode` [string, default nil]: BR Code for the Invoice payment. ex: "00020101021226800014br.gov.bcb.pix2558invoice.starkbank.com/f5333103-3279-4db2-8389-5efe335ba93d5204000053039865802BR5913Arya Stark6009Sao Paulo6220051656565656565656566304A9A0" - `:status` [string, default nil]: current Invoice status. ex: "registered" or "paid" - `:created` [string, default nil]: creation datetime for the Invoice. ex: "2020-03-26T19:32:35.418698+00:00" - `:updated` [string, default nil]: latest update datetime for the Invoice. ex: "2020-03-26T19:32:35.418698+00:00"
Used to generate API-compatible key pairs.
Used to generate API-compatible key pairs.
A PaymentPreview is used to get information from a payment code you received to check the information before paying it. This resource can be used to preview BR Codes and bar codes of boleto, tax and utility payments
:id
[string]: Main identification of the payment. This should be the BR Code for Pix payments and lines or bar codes for payment slips. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062", "00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A":scheduled
[string, default now]: intended payment date. Right now, this parameter only has effect on brcode-previews. ex: "2021-03-11"Attributes (return-only):
A PaymentPreview is used to get information from a payment code you received to check the information before paying it. This resource can be used to preview BR Codes and bar codes of boleto, tax and utility payments ## Parameters (required): - `:id` [string]: Main identification of the payment. This should be the BR Code for Pix payments and lines or bar codes for payment slips. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062", "00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A" ## Parameters (optional): - `:scheduled` [string, default now]: intended payment date. Right now, this parameter only has effect on brcode-previews. ex: "2021-03-11" Attributes (return-only): - type [string]: Payment type. ex: "brcode-payment", "boleto-payment", "utility-payment" or "tax-payment" - payment [brcode-preview, boleto-preview, utility-preview or tax-preview]: Information preview of the informed payment.
A PaymentRequest is an indirect request to access a specific cash-out service (such as Transfer, BrcodePayments, etc.) which goes through the cost center approval flow on our website. To emit a PaymentRequest, you must direct it to a specific cost center by its ID, which can be retrieved on our website at the cost center page.
:center-id
[string]: unique id returned when PaymentRequest is created. ex: "5656565656565656":payment
[Transfer, BrcodePayment, BoletoPayment, DarfPayment, TaxPayment, UtilityPayment, Transaction or map]: payment entity that should be approved and executed.:type
[string]: payment type, inferred from the payment parameter if it is not a map. ex: "transfer", "brcode-payment":due
[string]: Payment target date in ISO format.:tags
[list of strings]: list of strings for taggingAttributes (return-only):
:id
[string]: id of the object:amount
[integer]: PaymentRequest amount. ex: 100000 = R$1.000,00:status
[string]: current PaymentRequest status.ex: "pending" or "approved":actions
[list of PaymentRequest.Action, default nil]: list of actions that are affecting this PaymentRequest.ex: [{"type": "member", "id": "56565656565656, "action": "requested"}]:updated
[string]: latest update datetime for the PaymentRequest. ex: "2020-03-26T19:32:35.418698+00:00":created
[string]: creation datetime for the PaymentRequest. ex: "2020-03-26T19:32:35.418698+00:00"A PaymentRequest is an indirect request to access a specific cash-out service (such as Transfer, BrcodePayments, etc.) which goes through the cost center approval flow on our website. To emit a PaymentRequest, you must direct it to a specific cost center by its ID, which can be retrieved on our website at the cost center page. ## Parameters (required): - `:center-id` [string]: unique id returned when PaymentRequest is created. ex: "5656565656565656" - `:payment` [Transfer, BrcodePayment, BoletoPayment, DarfPayment, TaxPayment, UtilityPayment, Transaction or map]: payment entity that should be approved and executed. - `:type` [string]: payment type, inferred from the payment parameter if it is not a map. ex: "transfer", "brcode-payment" ## Parameters (optional): - `:due` [string]: Payment target date in ISO format. - `:tags` [list of strings]: list of strings for tagging Attributes (return-only): - `:id` [string]: id of the object - `:amount` [integer]: PaymentRequest amount. ex: 100000 = R$1.000,00 - `:status` [string]: current PaymentRequest status.ex: "pending" or "approved" - `:actions` [list of PaymentRequest.Action, default nil]: list of actions that are affecting this PaymentRequest.ex: [{"type": "member", "id": "56565656565656, "action": "requested"}] - `:updated` [string]: latest update datetime for the PaymentRequest. ex: "2020-03-26T19:32:35.418698+00:00" - `:created` [string]: creation datetime for the PaymentRequest. ex: "2020-03-26T19:32:35.418698+00:00"
Used to set options in SDK.
Used to set options in SDK.
When you initialize a TaxPayment, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects.
: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":description
[string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC":scheduled
[string, default today]: payment scheduled date. ex: ~D[2020-03-25]:tags
[list of strings]: list of strings for taggingAttributes (return-only):
:id
[string, default nil]: unique id returned when the payment is created. ex: "5656565656565656":type
[string, default nil]: tax type. ex: "das":status
[string, default nil]: current payment status. ex: "processing" or "success":amount
[integer, 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):updated
[string, default nil]: latest update datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00":created
[string, default nil]: creation datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00"When you initialize a TaxPayment, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the objects to the Stark Bank API and returns the list of created objects. ## 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" - `:type` [string, default nil]: tax type. ex: "das" - `:status` [string, default nil]: current payment status. ex: "processing" or "success" - `:amount` [integer, 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) - `:updated` [string, default nil]: latest update datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00" - `:created` [string, default nil]: creation datetime for the payment. ex: "2020-03-26T19:32:35.418698+00:00"
A Transaction is a transfer of funds between workspaces inside Stark Bank. Transactions created by the user are only for internal transactions. Other operations (such as transfer or charge-payment) will automatically create a transaction for the user which can be retrieved for the statement. When you initialize a Transaction, 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):description
[string]: text to be displayed in the receiver and the sender statements (Min. 10 characters). ex: "funds redistribution":external-id
[string]: unique id, generated by user, to avoid duplicated transactions. ex: "transaction ABC 2020-03-30":received-id
[string]: unique id of the receiving workspace. ex: "5656565656565656":tags
[list of strings]: list of strings for reference when searching transactions (may be empty). ex: ["abc", "test"]:id
[string, default nil]: unique id returned when the Transaction is created. ex: "7656565656565656":sender-id
[string]: unique id of the sending workspace. ex: "5656565656565656":fee
[integer, default nil]: fee charged when the transaction is created. ex: 200 (= R$ 2.00):source
[string, default nil]: locator of the entity that generated the transaction. ex: "charge/18276318736" or "transfer/19381639871263/chargeback":balance
[integer, default nil]: account balance after transaction was processed. ex: 100000000 (= R$ 1,000,000.00):created
[string, default nil]: creation datetime for the transaction. ex: "2020-03-26T19:32:35.418698+00:00"A Transaction is a transfer of funds between workspaces inside Stark Bank. Transactions created by the user are only for internal transactions. Other operations (such as transfer or charge-payment) will automatically create a transaction for the user which can be retrieved for the statement. When you initialize a Transaction, 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) - `:description` [string]: text to be displayed in the receiver and the sender statements (Min. 10 characters). ex: "funds redistribution" - `:external-id` [string]: unique id, generated by user, to avoid duplicated transactions. ex: "transaction ABC 2020-03-30" - `:received-id` [string]: unique id of the receiving workspace. ex: "5656565656565656" ## Parameters (optional): - `:tags` [list of strings]: list of strings for reference when searching transactions (may be empty). ex: ["abc", "test"] ## Attributes (return-only): - `:id` [string, default nil]: unique id returned when the Transaction is created. ex: "7656565656565656" - `:sender-id` [string]: unique id of the sending workspace. ex: "5656565656565656" - `:fee` [integer, default nil]: fee charged when the transaction is created. ex: 200 (= R$ 2.00) - `:source` [string, default nil]: locator of the entity that generated the transaction. ex: "charge/18276318736" or "transfer/19381639871263/chargeback" - `:balance` [integer, default nil]: account balance after transaction was processed. ex: 100000000 (= R$ 1,000,000.00) - `:created` [string, default nil]: creation datetime for the transaction. 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.
: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":account-type
[string, "checking"]: receiver bank account type. This parameter only has effect on Pix Transfers. ex: "checking", "savings", "salary" or "payment":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":description
[string, default nil]: optional description to override default description to be shown in the bank statement. ex: "Payment for service #1234":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]: 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", "salary" or "payment" - `: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" - `:description` [string, default nil]: optional description to override default description to be shown in the bank statement. ex: "Payment for service #1234" - `: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"
Used to define API user.
Used to define API user.
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.
: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":description
[string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC":scheduled
[string, default today]: payment scheduled date. ex: ~D[2020-03-25]:tags
[list of strings]: list of strings for taggingAttributes (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
[integer, 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` [integer, 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"
A Webhook is used to subscribe to notification events on a user-selected endpoint. Currently available services for subscription are transfer, boleto, boleto-payment, and utility-payment
:url
[string]: Url that will be notified when an event occurs.:subscriptions
[list of strings]: list of any non-empty combination of the available services. ex: ["transfer", "deposit", "brcode-payment"]:id
[string, default nil]: unique id returned when the webhook is created. ex: "5656565656565656"A Webhook is used to subscribe to notification events on a user-selected endpoint. Currently available services for subscription are transfer, boleto, boleto-payment, and utility-payment ## Parameters (required): - `:url` [string]: Url that will be notified when an event occurs. - `:subscriptions` [list of strings]: list of any non-empty combination of the available services. ex: ["transfer", "deposit", "brcode-payment"] ## Attributes: - `:id` [string, default nil]: unique id returned when the webhook is created. ex: "5656565656565656"
Workspaces are bank accounts. They have independent balances, statements, operations and permissions. The only property that is shared between your workspaces is that they are linked to your organization, which carries your basic information, such as tax ID, name, etc..
:username
[string]: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Ex: "starkbankworkspace":name
[string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: "Stark Bank Workspace":allowed-tax-ids
[list of strings, default nil]: list of tax IDs that will be allowed to send Deposits to this Workspace. If empty, all are allowed. ex: ["012.345.678-90", "20.018.183/0001-80"]:id
[string, default nil]: unique id returned when the workspace is created. ex: "5656565656565656"Workspaces are bank accounts. They have independent balances, statements, operations and permissions. The only property that is shared between your workspaces is that they are linked to your organization, which carries your basic information, such as tax ID, name, etc.. ## Parameters (required): - `:username` [string]: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Ex: "starkbankworkspace" - `:name` [string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: "Stark Bank Workspace" ## Parameters (optional): - `:allowed-tax-ids` [list of strings, default nil]: list of tax IDs that will be allowed to send Deposits to this Workspace. If empty, all are allowed. ex: ["012.345.678-90", "20.018.183/0001-80"] ## Attributes: - `:id` [string, default nil]: unique id returned when the workspace is created. ex: "5656565656565656"
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close