starkbank v2.6.2 StarkBank.PaymentPreview.BrcodePreview View Source
Groups BrcodePreview related functions
Link to this section Summary
Functions
A BrcodePreview is used to get information from a BR Code you received before confirming the payment.
Link to this section Types
Link to this type
t()
View Sourcet() :: %StarkBank.PaymentPreview.BrcodePreview{
account_number: term(),
account_type: term(),
allow_change: term(),
amount: term(),
bank_code: term(),
branch_code: term(),
discount_amount: term(),
fine_amount: term(),
interest_amount: term(),
name: term(),
nominal_amount: term(),
reconciliation_id: term(),
reduction_amount: term(),
status: term(),
tax_id: term()
}
Link to this section Functions
A BrcodePreview is used to get information from a BR Code you received before confirming the payment.
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 different 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):nominal_amount[integer]: Original value in cents that this payment was expecting to receive without the discounts, fines, etc.. If 0, any value is accepted. ex: 123 (= R$1,23):interest_amount[integer]: Current interest value in cents that this payment is charging. If 0, any value is accepted. ex: 123 (= R$1,23):fine_amount[integer]: Current fine value in cents that this payment is charging. ex: 123 (= R$1,23):reduction_amount[integer]: Current value reduction value in cents that this payment is expecting. ex: 123 (= R$1,23):discount_amount[integer]: Current discount value in cents that this payment is expecting. ex: 123 (= R$1,23):reconciliation_id[string]: Reconciliation ID linked to this payment. ex: "txId", "payment-123"