Real-Time Payments Transfers

Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.

Events

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

The Real-Time Payments Transfer object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "acknowledgement": {
    "acknowledged_at": "2020-01-31T23:59:59Z"
  },
  "amount": 100,
  "approval": null,
  "cancellation": null,
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_name": "National Phonograph Company",
  "external_account_id": null,
  "id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
  "idempotency_key": null,
  "pending_transaction_id": null,
  "rejection": null,
  "routing_number": "101050001",
  "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "status": "complete",
  "submission": {
    "submitted_at": "2020-01-31T23:59:59Z",
    "transaction_identification": "20220501234567891T1BSLZO01745013025"
  },
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "real_time_payments_transfer",
  "ultimate_creditor_name": null,
  "ultimate_debtor_name": null,
  "unstructured_remittance_information": "Invoice 29582"
}

Attributes

account_id

string

The Account from which the transfer was sent.

More about Accounts.

account_number

string

The destination account number.

acknowledgement

dictionary

Nullable

If the transfer is acknowledged by the recipient bank, this will contain supplemental details.

amount

integer

The transfer amount in USD cents.

approval

dictionary

Nullable

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

cancellation

dictionary

Nullable

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

created_at

string

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

created_by

dictionary

Nullable

What object created the transfer, either via the API or the dashboard.

creditor_name

string

The name of the transfer’s recipient. This is set by the sender when creating the transfer.

currency

enum

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

debtor_name

string

Nullable

The name of the transfer’s sender. If not provided, defaults to the name of the account’s entity.

external_account_id

string

Nullable

The identifier of the External Account the transfer was made to, if any.

More about External Accounts.

string

The Real-Time Payments Transfer’s identifier.

idempotency_key

string

Nullable

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.

pending_transaction_id

string

Nullable

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

More about Pending Transactions.

rejection

dictionary

Nullable

If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.

routing_number

string

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

source_account_number_id

string

The Account Number the recipient will see as having sent the transfer.

More about Account Numbers.

status

enum

The lifecycle status of the transfer.

submission

dictionary

Nullable

After the transfer is submitted to Real-Time Payments, this will contain supplemental details.

transaction_id

string

Nullable

The Transaction funding the transfer once it is complete.

More about Transactions.

type

string

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

ultimate_creditor_name

string

Nullable

The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.

ultimate_debtor_name

string

Nullable

The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.

unstructured_remittance_information

string

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

List Real-Time Payments Transfers

