increase-test
POST/real_time_payments_transfers

Create a Real-Time Payments transfer

Creates a Real-Time Payments transfer from an account to a recipient on the Real-Time Payments network. Provide source_account_number_id, amount, creditor_name, and unstructured_remittance_information; use either account_number and routing_number or external_account_id to identify the destination. The transfer amount is specified in USD cents.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

12 body fields

Details for the Real-Time Payments transfer, including the source account, amount, recipient, and destination.

account_numberstringoptional
The destination account number.
amountintegerrequired
The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.
creditor_namestringrequired
The name of the transfer's recipient.
debtor_namestringoptional
The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
external_account_idstringoptional
The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent.
inbound_real_time_payments_request_for_payment_idstringoptional
The ID of an Inbound Real-Time Payments Request for Payment in response to which this transfer is being sent.
require_approvalbooleanoptional
Whether the transfer requires explicit approval via the dashboard or API.
routing_numberstringoptional
The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
source_account_number_idstringrequired
The identifier of the Account Number from which to send the transfer.
ultimate_creditor_namestringoptional
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_namestringoptional
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_informationstringrequired
Unstructured information that will show on the recipient's bank statement.

3 status codes
200Returns the created Real-Time Payments transfer, including its identifier, amount, account details, recipient, status, and timestamps.
account_idstringrequired
The Account from which the transfer was sent.
account_numberstringrequired
The destination account number.
acknowledgementobjectrequired
If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
amountintegerrequired
The transfer amount in USD cents.
approvalobjectrequired
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
cancellationobjectrequired
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
created_byobjectrequired
What object created the transfer, either via the API or the dashboard.
creditor_namestringrequired
The name of the transfer's recipient. This is set by the sender when creating the transfer.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For real-time payments transfers this is always equal to `USD`.
Allowed:USD
debtor_namestringrequired
The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
external_account_idstringrequired
The identifier of the External Account the transfer was made to, if any.
idstringrequired
The Real-Time Payments Transfer's identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
inbound_real_time_payments_request_for_payment_idstringrequired
The identifier of the Inbound Real-Time Payments Request for Payment this transfer was sent in response to, if any.
pending_transaction_idstringrequired
The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.
rejectionobjectrequired
If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
routing_numberstringrequired
The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
source_account_number_idstringrequired
The Account Number the recipient will see as having sent the transfer.
statusstringrequired
The lifecycle status of the transfer.
Allowed:pending_approvalcanceledpending_submissionpending_reviewingrequires_attentionrejectedsubmittedcomplete
submissionobjectrequired
After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
transaction_idstringrequired
The Transaction funding the transfer once it is complete.
typestringrequired
A constant representing the object's type. For this resource it will always be `real_time_payments_transfer`.
Allowed:real_time_payments_transfer
ultimate_creditor_namestringrequired
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_namestringrequired
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_informationstringrequired
Unstructured information that will show on the recipient's bank statement.
4XXReturned when the request results in a client error.
5XXReturned when the request results in a server error.

Error handling

source_account_number_id, amount, creditor_name, and unstructured_remittance_information are required. amount must be a positive integer; account_number, if provided, must be 1–34 alphanumeric characters, and routing_number, if provided, must be exactly 9 digits. Provide external_account_id instead of account_number and routing_number; names and remittance information must meet the schema's length and character constraints.