Inbound Real-Time Payments Requests for Payment

An Inbound Real-Time Payments Request for Payment is a request initiated outside of Increase for one of your accounts to send a Real-Time Payments transfer.

Events

Your application can listen to webhooks about this resource. The events about Inbound Real-Time Payments Requests for Payment will have the categories "inbound_real_time_payments_request_for_payment.created" or "inbound_real_time_payments_request_for_payment.updated" .

The Inbound Real-Time Payments Request for Payment object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor": {
    "account_name": "National Phonograph Company",
    "address": {
      "address_line2": "Unit 2",
      "building_number": "33",
      "city": "New York",
      "country": "US",
      "postal_code": "10045",
      "state": "NY",
      "street_name": "Liberty Street"
    },
    "name": "National Phonograph Company"
  },
  "creditor_account_number": "987654321",
  "creditor_routing_number": "101050001",
  "currency": "USD",
  "debtor_name": "Ian Crease",
  "end_to_end_identification": "Invoice 29582",
  "expires_at": "2020-02-07T23:59:59Z",
  "fulfillment_real_time_payments_transfer_id": null,
  "id": "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky",
  "invoicer_identification": null,
  "payment_information_identification": "20220501234567891T1BSLZO01745013025",
  "requested_execution_at": "2020-01-31T23:59:59Z",
  "type": "inbound_real_time_payments_request_for_payment",
  "unstructured_remittance_information": "Invoice 29582"
}

Attributes

account_id

string

The Account the request for payment is for.

More about Accounts.

account_number_id

string

The identifier of the Account Number the request for payment is for.

More about Account Numbers.

amount

integer

The requested amount in USD cents.

created_at

string

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

creditor

dictionary

Details of the party requesting payment.

creditor_account_number

string

The creditor’s account number.

creditor_routing_number

string

The creditor’s American Bankers’ Association (ABA) Routing Transit Number (RTN).

currency

enum

The ISO 4217 code of the requested currency. This will always be “USD” for a Real-Time Payments request for payment.

debtor_name

string

The name of the account holder the payment is requested from, as provided by the creditor.

end_to_end_identification

string

A free-form reference string set by the creditor, to help identify the request for payment.

expires_at

string

The ISO 8601 date and time after which the request for payment is no longer valid and should no longer be paid.

fulfillment_real_time_payments_transfer_id

string

Nullable

The identifier of the Real-Time Payments Transfer that fulfilled this request for payment. This is set once a transfer sent in response to the request for payment has been acknowledged by the Real-Time Payments network.

More about Real-Time Payments Transfers.

string

The inbound Real-Time Payments request for payment’s identifier.

invoicer_identification

string

Nullable

An identifier for the party that issued the invoice, for requests for payment sent on behalf of another party.

payment_information_identification

string

The Real-Time Payments network identification of the request for payment.

requested_execution_at

string

Nullable

The ISO 8601 date and time by which the creditor requests the payment to be made.

type

string

A constant representing the object’s type. For this resource it will always be inbound_real_time_payments_request_for_payment.

unstructured_remittance_information

string

Nullable

Unstructured information included with the request for payment.

List Inbound Real-Time Payments Requests for Payment

