# 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](https://increase.com/documentation/webhooks.md) will be generated for this resource. The possible event categories are: `inbound_real_time_payments_request_for_payment.created` and `inbound_real_time_payments_request_for_payment.updated`.

## The Inbound Real-Time Payments Request for Payment object
### Example
```json
{
  "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-08-01",
  "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.

- `account_number_id` (string)
  The identifier of the Account Number the request for payment is for.

- `amount` (integer)
  The requested amount in USD cents.

- `created_at` (string)
  The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the request for payment was created.

- `creditor` (dictionary)
  Details of the party requesting payment.

  - `creditor.account_name` (string, nullable)
    The name of the account that would receive the payment, as provided by the creditor.

  - `creditor.address` (dictionary)
    Address of the creditor.

      - `creditor.address.city` (string, nullable)
        The town or city.

      - `creditor.address.country` (string, nullable)
        The ISO 3166, Alpha-2 country code.

      - `creditor.address.post_code` (string, nullable)
        The postal code or zip.

      - `creditor.address.state` (string, nullable)
        The US state component of the address.

      - `creditor.address.street_name` (string, nullable)
        The street name without the street number.

  - `creditor.name` (string)
    The name of the creditor.

- `creditor_routing_number` (string)
  The creditor's American Bankers' Association (ABA) Routing Transit Number (RTN).

- `currency` (enum)
  The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the requested currency. This will always be "USD" for a Real-Time Payments request for payment.
  Cases:
  * `USD` (US Dollar (USD))

- `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.

- `id` (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](https://en.wikipedia.org/wiki/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.
  Cases:
  * `pending_confirming` (The request for payment is pending confirmation from the Real-Time Payments network.)
  * `pending_response` (The request for payment is awaiting a response.)
  * `fulfilled` (The request for payment was fulfilled by a Real-Time Payments transfer.)

- `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
GET /inbound_real_time_payments_request_for_payments

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

### Query Parameters
- `cursor` (string, optional)
  Return the page of entries after this one.

- `limit` (integer, optional)
  Limit the size of the list that is returned. The default (and maximum) is 100 objects.
  Default: `100`

- `account_id` (string, optional)
  Filter Inbound Real-Time Payments Request for Payments to those belonging to the specified Account.

- `account_number_id` (string, optional)
  Filter Inbound Real-Time Payments Request for Payments to ones belonging to the specified Account Number.

- `created_at.after` (string, optional)
  Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.before` (string, optional)
  Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.on_or_after` (string, optional)
  Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.on_or_before` (string, optional)
  Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

### Returns a Inbound Real-Time Payments Request for Payment List object:
```json
{
  "data": [
    {
      "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-08-01",
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}
```

## Retrieve an Inbound Real-Time Payments Request for Payment
GET /inbound_real_time_payments_request_for_payments/{inbound_real_time_payments_request_for_payment_id}

### Example
```curl
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}"
```
### Path 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.