Real-Time Payments Requests for Payment

Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network. A request for payment is a request to the receiver to send funds to your account. The permitted uses of Requests For Payment are limited by the Real-Time Payments network to business-to-business payments and transfers between two accounts at different banks owned by the same individual. Please contact support@increase.com to enable this API for your team.

Events

Your application can listen to webhooks about this resource. The events about Real-Time Payments Requests for Payment will have the categories "real_time_payments_request_for_payment.created" or "real_time_payments_request_for_payment.updated" .

The Real-Time Payments Request for Payment object

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_name": "National Phonograph Company",
  "currency": "USD",
  "debtor": {
    "address": {
      "address_line2": "Unit 2",
      "building_number": "33",
      "city": "New York",
      "country": "US",
      "postal_code": "10045",
      "state": "NY",
      "street_name": "Liberty Street"
    },
    "name": "Ian Crease"
  },
  "debtor_account_number": "987654321",
  "debtor_routing_number": "101050001",
  "expires_at": "2020-02-14T23:59:59+00:00",
  "fulfillment_inbound_real_time_payments_transfer_id": null,
  "id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7",
  "idempotency_key": null,
  "refusal": null,
  "rejection": null,
  "requested_execution_at": "2020-02-07T23:59:59+00:00",
  "status": "pending_response",
  "submission": null,
  "type": "real_time_payments_request_for_payment",
  "unstructured_remittance_information": "Invoice 29582"
}

Attributes

account_number_id

string

The Account Number in which a successful transfer will arrive.

More about Account Numbers.

amount

integer

The transfer amount in USD cents.

created_at

string

The ISO 8601 date and time at which the request for payment was created.

creditor_name

string

The name of the creditor requesting the payment.

currency

enum

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

debtor

dictionary

Details of the person being requested to pay.

debtor_account_number

string

The debtor’s account number, which the request is sent to.

debtor_routing_number

string

The debtor’s American Bankers’ Association (ABA) Routing Transit Number (RTN).

expires_at

string

The ISO 8601 date and time after which the request for payment is no longer valid. After this time the debtor’s bank should no longer allow the debtor to pay it.

fulfillment_inbound_real_time_payments_transfer_id

string

Nullable

The identifier of the Inbound Real-Time Payments Transfer that fulfilled this request.

More about Inbound Real-Time Payments Transfers.

string

The Real-Time Payments Request for Payment’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.

refusal

dictionary

Nullable

If the request for payment is refused by the destination financial institution or the receiving customer, this will contain supplemental details.

rejection

dictionary

Nullable

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

requested_execution_at

string

Nullable

The ISO 8601 date and time by which the payment was requested to be made.

status

enum

The lifecycle status of the request for payment.

submission

dictionary

Nullable

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

type

string

A constant representing the object’s type. For this resource it will always be real_time_payments_request_for_payment.

unstructured_remittance_information

string

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

List Real-Time Payments Requests for Payment

curl \
  --url "${INCREASE_URL}/real_time_payments_requests_for_payment?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Real-Time Payments Request for Payment object */ },
    { /* Real-Time Payments Request for Payment object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Real-Time Payments Requests for Payment to those destined to the specified Account.

More about Accounts.

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.

Between 1 and 200 characters

More parameters

Create a Real-Time Payments Request for Payment

curl -X "POST" \
  --url "${INCREASE_URL}/real_time_payments_requests_for_payment" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "amount": 100,
    "creditor_name": "National Phonograph Company",
    "debtor": {
      "address": {
        "country": "US",
        "street_name": "Liberty Street"
      },
      "name": "Ian Crease"
    },
    "debtor_account_number": "987654321",
    "debtor_routing_number": "101050001",
    "expires_at": "2020-02-14T23:59:59+00:00",
    "requested_execution_at": "2020-02-07T23:59:59+00:00",
    "unstructured_remittance_information": "Invoice 29582"
  }'

Parameters

account_number_id

string

Required

The identifier of the Account Number where the funds will land.

More about Account Numbers.

amount

integer

Required

The requested amount in USD cents. Must be positive.

creditor_name

string

The name of the creditor requesting the payment. If not provided, defaults to the name of the account’s entity.

Between 1 and 140 characters,

debtor

dictionary

Required

Details of the person being requested to pay.

debtor_account_number

string

Required

The debtor’s account number, which the funds will be requested from.

Between 1 and 34 characters,

debtor_routing_number

string

Required

The debtor’s American Bankers’ Association (ABA) Routing Transit Number (RTN).

Exactly 9 characters,

expires_at

string

Required

The ISO 8601 date and time after which the request for payment is no longer valid. After this time the debtor’s bank should no longer allow the debtor to pay it. Must not be before requested_execution_at.

requested_execution_at

string

Required

The ISO 8601 date and time by which you are requesting the payment to be made.

unstructured_remittance_information

string

Required

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

Between 1 and 140 characters,

Retrieve a Real-Time Payments Request for Payment

curl \
  --url "${INCREASE_URL}/real_time_payments_requests_for_payment/real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

real_time_payments_request_for_payment_id

string

Required

The identifier of the Real-Time Payments Request for Payment.

More about Real-Time Payments Requests for Payment.