Increase.SwiftTransfers.SwiftTransfer (Increase v1.0.0)

Copy Markdown View Source

Swift Transfers send funds internationally.

Fields

  • id - The Swift transfer's identifier.
  • account_id - The Account to which the transfer belongs.
  • account_number - The creditor's account number.
  • amount - The transfer amount in USD cents.
  • bank_identification_code - The bank identification code (BIC) of the creditor.
  • created_at - The ISO 8601 date and time at which the transfer was created.
  • created_by - What object created the transfer, either via the API or the dashboard.
  • creditor_address - The creditor's address.
  • creditor_name - The creditor's name.
  • debtor_address - The debtor's address.
  • debtor_name - The debtor's name.
  • idempotency_key - The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  • instructed_amount - The amount that was instructed to be transferred in minor units of the instructed_currency.
  • instructed_currency - The ISO 4217 currency code of the instructed amount.
  • pending_transaction_id - The ID for the pending transaction representing the transfer.
  • routing_number - The creditor's bank account routing or transit number. Required in certain countries.
  • source_account_number_id - The Account Number included in the transfer as the debtor's account number.
  • status - The lifecycle status of the transfer.
  • transaction_id - The ID for the transaction funding the transfer. This will be populated after the transfer is initiated.
  • type - A constant representing the object's type. For this resource it will always be swift_transfer.
  • unique_end_to_end_transaction_reference - The Unique End-to-end Transaction Reference (UETR) for the transfer.
  • unstructured_remittance_information - The unstructured remittance information that was included with the transfer.

Summary

Types

t()

@type t() :: %Increase.SwiftTransfers.SwiftTransfer{
  account_id: String.t(),
  account_number: String.t(),
  amount: integer(),
  bank_identification_code: String.t(),
  created_at: DateTime.t(),
  created_by: Increase.SwiftTransfers.SwiftTransfer.CreatedBy.t(),
  creditor_address: Increase.SwiftTransfers.SwiftTransfer.CreditorAddress.t(),
  creditor_name: String.t(),
  debtor_address: Increase.SwiftTransfers.SwiftTransfer.DebtorAddress.t(),
  debtor_name: String.t(),
  id: String.t(),
  idempotency_key: String.t() | nil,
  instructed_amount: integer(),
  instructed_currency: String.t(),
  pending_transaction_id: String.t() | nil,
  routing_number: String.t() | nil,
  source_account_number_id: String.t(),
  status: String.t(),
  transaction_id: String.t() | nil,
  type: String.t(),
  unique_end_to_end_transaction_reference: String.t(),
  unstructured_remittance_information: String.t()
}