starkbank v2.6.2 StarkBank.Invoice.Payment View Source

Groups Invoice.Payment related functions

Link to this section Summary

Functions

When an Invoice is paid, its Payment sub-resource will become available. It carries all the available information about the invoice payment.

Link to this section Types

Link to this type

t()

View Source
t() :: %StarkBank.Invoice.Payment{
  account_number: term(),
  account_type: term(),
  amount: term(),
  bank_code: term(),
  branch_code: term(),
  end_to_end_id: term(),
  method: term(),
  name: term(),
  tax_id: term()
}

Link to this section Functions

Link to this function

%StarkBank.Invoice.Payment{}

View Source (struct)

When an Invoice is paid, its Payment sub-resource will become available. It carries all the available information about the invoice payment.

Attributes:

  • :amount [integer]: amount in cents that was paid. ex: 1234 (= R$ 12.34)
  • :name [string]: payer full name. ex: "Anthony Edward Stark"
  • :tax_id [string]: payer tax ID (CPF or CNPJ). ex: "20.018.183/0001-80"
  • :bank_code [string]: code of the payer bank institution in Brazil. ex: "20018183"
  • :branch_code [string]: payer bank account branch. ex: "1357-9"
  • :account_number [string]: payer bank account number. ex: "876543-2"
  • :account_type [string]: payer bank account type. ex: "checking", "savings", "salary" or "payment"
  • :end_to_end_id [string]: central bank's unique transaction ID. ex: "E79457883202101262140HHX553UPqeq"
  • :method [string]: payment method that was used. ex: "pix"