View Source StarkInfra.CreditNote.Transfer (starkinfra v0.0.1)

Groups Transfer related functions

Link to this section Summary

Functions

CreditNote signer's information.

Link to this section Types

@type t() :: %StarkInfra.CreditNote.Transfer{
  account_number: term(),
  account_type: term(),
  amount: term(),
  bank_code: term(),
  branch_code: term(),
  id: term(),
  name: term(),
  scheduled: term(),
  status: term(),
  tags: term(),
  tax_id: term()
}

Link to this section Functions

Link to this function

%StarkInfra.CreditNote.Transfer{}

View Source (struct)

CreditNote signer's information.

parameters-required

Parameters (required):

- `: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"

options

Options:

- `:account_type` [string, default "checking"]: Receiver Bank account type. This parameter only has effect on Pix Transfers. ex: "checking", "savings", "salary" or "payment"
- `:scheduled` [Date, DateTime or string, default now]: date or datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: ~U[2020-03-26 19:32:35.418698Z]
- `: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 Transfer is created. ex: "5656565656565656"
- `:amount` [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
- `:status` [string, default nil]: current transfer status. ex: "success" or "failed"