latestOpenAPI 3.1.02026-08-152492433.9 MB

036d178e1a7a

Create a Real-Time Payments Request for Payment

post/real_time_payments_requests_for_payment

Request body

account_number_idstring required

The identifier of the Account Number where the funds will land.

amountinteger required

The requested amount in USD cents. Must be positive.

creditor_namestring

The name of the creditor requesting the payment. If not provided, defaults to the name of the account's entity.

debtor_account_numberstring required

The debtor's account number, which the funds will be requested from.

debtor_routing_numberstring required

The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).

expires_atstring date-time required

The 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_atstring date-time required

The ISO 8601 date and time by which you are requesting the payment to be made.

unstructured_remittance_informationstring required

Unstructured information that will show on the recipient's bank statement.

Example request

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "creditor_name": "National Phonograph Company",
  "debtor": {
    "address": {
      "country": "US",
      "street_name": "Liberty Street"
    },
    "name": "Ian Crease"
  },
  "debtor_account_number": "987654321",
  "debtor_routing_number": "101050001",
  "expires_at": "2020-02-14T23:59:59+00:00",
  "requested_execution_at": "2020-02-07T23:59:59+00:00",
  "unstructured_remittance_information": "Invoice 29582"
}

Response

Real-Time Payments Request for Payment

account_number_idstring required

The Account Number in which a successful transfer will arrive.

amountinteger required

The transfer amount in USD cents.

created_atstring date-time required

The ISO 8601 date and time at which the request for payment was created.

creditor_namestring required

The name of the creditor requesting the payment.

currency'USD' required

The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.

debtor_account_numberstring required

The debtor's account number, which the request is sent to.

debtor_routing_numberstring required

The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).

expires_atstring date-time required

The 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_idstring nullable required

The identifier of the Inbound Real-Time Payments Transfer that fulfilled this request.

idstring required

The Real-Time Payments Request for Payment's identifier.

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

requested_execution_atstring date-time nullable required

The ISO 8601 date and time by which the payment was requested to be made.

The lifecycle status of the request for payment.

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_informationstring required

Unstructured information that will show on the recipient's bank statement.

Example response

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_name": "National Phonograph Company",
  "currency": "USD",
  "debtor": {
    "address": {
      "address_line2": "Unit 2",
      "building_number": "33",
      "city": "New York",
      "country": "US",
      "postal_code": "10045",
      "state": "NY",
      "street_name": "Liberty Street"
    },
    "name": "Ian Crease"
  },
  "debtor_account_number": "987654321",
  "debtor_routing_number": "101050001",
  "expires_at": "2020-02-14T23:59:59+00:00",
  "fulfillment_inbound_real_time_payments_transfer_id": null,
  "id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7",
  "idempotency_key": null,
  "refusal": null,
  "rejection": null,
  "requested_execution_at": "2020-02-07T23:59:59+00:00",
  "status": "pending_response",
  "submission": null,
  "type": "real_time_payments_request_for_payment",
  "unstructured_remittance_information": "Invoice 29582"
}