API Reference — Increase

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "confirmation": {
    "confirmed_at": "2020-01-31T23:59:59Z",
    "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_account_number": "987654321",
  "debtor_name": "National Phonograph Company",
  "debtor_routing_number": "101050001",
  "decline": null,
  "id": "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr",
  "remittance_information": "Invoice 29582",
  "status": "confirmed",
  "transaction_identification": "20220501234567891T1BSLZO01745013025",
  "type": "inbound_real_time_payments_transfer"
}

Attributes

account_id

string

The Account to which the transfer was sent.

account_number_id

string

The identifier of the Account Number to which this transfer was sent.

amount

integer

The amount in USD cents.

confirmation

dictionary

Nullable

If your transfer is confirmed, this will contain details of the confirmation.

created_at

string

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

creditor_name

string

The name the sender of the transfer specified as the recipient of the transfer.

currency

enum

The ISO 4217 code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.

debtor_account_number

string

The account number of the account that sent the transfer.

debtor_name

string

The name provided by the sender of the transfer.

debtor_routing_number

string

The routing number of the account that sent the transfer.

decline

dictionary

Nullable

If your transfer is declined, this will contain details of the decline.

string

The inbound Real-Time Payments transfer's identifier.

remittance_information

string

Nullable

Additional information included with the transfer.

status

enum

The lifecycle status of the transfer.

transaction_identification

string

The Real-Time Payments network identification of the transfer.

type

string

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

List Inbound Real-Time Payments Transfers

curl \
  --url "${INCREASE_URL}/inbound_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 Inbound Real-Time Payments Transfers to those belonging to the specified Account.

account_number_id

string

Filter Inbound Real-Time Payments Transfers to ones belonging to the specified Account Number.

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.

Retrieve an Inbound Real-Time Payments Transfer

curl \
  --url "${INCREASE_URL}/inbound_real_time_payments_transfers/inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

inbound_real_time_payments_transfer_id

string

Required

The identifier of the Inbound Real-Time Payments Transfer to get details for.

Sandbox: Create an Inbound Real-Time Payments Transfer

Simulates an Inbound Real-Time Payments Transfer to your account. Real-Time Payments are a beta feature.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/inbound_real_time_payments_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "amount": 1000,
    "request_for_payment_id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7"
  }'

Parameters

account_number_id

string

Required

The identifier of the Account Number the inbound Real-Time Payments Transfer is for.

amount

integer

Required

The transfer amount in USD cents. Must be positive.

debtor_account_number

string

The account number of the account that sent the transfer.

200 character maximum

debtor_name

string

The name provided by the sender of the transfer.

200 character maximum

debtor_routing_number

string

The routing number of the account that sent the transfer.

9 character maximum

remittance_information

string

Additional information included with the transfer.

140 character maximum

request_for_payment_id

string

The identifier of a pending Request for Payment that this transfer will fulfill.