# Inbound Real-Time Payments Transfers > An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account. [Events](https://increase.com/documentation/events.md) will be generated for this resource. The possible event categories are: `inbound_real_time_payments_transfer.created` and `inbound_real_time_payments_transfer.updated`. ## The Inbound Real-Time Payments Transfer object ### Example ```json { "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", "status": "confirmed", "transaction_identification": "20220501234567891T1BSLZO01745013025", "type": "inbound_real_time_payments_transfer", "unstructured_remittance_information": "Invoice 29582" } ``` ### 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. - `confirmation.confirmed_at` (string) The time at which the transfer was confirmed. - `confirmation.transaction_id` (string) The id of the transaction for the confirmed transfer. - `created_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/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](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer. Cases: * `USD` (US Dollar (USD)) - `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. - `decline.declined_at` (string) The time at which the transfer was declined. - `decline.declined_transaction_id` (string) The id of the transaction for the declined transfer. - `decline.reason` (enum) The reason for the transfer decline. Cases: * `account_number_canceled` (The account number is canceled.) * `account_number_disabled` (The account number is disabled.) * `account_restricted` (Your account is restricted.) * `group_locked` (Your account is inactive.) * `entity_not_active` (The account's entity is not active.) * `real_time_payments_not_enabled` (Your account is not enabled to receive Real-Time Payments transfers.) - `id` (string) The inbound Real-Time Payments transfer's identifier. - `status` (enum) The lifecycle status of the transfer. Cases: * `pending_confirming` (The transfer is pending confirmation.) * `timed_out` (The transfer was not responded to in time.) * `confirmed` (The transfer has been received successfully and is confirmed.) * `declined` (The transfer has been declined.) - `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`. - `unstructured_remittance_information` (string, nullable) Additional information included with the transfer. ## List Inbound Real-Time Payments Transfers GET /inbound_real_time_payments_transfers ### Example ```curl curl \ --url "${INCREASE_URL}/inbound_real_time_payments_transfers?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. - `account_id` (string, optional) Filter Inbound Real-Time Payments Transfers to those belonging to the specified Account. - `account_number_id` (string, optional) Filter Inbound Real-Time Payments Transfers 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 Transfer List object: ```json { "data": [ { "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", "status": "confirmed", "transaction_identification": "20220501234567891T1BSLZO01745013025", "type": "inbound_real_time_payments_transfer", "unstructured_remittance_information": "Invoice 29582" } ], "next_cursor": "v57w5d" } ``` ## Retrieve an Inbound Real-Time Payments Transfer GET /inbound_real_time_payments_transfers/{inbound_real_time_payments_transfer_id} ### Example ```curl curl \ --url "${INCREASE_URL}/inbound_real_time_payments_transfers/inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Path 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 POST /simulations/inbound_real_time_payments_transfers > Simulates an [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to your account. Real-Time Payments are a beta feature. ### Example ```curl 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" }' ``` ### Body 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, optional) The account number of the account that sent the transfer. - `debtor_name` (string, optional) The name provided by the sender of the transfer. - `debtor_routing_number` (string, optional) The routing number of the account that sent the transfer. - `request_for_payment_id` (string, optional) The identifier of a pending Request for Payment that this transfer will fulfill. - `unstructured_remittance_information` (string, optional) Additional information included with the transfer.