---
title: "Create a Real-Time Payments Request for Payment"
method: POST
path: "/real_time_payments_requests_for_payment"
---

# Create a Real-Time Payments Request for Payment

`POST /real_time_payments_requests_for_payment`

## Request body

- CreateARealTimePaymentsRequestForPaymentParameters
  - `account_number_id` string, required — The identifier of the Account Number where the funds will land.
  - `amount` integer, required — The requested amount in USD cents. Must be positive.
  - `creditor_name` string — The name of the creditor requesting the payment. If not provided, defaults to the name of the account's entity.
  - `debtor` object, required — Details of the person being requested to pay.
    - `address` object, required — Address of the debtor.
      - `address_line2` string — A second address line, such as an apartment or suite number. The first address line is separated into `building_number` and `street_name`.
      - `building_number` string — The number identifying the position of the building on the street.
      - `city` string — The town or city.
      - `country` string, required — The ISO 3166, Alpha-2 country code.
      - `postal_code` string — The postal code or zip.
      - `state` string — The US state component of the address.
      - `street_name` string — The street name without the street number.
    - `name` string, required — The name of the debtor.
  - `debtor_account_number` string, required — The debtor's account number, which the funds will be requested from.
  - `debtor_routing_number` string, required — The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
  - `expires_at` string, date-time, required — 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. Must not be before `requested_execution_at`.
  - `requested_execution_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which you are requesting the payment to be made.
  - `unstructured_remittance_information` string, required — Unstructured information that will show on the recipient's bank statement.

## Response `200`

Real-Time Payments Request for Payment

- RealTimePaymentsRequestForPayment — Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network. A request for payment is a request to the receiver to send funds to your account. The permitted uses of Requests For Payment are limited by the Real-Time Payments network to business-to-business payments and transfers between two accounts at different banks owned by the same individual. Please contact [support@increase.com](mailto:support@increase.com) to enable this API for your team.
  - `account_number_id` string, required — The Account Number in which a successful transfer will arrive.
  - `amount` integer, required — The transfer amount in USD cents.
  - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the request for payment was created.
  - `creditor_name` string, required — The name of the creditor requesting the payment.
  - `currency` 'USD', required — 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`.
  - `debtor` object, required — Details of the person being requested to pay.
    - `address` object, required — Address of the debtor.
      - `address_line2` string, nullable, required — A second address line, such as an apartment or suite number. The first address line is separated into `building_number` and `street_name`.
      - `building_number` string, nullable, required — The number identifying the position of the building on the street.
      - `city` string, nullable, required — The town or city.
      - `country` string, nullable, required — The ISO 3166, Alpha-2 country code.
      - `postal_code` string, nullable, required — The postal code or zip.
      - `state` string, nullable, required — The US state component of the address.
      - `street_name` string, nullable, required — The street name without the street number.
    - `name` string, required — The name of the debtor.
  - `debtor_account_number` string, required — The debtor's account number, which the request is sent to.
  - `debtor_routing_number` string, required — The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
  - `expires_at` string, date-time, required — 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_id` string, nullable, required — The identifier of the Inbound Real-Time Payments Transfer that fulfilled this request.
  - `id` string, required — The Real-Time Payments Request for Payment's identifier.
  - `idempotency_key` string, nullable, required — 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).
  - `refusal` object, nullable, required — If the request for payment is refused by the destination financial institution or the receiving customer, this will contain supplemental details.
    - `refusal_reason_additional_information` string, nullable, required — Additional information about the refusal provided by the recipient bank or the customer. This is typically present when the `refusal_reason_code` is `other`.
    - `refusal_reason_code` 'account_blocked' | 'transaction_forbidden' | 'transaction_type_not_supported' | 'unexpected_amount' | 'amount_exceeds_bank_limits' | 'invalid_debtor_address' | 'invalid_creditor_address' | 'creditor_identifier_incorrect' | 'requested_by_customer' | 'order_rejected' | 'end_customer_deceased' | 'customer_has_opted_out' | 'other', required — The reason the request for payment was refused as provided by the recipient bank or the customer.
    - `refused_at` string, date-time, nullable, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the request for payment was refused.
  - `rejection` object, nullable, required — If the request for payment is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
    - `reject_reason_additional_information` string, nullable, required — Additional information about the rejection provided by the recipient bank or the Real-Time Payments network. This is typically present when the `reject_reason_code` is `narrative`.
    - `reject_reason_code` 'account_closed' | 'account_blocked' | 'invalid_creditor_account_type' | 'invalid_creditor_account_number' | 'invalid_creditor_financial_institution_identifier' | 'end_customer_deceased' | 'narrative' | 'transaction_forbidden' | 'transaction_type_not_supported' | 'unexpected_amount' | 'amount_exceeds_bank_limits' | 'invalid_creditor_address' | 'unknown_end_customer' | 'invalid_debtor_address' | 'timeout' | 'unsupported_message_for_recipient' | 'recipient_connection_not_available' | 'real_time_payments_suspended' | 'instructed_agent_signed_off' | 'processing_error' | 'other', required — The reason the request for payment was rejected as provided by the recipient bank or the Real-Time Payments network.
    - `rejected_at` string, date-time, nullable, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the request for payment was rejected.
  - `requested_execution_at` string, date-time, nullable, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which the payment was requested to be made.
  - `status` 'pending_submission' | 'pending_response' | 'rejected' | 'accepted' | 'refused' | 'fulfilled', required — The lifecycle status of the request for payment.
  - `submission` object, nullable, required — After the request for payment is submitted to Real-Time Payments, this will contain supplemental details.
    - `payment_information_identification` string, required — The Real-Time Payments payment information identification of the request.
  - `type` 'real_time_payments_request_for_payment', required — A constant representing the object's type. For this resource it will always be `real_time_payments_request_for_payment`.
  - `unstructured_remittance_information` string, required — Unstructured information that will show on the recipient's bank statement.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api-2.md) · [All operations](https://skmtc.net/increase/apis/increase-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api-2/revisions/036d178e1a7a/schema)