starkbank v2.6.2 StarkBank.PaymentPreview.BoletoPreview View Source
Groups BoletoPreview related functions
Link to this section Summary
Functions
A BoletoPreview is used to get information from a Boleto payment you received before confirming the payment.
Link to this section Types
Link to this type
t()
View Sourcet() :: %StarkBank.PaymentPreview.BoletoPreview{
amount: term(),
bar_code: term(),
discount_amount: term(),
due: term(),
expiration: term(),
fine_amount: term(),
interest_amount: term(),
line: term(),
name: term(),
payer_name: term(),
payer_tax_id: term(),
receiver_name: term(),
receiver_tax_id: term(),
status: term(),
tax_id: term()
}
Link to this section Functions
A BoletoPreview is used to get information from a Boleto payment you received before confirming the payment.
Attributes (return-only):
:status[string]: current boleto status. ex: "active", "expired" or "inactive":amount[int]: final amount to be paid. ex: 23456 (= R$ 234.56):discount_amount[int]: discount amount to be paid. ex: 23456 (= R$ 234.56):fine_amount[int]: fine amount to be paid. ex: 23456 (= R$ 234.56):interest_amount[int]: interest amount to be paid. ex: 23456 (= R$ 234.56):due[Date]: Boleto due date. ex: 2020-04-30:expiration[Date]: Boleto expiration date. ex: 2020-04-30:name[string]: beneficiary full name. ex: "Anthony Edward Stark":tax_id[string]: beneficiary tax ID (CPF or CNPJ). ex: "20.018.183/0001-80":receiver_name[string]: receiver (Sacador Avalista) full name. ex: "Anthony Edward Stark":receiver_tax_id[string]: receiver (Sacador Avalista) tax ID (CPF or CNPJ). ex: "20.018.183/0001-80":payer_name[string]: payer full name. ex: "Anthony Edward Stark":payer_tax_id[string]: payer tax ID (CPF or CNPJ). ex: "20.018.183/0001-80":line[string]: Number sequence that identifies the payment. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062":bar_code[string]: Bar code number that identifies the payment. ex: "34195819600000000621090063571277307144464000"