starkbank v2.4.1 StarkBank.Transfer View Source
Groups Transfer related functions
Link to this section Summary
Functions
When you initialize a Transfer, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the structs to the Stark Bank API and returns the list of created structs.
Send a list of Transfer structs for creation in the Stark Bank API
Same as create(), but it will unwrap the error tuple and raise in case of errors.
Delete a list of Transfer entities previously created in the Stark Bank API
Same as delete(), but it will unwrap the error tuple and raise in case of errors.
Receive a single Transfer struct previously created in the Stark Bank API by passing its id
Same as get(), but it will unwrap the error tuple and raise in case of errors.
Receive a single Transfer pdf receipt file generated in the Stark Bank API by passing its id. Only valid for transfers with "processing" or "success" status.
Same as pdf(), but it will unwrap the error tuple and raise in case of errors.
Receive a stream of Transfer structs previously created in the Stark Bank API
Same as query(), but it will unwrap the error tuple and raise in case of errors.
Link to this section Types
t()
View Sourcet() :: %StarkBank.Transfer{ account_number: term(), account_type: term(), amount: term(), bank_code: term(), branch_code: term(), created: term(), external_id: term(), fee: term(), id: term(), name: term(), scheduled: term(), status: term(), tags: term(), tax_id: term(), transaction_ids: term(), updated: term() }
Link to this section Functions
When you initialize a Transfer, the entity will not be automatically created in the Stark Bank API. The 'create' function sends the structs to the Stark Bank API and returns the list of created structs.
Parameters (required):
:amount
[integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34):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"
Parameters (optional):
:account_type
[string, default "checking"]: Receiver bank account type. This parameter only has effect on Pix Transfers. ex: "checking", "savings" or "salary":external_id
[string, default nil]: url safe string that must be unique among all your transfers. Duplicated external_ids will cause failures. By default, this parameter will block any transfer that repeats amount and receiver information on the same date. ex: "my-internal-id-123456":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":fee
[integer, default nil]: fee charged when transfer is created. ex: 200 (= R$ 2.00):status
[string, default nil]: current transfer status. ex: "success" or "failed":transaction_ids
[list of strings, default nil]: ledger transaction ids linked to this transfer (if there are two, second is the chargeback). ex: ["19827356981273"]:created
[DateTime, default nil]: creation datetime for the transfer. ex: ~U[2020-03-26 19:32:35.418698Z]:updated
[DateTime, default nil]: latest update datetime for the transfer. ex: ~U[2020-03-26 19:32:35.418698Z]
create(transfers, options \\ [])
View Sourcecreate([StarkBank.Transfer.t() | map()], [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: {:ok, [StarkBank.Transfer.t()]} | {:error, [StarkBank.Error.t()]}
Send a list of Transfer structs for creation in the Stark Bank API
Parameters (required):
transfers
[list of Transfer structs]: list of Transfer structs to be created in the API
Options:
:user
[Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- list of Transfer structs with updated attributes
create!(transfers, options \\ [])
View Sourcecreate!([StarkBank.Transfer.t() | map()], [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: any()
Same as create(), but it will unwrap the error tuple and raise in case of errors.
delete(id, options \\ [])
View Sourcedelete(binary(), [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: {:ok, StarkBank.Transfer.t()} | {:error, [%StarkBank.Error{code: term(), message: term()}]}
Delete a list of Transfer entities previously created in the Stark Bank API
Parameters (required):
id
[string]: Boleto unique id. ex: "5656565656565656"
Options:
:user
[Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- deleted Transfer struct
delete!(id, options \\ [])
View Sourcedelete!(binary(), [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: Boleto.t()
Same as delete(), but it will unwrap the error tuple and raise in case of errors.
get(id, options \\ [])
View Sourceget(binary(), [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: {:ok, StarkBank.Transfer.t()} | {:error, [%StarkBank.Error{code: term(), message: term()}]}
Receive a single Transfer struct previously created in the Stark Bank API by passing its id
Parameters (required):
id
[string]: struct unique id. ex: "5656565656565656"
Options:
:user
[Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- Transfer struct with updated attributes
get!(id, options \\ [])
View Sourceget!(binary(), [ {:user, StarkBank.User.Project.t() | StarkBank.User.Organization.t() | nil} ]) :: StarkBank.Transfer.t()
Same as get(), but it will unwrap the error tuple and raise in case of errors.
Receive a single Transfer pdf receipt file generated in the Stark Bank API by passing its id. Only valid for transfers with "processing" or "success" status.
Parameters (required):
id
[string]: struct unique id. ex: "5656565656565656"
Options:
:user
[Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- Transfer pdf file content
Same as pdf(), but it will unwrap the error tuple and raise in case of errors.
query(options \\ [])
View Sourcequery( limit: integer(), after: Date.t() | binary(), before: Date.t() | binary(), transaction_ids: [binary()], status: binary(), tax_id: binary(), sort: binary(), tags: [binary()], ids: [binary()], user: StarkBank.User.Project.t() | StarkBank.User.Organization.t() ) :: ({:cont, {:ok, [StarkBank.Transfer.t()]}} | {:error, [StarkBank.Error.t()]} | {:halt, any()} | {:suspend, any()}, any() -> any())
Receive a stream of Transfer structs previously created in the Stark Bank API
Options:
:limit
[integer, default nil]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35:after
[Date or string, default nil]: date filter for structs created or updated only after specified date. ex: ~D[2020-03-25]:before
[Date or string, default nil]: date filter for structs created or updated only before specified date. ex: ~D[2020-03-25]:transaction_ids
[list of strings, default nil]: list of transaction IDs linked to the desired transfers. ex: ["5656565656565656", "4545454545454545"]:status
[string, default nil]: filter for status of retrieved structs. ex: "paid" or "registered":tax_id
[string, default nil]: filter for transfers sent to the specified tax ID. ex: "012.345.678-90":sort
[string, default "-created"]: sort order considered in response. Valid options are "created", "-created", "updated" or "-updated".:tags
[list of strings, default nil]: tags to filter retrieved structs. ex: ["tony", "stark"]:ids
[list of strings, default nil]: list of ids to filter retrieved structs. ex: ["5656565656565656", "4545454545454545"]:user
[Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- stream of Transfer structs with updated attributes
query!(options \\ [])
View Sourcequery!( limit: integer(), after: Date.t() | binary(), before: Date.t() | binary(), transaction_ids: [binary()], status: binary(), tax_id: binary(), sort: binary(), tags: [binary()], ids: [binary()], user: StarkBank.User.Project.t() | StarkBank.User.Organization.t() ) :: ({:cont, [StarkBank.Transfer.t()]} | {:halt, any()} | {:suspend, any()}, any() -> any())
Same as query(), but it will unwrap the error tuple and raise in case of errors.