GET
/real_time_payments_requests_for_payment/{real_time_payments_request_for_payment_id}Retrieve a real-time payments request for payment
Retrieves a real-time payments request for payment by its identifier. Use real_time_payments_request_for_payment_id to select the request and review its payment details and status. The response includes the debtor, destination account, amount, and relevant payment dates.
real_time_payments_request_for_payment_idstringrequired
The identifier of the real-time payments request for payment to retrieve.
200Returns the real-time payments request for payment, including its identifier, status, amount, debtor details, destination account, and payment dates.
account_idstringrequired
The Account in which a successful transfer will arrive.
account_number_idstringrequired
The Account Number in which a successful transfer will arrive.
amountintegerrequired
The transfer amount in USD cents.
cancellationobjectrequired
If a cancellation has been requested, this will contain supplemental details. The request for payment moves to `canceled` once the recipient bank acknowledges the cancellation.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the request for payment was created.
creditor_namestringrequired
The name of the creditor requesting the payment.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For real-time payments transfers this is always equal to `USD`.
debtorobjectrequired
Details of the person being requested to pay.
debtor_account_numberstringrequired
The debtor's account number, which the request is sent to.
debtor_routing_numberstringrequired
The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
expires_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/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_idstringrequired
The identifier of the Inbound Real-Time Payments Transfer that fulfilled this request.
idstringrequired
The Real-Time Payments Request for Payment's identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
refusalobjectrequired
If the request for payment is refused by the destination financial institution or the receiving customer, this will contain supplemental details.
rejectionobjectrequired
If the request for payment is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
requested_execution_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which the payment was requested to be made.
statusstringrequired
The lifecycle status of the request for payment.
submissionobjectrequired
After the request for payment is submitted to Real-Time Payments, this will contain supplemental details.
typestringrequired
A constant representing the object's type. For this resource it will always be `real_time_payments_request_for_payment`.
unstructured_remittance_informationstringrequired
Unstructured information that will show on the recipient's bank statement.
4XXReturned when the request cannot be processed because of a client error.
5XXReturned when the server encounters an error processing the request.
Error handling
The real_time_payments_request_for_payment_id path parameter must identify an existing real-time payments request for payment.