Inbound Real-Time Payments Transfers

An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.

Events

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

The Inbound Real-Time Payments Transfer object

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

Attributes

account_id

string

The Account to which the transfer was sent.

More about Accounts.

account_number_id

string

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

More about Account Numbers.

amount

integer

The amount in USD cents.

confirmation

dictionary

Nullable

If your transfer is confirmed, this will contain details of the confirmation.

created_at

string

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

creditor_name

string

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

currency

enum

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

debtor_account_number

string

The account number of the account that sent the transfer.

debtor_name

string

The name provided by the sender of the transfer.

debtor_routing_number

string

The routing number of the account that sent the transfer.

decline

dictionary

Nullable

If your transfer is declined, this will contain details of the decline.

string

The inbound Real-Time Payments transfer’s identifier.

status

enum

The lifecycle status of the transfer.

transaction_identification

string

The Real-Time Payments network identification of the transfer.

type

string

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

unstructured_remittance_information

string

Nullable

Additional information included with the transfer.

List Inbound Real-Time Payments Transfers

curl \
  --url "${INCREASE_URL}/inbound_real_time_payments_transfers?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 inboundRealTimePaymentsTransfer of client.inboundRealTimePaymentsTransfers.list()) {
  console.log(inboundRealTimePaymentsTransfer.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_transfers.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_transfers.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.InboundRealTimePaymentsTransfers.List(context.TODO(), increase.InboundRealTimePaymentsTransferListParams{})
	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.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransferListPage;
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransferListParams;

public final class Main {
    private Main() {}

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

        InboundRealTimePaymentsTransferListPage page = client.inboundRealTimePaymentsTransfers().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransferListPage
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransferListParams

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

    val page: InboundRealTimePaymentsTransferListPage = client.inboundRealTimePaymentsTransfers().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->inboundRealTimePaymentsTransfers->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.InboundRealTimePaymentsTransfers;

IncreaseClient client = new();

InboundRealTimePaymentsTransferListParams parameters = new();

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

Returns a list response :

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

Parameters

account_id

string

Filter Inbound Real-Time Payments Transfers to those belonging to the specified Account.

More about Accounts.

account_number_id

string

Filter Inbound Real-Time Payments Transfers to ones belonging to the specified Account Number.

More about Account Numbers.

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Retrieve an Inbound Real-Time Payments Transfer

curl \
  --url "${INCREASE_URL}/inbound_real_time_payments_transfers/inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr" \
  -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 inboundRealTimePaymentsTransfer = await client.inboundRealTimePaymentsTransfers.retrieve(
  'inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr',
);

console.log(inboundRealTimePaymentsTransfer.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_transfer = client.inbound_real_time_payments_transfers.retrieve(
    "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr",
)
print(inbound_real_time_payments_transfer.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_transfer = increase.inbound_real_time_payments_transfers.retrieve(
  "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr"
)

puts(inbound_real_time_payments_transfer)

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
	)
	inboundRealTimePaymentsTransfer, err := client.InboundRealTimePaymentsTransfers.Get(context.TODO(), "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", inboundRealTimePaymentsTransfer.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransfer;
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransferRetrieveParams;

public final class Main {
    private Main() {}

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

        InboundRealTimePaymentsTransfer inboundRealTimePaymentsTransfer = client.inboundRealTimePaymentsTransfers().retrieve("inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransfer
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransferRetrieveParams

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

    val inboundRealTimePaymentsTransfer: InboundRealTimePaymentsTransfer = client.inboundRealTimePaymentsTransfers().retrieve("inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr")
}

<?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 {
  $inboundRealTimePaymentsTransfer = $client
    ->inboundRealTimePaymentsTransfers
    ->retrieve('inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr');

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

using System;
using Increase.Api;
using Increase.Api.Models.InboundRealTimePaymentsTransfers;

IncreaseClient client = new();

InboundRealTimePaymentsTransferRetrieveParams parameters = new()
{
    InboundRealTimePaymentsTransferID = "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr",
};

var inboundRealTimePaymentsTransfer = await client.InboundRealTimePaymentsTransfers.Retrieve(parameters);

Console.WriteLine(inboundRealTimePaymentsTransfer);

Parameters

inbound_real_time_payments_transfer_id

string

Required

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

More about Inbound Real-Time Payments Transfers.

Sandbox: Create an Inbound Real-Time Payments Transfer

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

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/inbound_real_time_payments_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "amount": 1000,
    "request_for_payment_id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7"
  }'

import Increase from 'increase';

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

const inboundRealTimePaymentsTransfer =
  await client.simulations.inboundRealTimePaymentsTransfers.create({
    account_number_id: 'account_number_v18nkfqm6afpsrvy82b2',
    amount: 1000,
  });

console.log(inboundRealTimePaymentsTransfer.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_transfer = client.simulations.inbound_real_time_payments_transfers.create(
    account_number_id="account_number_v18nkfqm6afpsrvy82b2",
    amount=1000,
)
print(inbound_real_time_payments_transfer.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_transfer = increase.simulations.inbound_real_time_payments_transfers.create(
  account_number_id: "account_number_v18nkfqm6afpsrvy82b2",
  amount: 1000
)

puts(inbound_real_time_payments_transfer)

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
	)
	inboundRealTimePaymentsTransfer, err := client.Simulations.InboundRealTimePaymentsTransfers.New(context.TODO(), increase.SimulationInboundRealTimePaymentsTransferNewParams{
		AccountNumberID: increase.F("account_number_v18nkfqm6afpsrvy82b2"),
		Amount:          increase.F(int64(1000)),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", inboundRealTimePaymentsTransfer.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransfer;
import com.increase.api.models.simulations.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransferCreateParams;

public final class Main {
    private Main() {}

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

        InboundRealTimePaymentsTransferCreateParams params = InboundRealTimePaymentsTransferCreateParams.builder()
            .accountNumberId("account_number_v18nkfqm6afpsrvy82b2")
            .amount(1000L)
            .build();
        InboundRealTimePaymentsTransfer inboundRealTimePaymentsTransfer = client.simulations().inboundRealTimePaymentsTransfers().create(params);
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransfer
import com.increase.api.models.simulations.inboundrealtimepaymentstransfers.InboundRealTimePaymentsTransferCreateParams

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

    val params: InboundRealTimePaymentsTransferCreateParams = InboundRealTimePaymentsTransferCreateParams.builder()
        .accountNumberId("account_number_v18nkfqm6afpsrvy82b2")
        .amount(1000L)
        .build()
    val inboundRealTimePaymentsTransfer: InboundRealTimePaymentsTransfer = client.simulations().inboundRealTimePaymentsTransfers().create(params)
}

<?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 {
  $inboundRealTimePaymentsTransfer = $client
    ->simulations
    ->inboundRealTimePaymentsTransfers
    ->create(
    accountNumberID: 'account_number_v18nkfqm6afpsrvy82b2',
    amount: 1000,
    debtorAccountNumber: 'x',
    debtorName: 'x',
    debtorRoutingNumber: 'xxxxxxxxx',
    requestForPaymentID: 'real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7',
    unstructuredRemittanceInformation: 'x',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.Simulations.InboundRealTimePaymentsTransfers;

IncreaseClient client = new();

InboundRealTimePaymentsTransferCreateParams parameters = new()
{
    AccountNumberID = "account_number_v18nkfqm6afpsrvy82b2",
    Amount = 1000,
};

var inboundRealTimePaymentsTransfer = await client.Simulations.InboundRealTimePaymentsTransfers.Create(parameters);

Console.WriteLine(inboundRealTimePaymentsTransfer);

Parameters

account_number_id

string

Required

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

More about Account Numbers.

amount

integer

Required

The transfer amount in USD cents. Must be positive.

debtor_account_number

string

The account number of the account that sent the transfer.

Between 1 and 200 characters

debtor_name

string

The name provided by the sender of the transfer.

Between 1 and 200 characters

debtor_routing_number

string

The routing number of the account that sent the transfer.

Exactly 9 characters

request_for_payment_id

string

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

More about Real-Time Payments Request for Payments.

unstructured_remittance_information

string

Additional information included with the transfer.

Between 1 and 140 characters