curl \
  --url "${INCREASE_URL}/inbound_real_time_payments_requests_for_payment?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const inboundRealTimePaymentsRequestForPayment of client.inboundRealTimePaymentsRequestsForPayment.list()) {
  console.log(inboundRealTimePaymentsRequestForPayment.id);
}

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
page = client.inbound_real_time_payments_requests_for_payment.list()
page = page.data[0]
print(page.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

page = increase.inbound_real_time_payments_requests_for_payment.list

puts(page)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	page, err := client.InboundRealTimePaymentsRequestsForPayment.List(context.TODO(), increase.InboundRealTimePaymentsRequestsForPaymentListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundrealtimepaymentsrequestsforpayment.InboundRealTimePaymentsRequestsForPaymentListPage;
import com.increase.api.models.inboundrealtimepaymentsrequestsforpayment.InboundRealTimePaymentsRequestsForPaymentListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        InboundRealTimePaymentsRequestsForPaymentListPage page = client.inboundRealTimePaymentsRequestsForPayment().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundrealtimepaymentsrequestsforpayment.InboundRealTimePaymentsRequestsForPaymentListPage
import com.increase.api.models.inboundrealtimepaymentsrequestsforpayment.InboundRealTimePaymentsRequestsForPaymentListParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val page: InboundRealTimePaymentsRequestsForPaymentListPage = client.inboundRealTimePaymentsRequestsForPayment().list()
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $page = $client->inboundRealTimePaymentsRequestsForPayment->list(
    accountID: 'account_id',
    accountNumberID: 'account_number_id',
    createdAt: [
      'after' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'before' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'onOrAfter' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'onOrBefore' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    ],
    cursor: 'cursor',
    limit: 1,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.InboundRealTimePaymentsRequestsForPayment;

IncreaseClient client = new();

InboundRealTimePaymentsRequestsForPaymentListParams parameters = new();

var page = await client.InboundRealTimePaymentsRequestsForPayment.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

Returns a list response :

{
  "data": [
    { /* Inbound Real-Time Payments Request for Payment object */ },
    { /* Inbound Real-Time Payments Request for Payment object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Inbound Real-Time Payments Requests for Payment to those belonging to the specified Account.

More about Accounts.

account_number_id

string

Filter Inbound Real-Time Payments Requests for Payment to ones belonging to the specified Account Number.

More about Account Numbers.

More parameters

Retrieve an Inbound Real-Time Payments Request for Payment

curl \
  --url "${INCREASE_URL}/inbound_real_time_payments_requests_for_payment/inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const inboundRealTimePaymentsRequestForPayment =
  await client.inboundRealTimePaymentsRequestsForPayment.retrieve(
    'inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky',
  );

console.log(inboundRealTimePaymentsRequestForPayment.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
inbound_real_time_payments_request_for_payment = client.inbound_real_time_payments_requests_for_payment.retrieve(
    "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky",
)
print(inbound_real_time_payments_request_for_payment.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

inbound_real_time_payments_request_for_payment = increase.inbound_real_time_payments_requests_for_payment.retrieve(
  "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky"
)

puts(inbound_real_time_payments_request_for_payment)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	inboundRealTimePaymentsRequestForPayment, err := client.InboundRealTimePaymentsRequestsForPayment.Get(context.TODO(), "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", inboundRealTimePaymentsRequestForPayment.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundrealtimepaymentsrequestsforpayment.InboundRealTimePaymentsRequestForPayment;
import com.increase.api.models.inboundrealtimepaymentsrequestsforpayment.InboundRealTimePaymentsRequestsForPaymentRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        InboundRealTimePaymentsRequestForPayment inboundRealTimePaymentsRequestForPayment = client.inboundRealTimePaymentsRequestsForPayment().retrieve("inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundrealtimepaymentsrequestsforpayment.InboundRealTimePaymentsRequestForPayment
import com.increase.api.models.inboundrealtimepaymentsrequestsforpayment.InboundRealTimePaymentsRequestsForPaymentRetrieveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val inboundRealTimePaymentsRequestForPayment: InboundRealTimePaymentsRequestForPayment = client.inboundRealTimePaymentsRequestsForPayment().retrieve("inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $inboundRealTimePaymentsRequestForPayment = $client
    ->inboundRealTimePaymentsRequestsForPayment
    ->retrieve(
    'inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky'
  );

  var_dump($inboundRealTimePaymentsRequestForPayment);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.InboundRealTimePaymentsRequestsForPayment;

IncreaseClient client = new();

InboundRealTimePaymentsRequestsForPaymentRetrieveParams parameters = new()
{
    InboundRealTimePaymentsRequestForPaymentID = "inbound_real_time_payments_request_for_payment_j9c5rm4hr6qf34en8tky",
};

var inboundRealTimePaymentsRequestForPayment = await client.InboundRealTimePaymentsRequestsForPayment.Retrieve(parameters);

Console.WriteLine(inboundRealTimePaymentsRequestForPayment);

Parameters

inbound_real_time_payments_request_for_payment_id

string

Required

The identifier of the Inbound Real-Time Payments Request for Payment to get details for.

More about Inbound Real-Time Payments Requests for Payment.