Private API Reference

Inbound Real-Time Payments Request for Payments

An Inbound Real-Time Payments Request for Payment is a request initiated outside of Increase for one of your accounts to send a Real-Time Payments transfer.

Events

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

The Inbound Real-Time Payments Request for Payment object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor": {
    "account_name": "National Phonograph Company",
    "address": {
      "city": "New York",
      "country": "US",
      "post_code": "10045",
      "state": "NY",
      "street_name": "33 Liberty Street"
    },
    "name": "National Phonograph Company"
  },
  "creditor_routing_number": "101050001",
  "currency": "USD",
  "debtor_name": "Ian Crease",
  "expires_at": "2026-07-24",
  "id": "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky",
  "invoicer_identification": null,
  "payment_information_identification": "20220501234567891T1BSLZO01745013025",
  "requested_execution_date": "2020-01-31T23:59:59Z",
  "status": "pending_response",
  "type": "inbound_real_time_payments_request_for_payment",
  "unstructured_remittance_information": "Invoice 29582"
}

Attributes

account_id

string

The Account the request for payment is for.

More about Accounts.

account_number_id

string

The identifier of the Account Number the request for payment is for.

More about Account Numbers.

amount

integer

The requested amount in USD cents.

created_at

string

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

creditor

dictionary

Details of the party requesting payment.

creditor_routing_number

string

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

currency

enum

The ISO 4217 code of the requested currency. This will always be “USD” for a Real-Time Payments request for payment.

debtor_name

string

The name of the account holder the payment is requested from, as provided by the creditor.

expires_at

string

The date after which the request for payment is no longer valid and cannot be paid.

string

The inbound Real-Time Payments request for payment’s identifier.

invoicer_identification

string

Nullable

An identifier for the party that issued the invoice, for requests for payment sent on behalf of another party.

payment_information_identification

string

The Real-Time Payments network identification of the request for payment.

requested_execution_date

string

Nullable

The ISO 8601 date and time by which the creditor requests the payment to be made.

status

enum

The lifecycle status of the request for payment.

type

string

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

unstructured_remittance_information

string

Nullable

Unstructured information included with the request for payment.

List Inbound Real-Time Payments Request for Payments

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

Returns a list response :

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

Parameters

account_id

string

Filter Inbound Real-Time Payments Request for Payments to those belonging to the specified Account.

More about Accounts.

account_number_id

string

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

More about Account Numbers.

More parameters

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Retrieve an Inbound Real-Time Payments Request for Payment

curl \
  --url "${INCREASE_URL}/inbound_real_time_payments_request_for_payments/inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

inbound_real_time_payments_request_for_payment_id

string

Required

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