curl \
  --url "${INCREASE_URL}/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 realTimePaymentsTransfer of client.realTimePaymentsTransfers.list()) {
  console.log(realTimePaymentsTransfer.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.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.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.RealTimePaymentsTransfers.List(context.TODO(), increase.RealTimePaymentsTransferListParams{})
	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.realtimepaymentstransfers.RealTimePaymentsTransferListPage;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferListParams;

public final class Main {
    private Main() {}

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

        RealTimePaymentsTransferListPage page = client.realTimePaymentsTransfers().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferListPage
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferListParams

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

    val page: RealTimePaymentsTransferListPage = client.realTimePaymentsTransfers().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->realTimePaymentsTransfers->list(
    accountID: 'account_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',
    externalAccountID: 'external_account_id',
    idempotencyKey: 'x',
    limit: 1,
    status: ['in' => ['pending_approval']],
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.RealTimePaymentsTransfers;

IncreaseClient client = new();

RealTimePaymentsTransferListParams parameters = new();

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

Returns a list response :

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

Parameters

account_id

string

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

More about Accounts.

external_account_id

string

Filter Real-Time Payments Transfers to those made to the specified External Account.

More about External Accounts.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

status.in

array of strings

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Create a Real-Time Payments Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/real_time_payments_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_number": "987654321",
    "amount": 100,
    "creditor_name": "Ian Crease",
    "routing_number": "101050001",
    "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "unstructured_remittance_information": "Invoice 29582"
  }'

import Increase from 'increase';

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

const realTimePaymentsTransfer = await client.realTimePaymentsTransfers.create({
  amount: 100,
  creditor_name: 'Ian Crease',
  source_account_number_id: 'account_number_v18nkfqm6afpsrvy82b2',
  unstructured_remittance_information: 'Invoice 29582',
});

console.log(realTimePaymentsTransfer.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
)
real_time_payments_transfer = client.real_time_payments_transfers.create(
    amount=100,
    creditor_name="Ian Crease",
    source_account_number_id="account_number_v18nkfqm6afpsrvy82b2",
    unstructured_remittance_information="Invoice 29582",
)
print(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
)

real_time_payments_transfer = increase.real_time_payments_transfers.create(
  amount: 100,
  creditor_name: "Ian Crease",
  source_account_number_id: "account_number_v18nkfqm6afpsrvy82b2",
  unstructured_remittance_information: "Invoice 29582"
)

puts(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
	)
	realTimePaymentsTransfer, err := client.RealTimePaymentsTransfers.New(context.TODO(), increase.RealTimePaymentsTransferNewParams{
		Amount:                            increase.F(int64(100)),
		CreditorName:                      increase.F("Ian Crease"),
		SourceAccountNumberID:             increase.F("account_number_v18nkfqm6afpsrvy82b2"),
		UnstructuredRemittanceInformation: increase.F("Invoice 29582"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", realTimePaymentsTransfer.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferCreateParams;

public final class Main {
    private Main() {}

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

        RealTimePaymentsTransferCreateParams params = RealTimePaymentsTransferCreateParams.builder()
            .amount(100L)
            .creditorName("Ian Crease")
            .sourceAccountNumberId("account_number_v18nkfqm6afpsrvy82b2")
            .unstructuredRemittanceInformation("Invoice 29582")
            .build();
        RealTimePaymentsTransfer realTimePaymentsTransfer = client.realTimePaymentsTransfers().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.realtimepaymentstransfers.RealTimePaymentsTransfer
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferCreateParams

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

    val params: RealTimePaymentsTransferCreateParams = RealTimePaymentsTransferCreateParams.builder()
        .amount(100L)
        .creditorName("Ian Crease")
        .sourceAccountNumberId("account_number_v18nkfqm6afpsrvy82b2")
        .unstructuredRemittanceInformation("Invoice 29582")
        .build()
    val realTimePaymentsTransfer: RealTimePaymentsTransfer = client.realTimePaymentsTransfers().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 {
  $realTimePaymentsTransfer = $client->realTimePaymentsTransfers->create(
    amount: 100,
    creditorName: 'Ian Crease',
    sourceAccountNumberID: 'account_number_v18nkfqm6afpsrvy82b2',
    unstructuredRemittanceInformation: 'Invoice 29582',
    accountNumber: '987654321',
    debtorName: 'debtor_name',
    externalAccountID: 'external_account_id',
    requireApproval: true,
    routingNumber: '101050001',
    ultimateCreditorName: 'ultimate_creditor_name',
    ultimateDebtorName: 'ultimate_debtor_name',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.RealTimePaymentsTransfers;

IncreaseClient client = new();

RealTimePaymentsTransferCreateParams parameters = new()
{
    Amount = 100,
    CreditorName = "Ian Crease",
    SourceAccountNumberID = "account_number_v18nkfqm6afpsrvy82b2",
    UnstructuredRemittanceInformation = "Invoice 29582",
};

var realTimePaymentsTransfer = await client.RealTimePaymentsTransfers.Create(parameters);

Console.WriteLine(realTimePaymentsTransfer);

Parameters

account_number

string

The destination account number.

Between 1 and 34 characters,

amount

integer

Required

The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.

creditor_name

string

Required

The name of the transfer’s recipient.

Between 1 and 140 characters

debtor_name

string

The name of the transfer’s sender. If not provided, defaults to the name of the account’s entity.

Between 1 and 140 characters,

external_account_id

string

The ID of an External Account to initiate a transfer to. If this parameter is provided, account_number and routing_number must be absent.

More about External Accounts.

require_approval

boolean

Whether the transfer requires explicit approval via the dashboard or API.

routing_number

string

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

Exactly 9 characters,

source_account_number_id

string

Required

The identifier of the Account Number from which to send the transfer.

More about Account Numbers.

ultimate_creditor_name

string

The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.

Between 1 and 140 characters,

ultimate_debtor_name

string

The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.

Between 1 and 140 characters,

unstructured_remittance_information

string

Required

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

Between 1 and 140 characters,

Retrieve a Real-Time Payments Transfer

curl \
  --url "${INCREASE_URL}/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq" \
  -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 realTimePaymentsTransfer = await client.realTimePaymentsTransfers.retrieve(
  'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
);

console.log(realTimePaymentsTransfer.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
)
real_time_payments_transfer = client.real_time_payments_transfers.retrieve(
    "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
)
print(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
)

real_time_payments_transfer = increase.real_time_payments_transfers.retrieve("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")

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

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferRetrieveParams;

public final class Main {
    private Main() {}

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

        RealTimePaymentsTransfer realTimePaymentsTransfer = client.realTimePaymentsTransfers().retrieve("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferRetrieveParams

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

    val realTimePaymentsTransfer: RealTimePaymentsTransfer = client.realTimePaymentsTransfers().retrieve("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")
}

<?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 {
  $realTimePaymentsTransfer = $client->realTimePaymentsTransfers->retrieve(
    'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.RealTimePaymentsTransfers;

IncreaseClient client = new();

RealTimePaymentsTransferRetrieveParams parameters = new()
{
    RealTimePaymentsTransferID = "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
};

var realTimePaymentsTransfer = await client.RealTimePaymentsTransfers.Retrieve(parameters);

Console.WriteLine(realTimePaymentsTransfer);

Parameters

real_time_payments_transfer_id

string

Required

The identifier of the Real-Time Payments Transfer.

More about Real-Time Payments Transfers.

Approve a Real-Time Payments Transfer

Approves a Real-Time Payments Transfer in a pending_approval state.

curl -X "POST" \
  --url "${INCREASE_URL}/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq/approve" \
  -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 realTimePaymentsTransfer = await client.realTimePaymentsTransfers.approve(
  'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
);

console.log(realTimePaymentsTransfer.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
)
real_time_payments_transfer = client.real_time_payments_transfers.approve(
    "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
)
print(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
)

real_time_payments_transfer = increase.real_time_payments_transfers.approve("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")

puts(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
	)
	realTimePaymentsTransfer, err := client.RealTimePaymentsTransfers.Approve(context.TODO(), "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", realTimePaymentsTransfer.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferApproveParams;

public final class Main {
    private Main() {}

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

        RealTimePaymentsTransfer realTimePaymentsTransfer = client.realTimePaymentsTransfers().approve("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferApproveParams

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

    val realTimePaymentsTransfer: RealTimePaymentsTransfer = client.realTimePaymentsTransfers().approve("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")
}

<?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 {
  $realTimePaymentsTransfer = $client->realTimePaymentsTransfers->approve(
    'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.RealTimePaymentsTransfers;

IncreaseClient client = new();

RealTimePaymentsTransferApproveParams parameters = new()
{
    RealTimePaymentsTransferID = "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
};

var realTimePaymentsTransfer = await client.RealTimePaymentsTransfers.Approve(parameters);

Console.WriteLine(realTimePaymentsTransfer);

Parameters

real_time_payments_transfer_id

string

Required

The identifier of the Real-Time Payments Transfer to approve.

More about Real-Time Payments Transfers.

Cancel a pending Real-Time Payments Transfer

Cancels a Real-Time Payments Transfer in a pending_approval state.

curl -X "POST" \
  --url "${INCREASE_URL}/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq/cancel" \
  -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 realTimePaymentsTransfer = await client.realTimePaymentsTransfers.cancel(
  'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
);

console.log(realTimePaymentsTransfer.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
)
real_time_payments_transfer = client.real_time_payments_transfers.cancel(
    "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
)
print(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
)

real_time_payments_transfer = increase.real_time_payments_transfers.cancel("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")

puts(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
	)
	realTimePaymentsTransfer, err := client.RealTimePaymentsTransfers.Cancel(context.TODO(), "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", realTimePaymentsTransfer.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferCancelParams;

public final class Main {
    private Main() {}

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

        RealTimePaymentsTransfer realTimePaymentsTransfer = client.realTimePaymentsTransfers().cancel("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransferCancelParams

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

    val realTimePaymentsTransfer: RealTimePaymentsTransfer = client.realTimePaymentsTransfers().cancel("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")
}

<?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 {
  $realTimePaymentsTransfer = $client->realTimePaymentsTransfers->cancel(
    'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.RealTimePaymentsTransfers;

IncreaseClient client = new();

RealTimePaymentsTransferCancelParams parameters = new()
{
    RealTimePaymentsTransferID = "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
};

var realTimePaymentsTransfer = await client.RealTimePaymentsTransfers.Cancel(parameters);

Console.WriteLine(realTimePaymentsTransfer);

Parameters

real_time_payments_transfer_id

string

Required

The identifier of the pending Real-Time Payments Transfer to cancel.

More about Real-Time Payments Transfers.

Sandbox: Complete a Real-Time Payments Transfer

Simulates submission of a Real-Time Payments Transfer and handling the response from the destination financial institution. This transfer must first have a status of pending_submission.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq/complete" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{}'

import Increase from 'increase';

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

const realTimePaymentsTransfer = await client.simulations.realTimePaymentsTransfers.complete(
  'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
);

console.log(realTimePaymentsTransfer.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
)
real_time_payments_transfer = client.simulations.real_time_payments_transfers.complete(
    real_time_payments_transfer_id="real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
)
print(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
)

real_time_payments_transfer = increase.simulations.real_time_payments_transfers.complete(
  "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq"
)

puts(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
	)
	realTimePaymentsTransfer, err := client.Simulations.RealTimePaymentsTransfers.Complete(
		context.TODO(),
		"real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
		increase.SimulationRealTimePaymentsTransferCompleteParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", realTimePaymentsTransfer.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer;
import com.increase.api.models.simulations.realtimepaymentstransfers.RealTimePaymentsTransferCompleteParams;

public final class Main {
    private Main() {}

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

        RealTimePaymentsTransfer realTimePaymentsTransfer = client.simulations().realTimePaymentsTransfers().complete("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.realtimepaymentstransfers.RealTimePaymentsTransfer
import com.increase.api.models.simulations.realtimepaymentstransfers.RealTimePaymentsTransferCompleteParams

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

    val realTimePaymentsTransfer: RealTimePaymentsTransfer = client.simulations().realTimePaymentsTransfers().complete("real_time_payments_transfer_iyuhl5kdn7ssmup83mvq")
}

<?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 {
  $realTimePaymentsTransfer = $client
    ->simulations
    ->realTimePaymentsTransfers
    ->complete(
    'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
    rejection: ['rejectReasonCode' => 'account_closed'],
  );

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

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

IncreaseClient client = new();

RealTimePaymentsTransferCompleteParams parameters = new()
{
    RealTimePaymentsTransferID = "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq",
};

var realTimePaymentsTransfer = await client.Simulations.RealTimePaymentsTransfers.Complete(parameters);

Console.WriteLine(realTimePaymentsTransfer);

Parameters

real_time_payments_transfer_id

string

Required

The identifier of the Real-Time Payments Transfer you wish to complete.

More about Real-Time Payments Transfers.

rejection

dictionary

If set, the simulation will reject the transfer.