starkbank v2.6.2 StarkBank.PaymentPreview.UtilityPreview View Source

Groups UtilityPreview related functions

Link to this section Summary

Functions

A UtilityPreview is used to get information from a BR Code you received to check the informations before paying it.

Link to this section Types

Link to this type

t()

View Source
t() :: %StarkBank.PaymentPreview.UtilityPreview{
  amount: term(),
  bar_code: term(),
  description: term(),
  line: term(),
  name: term()
}

Link to this section Functions

Link to this function

%StarkBank.PaymentPreview.UtilityPreview{}

View Source (struct)

A UtilityPreview is used to get information from a BR Code you received to check the informations before paying it.

Attributes (return-only):

  • :amount [int]: final amount to be paid. ex: 23456 (= R$ 234.56)
  • :name [string]: beneficiary full name. ex: "Light Company"
  • :description [string]: utility payment description. ex: "Utility Payment - Light Company"
  • :line [string]: Number sequence that identifies the payment. ex: "82660000002 8 44361143007 7 41190025511 7 00010601813 8"
  • :bar_code [string]: Bar code number that identifies the payment. ex: "82660000002443611430074119002551100010601813"