Increase. RealTimePaymentsTransfers. RealTimePaymentsTransfer
(Increase v1.0.0)
Copy Markdown
View Source
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.
Fields
id- The Real-Time Payments Transfer's identifier.account_id- The Account from which the transfer was sent.account_number- The destination account number.acknowledgement- If the transfer is acknowledged by the recipient bank, this will contain supplemental details.amount- The transfer amount in USD cents.approval- If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.cancellation- If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.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_name- The name of the transfer's recipient. This is set by the sender when creating the transfer.currency- The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal toUSD.debtor_name- The name of the transfer's sender. If not provided, defaults to the name of the account's entity.external_account_id- The identifier of the External Account the transfer was made to, if any.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.pending_transaction_id- The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.rejection- If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.routing_number- The destination American Bankers' Association (ABA) Routing Transit Number (RTN).source_account_number_id- The Account Number the recipient will see as having sent the transfer.status- The lifecycle status of the transfer.submission- After the transfer is submitted to Real-Time Payments, this will contain supplemental details.transaction_id- The Transaction funding the transfer once it is complete.type- A constant representing the object's type. For this resource it will always bereal_time_payments_transfer.ultimate_creditor_name- The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.ultimate_debtor_name- The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.unstructured_remittance_information- Unstructured information that will show on the recipient's bank statement.
Summary
Types
@type t() :: %Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer{ account_id: String.t(), account_number: String.t(), acknowledgement: Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.Acknowledgement.t() | nil, amount: integer(), approval: Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.Approval.t() | nil, cancellation: Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.Cancellation.t() | nil, created_at: DateTime.t(), created_by: Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.CreatedBy.t() | nil, creditor_name: String.t(), currency: String.t(), debtor_name: String.t() | nil, external_account_id: String.t() | nil, id: String.t(), idempotency_key: String.t() | nil, pending_transaction_id: String.t() | nil, rejection: Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.Rejection.t() | nil, routing_number: String.t(), source_account_number_id: String.t(), status: String.t(), submission: Increase.RealTimePaymentsTransfers.RealTimePaymentsTransfer.Submission.t() | nil, transaction_id: String.t() | nil, type: String.t(), ultimate_creditor_name: String.t() | nil, ultimate_debtor_name: String.t() | nil, unstructured_remittance_information: String.t() }