Sandbox: Create an Inbound Real-Time Payments Transfer

Changed on

Simulates an Inbound Real-Time Payments Transfer to your account. Real-Time Payments are a beta feature.

post/simulations/inbound_real_time_payments_transfers

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/simulations/inbound_real_time_payments_transfers
  • Auth
    HTTP bearer

Request body

account_number_idstring required

The identifier of the Account Number the inbound Real-Time Payments Transfer is for.

amountinteger required

The transfer amount in USD cents. Must be positive.

debtor_account_numberstring

The account number of the account that sent the transfer.

debtor_namestring

The name provided by the sender of the transfer.

debtor_routing_numberstring

The routing number of the account that sent the transfer.

request_for_payment_idstring

The identifier of a pending Request for Payment that this transfer will fulfill.

unstructured_remittance_informationstring

Additional information included with the transfer.

Example request

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 1000,
  "request_for_payment_id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7"
}

Response

Inbound Real-Time Payments Transfer

account_idstring required

The Account to which the transfer was sent.

account_number_idstring required

The identifier of the Account Number to which this transfer was sent.

amountinteger required

The amount in USD cents.

created_atstring date-time required

The ISO 8601 date and time at which the transfer was created.

creditor_namestring required

The name the sender of the transfer specified as the recipient of the transfer.

currency'USD' required

The ISO 4217 code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.

debtor_account_numberstring required

The account number of the account that sent the transfer.

debtor_namestring required

The name provided by the sender of the transfer.

debtor_routing_numberstring required

The routing number of the account that sent the transfer.

end_to_end_identificationstring nullable required

A free-form reference string set by the sender, to help identify the transfer.

idstring required

The inbound Real-Time Payments transfer's identifier.

status'pending_confirming' | 'timed_out' | 'confirmed' | 'declined' required

The lifecycle status of the transfer.

transaction_identificationstring required

The Real-Time Payments network identification of the transfer.

type'inbound_real_time_payments_transfer' required

A constant representing the object's type. For this resource it will always be inbound_real_time_payments_transfer.

unstructured_remittance_informationstring nullable required

Additional information included with the transfer.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "confirmation": {
    "confirmed_at": "2020-01-31T14:00:01Z",
    "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
  },
  "created_at": "2020-01-31T14:00:00Z",
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_account_number": "987654321",
  "debtor_name": "National Phonograph Company",
  "debtor_routing_number": "101050001",
  "decline": null,
  "end_to_end_identification": "Invoice 29582",
  "id": "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr",
  "status": "confirmed",
  "transaction_identification": "20220501234567891T1BSLZO01745013025",
  "type": "inbound_real_time_payments_transfer",
  "unstructured_remittance_information": "Invoice 29582"
}

Changes

  • 8b371fdbea83Revision changes
    • info

      added the required property to the response with the status

  • 19aaa247e0b4Revision changes
    • warning

      added the new transaction_not_allowed enum value to the // response property for the response status