Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Real-Time Payments Transfers

Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.

The Real-Time Payments Transfer object
{
  "account_id": "account_in71c4amph0vgo2qllky",
  "acknowledgement": {
    "acknowledged_at": "2020-01-31T23:59:59Z"
  },
  "amount": 100,
  "approval": null,
  "cancellation": null,
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_name": null,
  "destination_account_number": "987654321",
  "destination_routing_number": "101050001",
  "external_account_id": null,
  "id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
  "idempotency_key": null,
  "pending_transaction_id": null,
  "rejection": null,
  "remittance_information": "Invoice 29582",
  "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "status": "complete",
  "submission": {
    "submitted_at": "2020-01-31T23:59:59Z",
    "transaction_identification": "20220501234567891T1BSLZO01745013025"
  },
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "real_time_payments_transfer",
  "ultimate_creditor_name": null,
  "ultimate_debtor_name": null
}
Attributes
account_id
string

The Account from which the transfer was sent.

acknowledgement
dictionary
Nullable

If the transfer is acknowledged by the recipient bank, this will contain supplemental details.

amount
integer

The transfer amount in USD cents.

approval
dictionary
Nullable

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

cancellation
dictionary
Nullable

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

created_at
string

The ISO 8601 date and time at which the transfer was created.

created_by
dictionary
Nullable

What object created the transfer, either via the API or the dashboard.

creditor_name
string

The name of the transfer's recipient. This is set by the sender when creating the transfer.

currency
enum

The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.

debtor_name
string
Nullable

The name of the transfer's sender. If not provided, defaults to the name of the account's entity.

destination_account_number
string

The destination account number.

destination_routing_number
string

The destination American Bankers' Association (ABA) Routing Transit Number (RTN).

external_account_id
string
Nullable

The identifier of the External Account the transfer was made to, if any.

id
string

The Real-Time Payments Transfer's identifier.

idempotency_key
string
Nullable

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
string
Nullable

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
dictionary
Nullable

If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.

remittance_information
string

Unstructured information that will show on the recipient's bank statement.

source_account_number_id
string

The Account Number the recipient will see as having sent the transfer.

status
enum

The lifecycle status of the transfer.

submission
dictionary
Nullable

After the transfer is submitted to Real-Time Payments, this will contain supplemental details.

transaction_id
string
Nullable

The Transaction funding the transfer once it is complete.

type
string

A constant representing the object's type. For this resource it will always be real_time_payments_transfer.

ultimate_creditor_name
string
Nullable

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
string
Nullable

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.

List Real-Time Payments Transfers
curl \
  --url "${INCREASE_URL}/real_time_payments_transfers?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Real-Time Payments Transfers to those belonging to the specified Account.

external_account_id
string

Filter Real-Time Payments Transfers to those made to the specified External Account.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
status.in
array of strings

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Create a Real-Time Payments Transfer
curl -X "POST" \
  --url "${INCREASE_URL}/real_time_payments_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 100,
    "creditor_name": "Ian Crease",
    "destination_account_number": "987654321",
    "destination_routing_number": "101050001",
    "remittance_information": "Invoice 29582",
    "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2"
  }'
Parameters
amount
integer
Required

The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.

creditor_name
string
Required

The name of the transfer's recipient.

140 character maximum
debtor_name
string

The name of the transfer's sender. If not provided, defaults to the name of the account's entity.

140 character maximum
destination_account_number
string

The destination account number.

34 character maximum
destination_routing_number
string

The destination American Bankers' Association (ABA) Routing Transit Number (RTN).

9 character maximum
external_account_id
string

The ID of an External Account to initiate a transfer to. If this parameter is provided, destination_account_number and destination_routing_number must be absent.

remittance_information
string
Required

Unstructured information that will show on the recipient's bank statement.

140 character maximum
require_approval
boolean

Whether the transfer requires explicit approval via the dashboard or API.

source_account_number_id
string
Required

The identifier of the Account Number from which to send the transfer.

ultimate_creditor_name
string

The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.

140 character maximum
ultimate_debtor_name
string

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.

140 character maximum
Retrieve a Real-Time Payments Transfer
curl \
  --url "${INCREASE_URL}/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
real_time_payments_transfer_id
string
Required

The identifier of the Real-Time Payments Transfer.

Approve an Real-Time Payments Transfer

Approves an Real-Time Payments Transfer in a pending_approval state.

curl -X "POST" \
  --url "${INCREASE_URL}/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq/approve" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
real_time_payments_transfer_id
string
Required

The identifier of the Real-Time Payments Transfer to approve.

Cancel a pending Real-Time Payments Transfer

Cancels an Real-Time Payments Transfer in a pending_approval state.

curl -X "POST" \
  --url "${INCREASE_URL}/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq/cancel" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
real_time_payments_transfer_id
string
Required

The identifier of the pending Real-Time Payments Transfer to cancel.

Sandbox: Complete a Real-Time Payments Transfer

Simulates submission of a Real-Time Payments Transfer and handling the response from the destination financial institution. This transfer must first have a status of pending_submission.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq/complete" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{}'
Parameters
real_time_payments_transfer_id
string
Required

The identifier of the Real-Time Payments Transfer you wish to complete.

rejection
dictionary

If set, the simulation will reject the transfer.