# Inbound Real-Time Payments Requests for Payment > 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": { "address_line2": "Unit 2", "building_number": "33", "city": "New York", "country": "US", "postal_code": "10045", "state": "NY", "street_name": "Liberty Street" }, "name": "National Phonograph Company" }, "creditor_account_number": "987654321", "creditor_routing_number": "101050001", "currency": "USD", "debtor_name": "Ian Crease", "end_to_end_identification": "Invoice 29582", "expires_at": "2020-02-07T23:59:59Z", "fulfillment_real_time_payments_transfer_id": null, "id": "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky", "invoicer_identification": null, "payment_information_identification": "20220501234567891T1BSLZO01745013025", "requested_execution_at": "2020-01-31T23:59:59Z", "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.address_line2` (string, nullable) A second address line, such as an apartment or suite number. The first address line is separated into `building_number` and `street_name`. - `creditor.address.building_number` (string, nullable) The number identifying the position of the building on the street. - `creditor.address.city` (string, nullable) The town or city. - `creditor.address.country` (string, nullable) The ISO 3166, Alpha-2 country code. - `creditor.address.postal_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_account_number` (string) The creditor's account number. - `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. - `end_to_end_identification` (string) A free-form reference string set by the creditor, to help identify the request for payment. - `expires_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which the request for payment is no longer valid and should no longer be paid. - `fulfillment_real_time_payments_transfer_id` (string, nullable) The identifier of the Real-Time Payments Transfer that fulfilled this request for payment. This is set once a transfer sent in response to the request for payment has been acknowledged by the Real-Time Payments network. - `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_at` (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. - `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 Requests for Payment GET /inbound_real_time_payments_requests_for_payment ### Example ```curl curl \ --url "${INCREASE_URL}/inbound_real_time_payments_requests_for_payment?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 Requests for Payment to those belonging to the specified Account. - `account_number_id` (string, optional) Filter Inbound Real-Time Payments Requests for Payment 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": { "address_line2": "Unit 2", "building_number": "33", "city": "New York", "country": "US", "postal_code": "10045", "state": "NY", "street_name": "Liberty Street" }, "name": "National Phonograph Company" }, "creditor_account_number": "987654321", "creditor_routing_number": "101050001", "currency": "USD", "debtor_name": "Ian Crease", "end_to_end_identification": "Invoice 29582", "expires_at": "2020-02-07T23:59:59Z", "fulfillment_real_time_payments_transfer_id": null, "id": "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky", "invoicer_identification": null, "payment_information_identification": "20220501234567891T1BSLZO01745013025", "requested_execution_at": "2020-01-31T23:59:59Z", "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_requests_for_payment/{inbound_real_time_payments_request_for_payment_id} ### Example ```curl curl \ --url "${INCREASE_URL}/inbound_real_time_payments_requests_for_payment/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.