Inbound Wire Transfers

An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.

Events

Your application can listen to webhooks about this resource. The events about Inbound Wire Transfers will have the categories "inbound_wire_transfer.created" or "inbound_wire_transfer.updated" .

The Inbound Wire Transfer object

{
  "acceptance": {
    "accepted_at": "2020-01-31T23:59:59Z",
    "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
  },
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_address_line1": "33 Liberty Street",
  "creditor_address_line2": "New York, NY, 10045",
  "creditor_address_line3": null,
  "creditor_name": "National Phonograph Company",
  "debtor_address_line1": "33 Liberty Street",
  "debtor_address_line2": "New York, NY, 10045",
  "debtor_address_line3": null,
  "debtor_name": "Ian Crease",
  "description": "Inbound wire transfer",
  "end_to_end_identification": "Invoice 29582",
  "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
  "input_message_accountability_data": "20220118MMQFMP0P000001",
  "instructing_agent_routing_number": "101050001",
  "instruction_identification": "202201180000001",
  "purpose": "CASH",
  "reversal": null,
  "status": "accepted",
  "type": "inbound_wire_transfer",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
  "unstructured_remittance_information": "INVOICE 2468",
  "wire_drawdown_request_id": null
}

Attributes

acceptance

dictionary

Nullable

If the transfer is accepted, this will contain details of the acceptance.

account_id

string

The Account to which the transfer belongs.

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.

created_at

string

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

creditor_address_line1

string

Nullable

A free-form address field set by the sender.

creditor_address_line2

string

Nullable

A free-form address field set by the sender.

creditor_address_line3

string

Nullable

A free-form address field set by the sender.

creditor_name

string

Nullable

A name set by the sender.

debtor_address_line1

string

Nullable

A free-form address field set by the sender.

debtor_address_line2

string

Nullable

A free-form address field set by the sender.

debtor_address_line3

string

Nullable

A free-form address field set by the sender.

debtor_name

string

Nullable

A name set by the sender.

description

string

An Increase-constructed description of the transfer.

end_to_end_identification

string

Nullable

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

string

The inbound wire transfer’s identifier.

input_message_accountability_data

string

Nullable

A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.

instructing_agent_routing_number

string

Nullable

The American Banking Association (ABA) routing number of the bank that sent the wire.

instruction_identification

string

Nullable

The sending bank’s identifier for the wire transfer.

purpose

string

Nullable

The reason for the wire transfer, as set by the sender.

reversal

dictionary

Nullable

If the transfer is reversed, this will contain details of the reversal.

status

enum

The status of the transfer.

type

string

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

unique_end_to_end_transaction_reference

string

Nullable

The Unique End-to-end Transaction Reference (UETR) of the transfer.

unstructured_remittance_information

string

Nullable

A free-form message set by the sender.

wire_drawdown_request_id

string

Nullable

The wire drawdown request the inbound wire transfer is fulfilling.

More about Wire Drawdown Requests.

List Inbound Wire Transfers

curl \
  --url "${INCREASE_URL}/inbound_wire_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 inboundWireTransfer of client.inboundWireTransfers.list()) {
  console.log(inboundWireTransfer.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_wire_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_wire_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.InboundWireTransfers.List(context.TODO(), increase.InboundWireTransferListParams{})
	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.inboundwiretransfers.InboundWireTransferListPage;
import com.increase.api.models.inboundwiretransfers.InboundWireTransferListParams;

public final class Main {
    private Main() {}

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

        InboundWireTransferListPage page = client.inboundWireTransfers().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundwiretransfers.InboundWireTransferListPage
import com.increase.api.models.inboundwiretransfers.InboundWireTransferListParams

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

    val page: InboundWireTransferListPage = client.inboundWireTransfers().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->inboundWireTransfers->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,
    status: ['in' => ['pending']],
    wireDrawdownRequestID: 'wire_drawdown_request_id',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.InboundWireTransfers;

IncreaseClient client = new();

InboundWireTransferListParams parameters = new();

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

Returns a list response :

{
  "data": [
    { /* Inbound Wire Transfer object */ },
    { /* Inbound Wire Transfer object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Inbound Wire Transfers to ones belonging to the specified Account.

More about Accounts.

account_number_id

string

Filter Inbound Wire Transfers to ones belonging to the specified Account Number.

More about Account Numbers.

status.in

array of strings

Filter Inbound Wire Transfers to those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

wire_drawdown_request_id

string

Filter Inbound Wire Transfers to ones belonging to the specified Wire Drawdown Request.

More about Wire Drawdown Requests.

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 Wire Transfer

curl \
  --url "${INCREASE_URL}/inbound_wire_transfers/inbound_wire_transfer_f228m6bmhtcxjco9pwp0" \
  -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 inboundWireTransfer = await client.inboundWireTransfers.retrieve(
  'inbound_wire_transfer_f228m6bmhtcxjco9pwp0',
);

console.log(inboundWireTransfer.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_wire_transfer = client.inbound_wire_transfers.retrieve(
    "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
)
print(inbound_wire_transfer.id)

require "increase"

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

inbound_wire_transfer = increase.inbound_wire_transfers.retrieve("inbound_wire_transfer_f228m6bmhtcxjco9pwp0")

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

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundwiretransfers.InboundWireTransfer;
import com.increase.api.models.inboundwiretransfers.InboundWireTransferRetrieveParams;

public final class Main {
    private Main() {}

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

        InboundWireTransfer inboundWireTransfer = client.inboundWireTransfers().retrieve("inbound_wire_transfer_f228m6bmhtcxjco9pwp0");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundwiretransfers.InboundWireTransfer
import com.increase.api.models.inboundwiretransfers.InboundWireTransferRetrieveParams

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

    val inboundWireTransfer: InboundWireTransfer = client.inboundWireTransfers().retrieve("inbound_wire_transfer_f228m6bmhtcxjco9pwp0")
}

<?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 {
  $inboundWireTransfer = $client->inboundWireTransfers->retrieve(
    'inbound_wire_transfer_f228m6bmhtcxjco9pwp0'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.InboundWireTransfers;

IncreaseClient client = new();

InboundWireTransferRetrieveParams parameters = new()
{
    InboundWireTransferID = "inbound_wire_transfer_f228m6bmhtcxjco9pwp0"
};

var inboundWireTransfer = await client.InboundWireTransfers.Retrieve(parameters);

Console.WriteLine(inboundWireTransfer);

Parameters

inbound_wire_transfer_id

string

Required

The identifier of the Inbound Wire Transfer to get details for.

More about Inbound Wire Transfers.

Reverse an Inbound Wire Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/inbound_wire_transfers/inbound_wire_transfer_f228m6bmhtcxjco9pwp0/reverse" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "reason": "creditor_request"
  }'

import Increase from 'increase';

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

const inboundWireTransfer = await client.inboundWireTransfers.reverse(
  'inbound_wire_transfer_f228m6bmhtcxjco9pwp0',
  { reason: 'creditor_request' },
);

console.log(inboundWireTransfer.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_wire_transfer = client.inbound_wire_transfers.reverse(
    inbound_wire_transfer_id="inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
    reason="creditor_request",
)
print(inbound_wire_transfer.id)

require "increase"

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

inbound_wire_transfer = increase.inbound_wire_transfers.reverse(
  "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
  reason: :creditor_request
)

puts(inbound_wire_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
	)
	inboundWireTransfer, err := client.InboundWireTransfers.Reverse(
		context.TODO(),
		"inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
		increase.InboundWireTransferReverseParams{
			Reason: increase.F(increase.InboundWireTransferReverseParamsReasonCreditorRequest),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", inboundWireTransfer.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundwiretransfers.InboundWireTransfer;
import com.increase.api.models.inboundwiretransfers.InboundWireTransferReverseParams;

public final class Main {
    private Main() {}

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

        InboundWireTransferReverseParams params = InboundWireTransferReverseParams.builder()
            .inboundWireTransferId("inbound_wire_transfer_f228m6bmhtcxjco9pwp0")
            .reason(InboundWireTransferReverseParams.Reason.CREDITOR_REQUEST)
            .build();
        InboundWireTransfer inboundWireTransfer = client.inboundWireTransfers().reverse(params);
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundwiretransfers.InboundWireTransfer
import com.increase.api.models.inboundwiretransfers.InboundWireTransferReverseParams

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

    val params: InboundWireTransferReverseParams = InboundWireTransferReverseParams.builder()
        .inboundWireTransferId("inbound_wire_transfer_f228m6bmhtcxjco9pwp0")
        .reason(InboundWireTransferReverseParams.Reason.CREDITOR_REQUEST)
        .build()
    val inboundWireTransfer: InboundWireTransfer = client.inboundWireTransfers().reverse(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 {
  $inboundWireTransfer = $client->inboundWireTransfers->reverse(
    'inbound_wire_transfer_f228m6bmhtcxjco9pwp0', reason: 'creditor_request'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.InboundWireTransfers;

IncreaseClient client = new();

InboundWireTransferReverseParams parameters = new()
{
    InboundWireTransferID = "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
    Reason = Reason.CreditorRequest,
};

var inboundWireTransfer = await client.InboundWireTransfers.Reverse(parameters);

Console.WriteLine(inboundWireTransfer);

Parameters

inbound_wire_transfer_id

string

Required

The identifier of the Inbound Wire Transfer to reverse.

More about Inbound Wire Transfers.

reason

enum

Required

Reason for the reversal.

Sandbox: Create an Inbound Wire Transfer

Simulates an Inbound Wire Transfer to your account.

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

import Increase from 'increase';

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

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

console.log(inboundWireTransfer.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_wire_transfer = client.simulations.inbound_wire_transfers.create(
    account_number_id="account_number_v18nkfqm6afpsrvy82b2",
    amount=1000,
)
print(inbound_wire_transfer.id)

require "increase"

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

inbound_wire_transfer = increase.simulations.inbound_wire_transfers.create(
  account_number_id: "account_number_v18nkfqm6afpsrvy82b2",
  amount: 1000
)

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

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundwiretransfers.InboundWireTransfer;
import com.increase.api.models.simulations.inboundwiretransfers.InboundWireTransferCreateParams;

public final class Main {
    private Main() {}

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

        InboundWireTransferCreateParams params = InboundWireTransferCreateParams.builder()
            .accountNumberId("account_number_v18nkfqm6afpsrvy82b2")
            .amount(1000L)
            .build();
        InboundWireTransfer inboundWireTransfer = client.simulations().inboundWireTransfers().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.inboundwiretransfers.InboundWireTransfer
import com.increase.api.models.simulations.inboundwiretransfers.InboundWireTransferCreateParams

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

    val params: InboundWireTransferCreateParams = InboundWireTransferCreateParams.builder()
        .accountNumberId("account_number_v18nkfqm6afpsrvy82b2")
        .amount(1000L)
        .build()
    val inboundWireTransfer: InboundWireTransfer = client.simulations().inboundWireTransfers().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 {
  $inboundWireTransfer = $client->simulations->inboundWireTransfers->create(
    accountNumberID: 'account_number_v18nkfqm6afpsrvy82b2',
    amount: 1000,
    creditorAddressLine1: 'x',
    creditorAddressLine2: 'x',
    creditorAddressLine3: 'x',
    creditorName: 'x',
    debtorAddressLine1: 'x',
    debtorAddressLine2: 'x',
    debtorAddressLine3: 'x',
    debtorName: 'x',
    endToEndIdentification: 'x',
    instructingAgentRoutingNumber: 'x',
    instructionIdentification: 'x',
    purpose: 'x',
    uniqueEndToEndTransactionReference: 'x',
    unstructuredRemittanceInformation: 'x',
    wireDrawdownRequestID: 'wire_drawdown_request_id',
  );

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

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

IncreaseClient client = new();

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

var inboundWireTransfer = await client.Simulations.InboundWireTransfers.Create(parameters);

Console.WriteLine(inboundWireTransfer);

Parameters

account_number_id

string

Required

The identifier of the Account Number the inbound Wire Transfer is for.

More about Account Numbers.

amount

integer

Required

The transfer amount in cents. Must be positive.

creditor_address_line1

string

The sending bank will set creditor_address_line1 in production. You can simulate any value here.

Between 1 and 200 characters

creditor_address_line2

string

The sending bank will set creditor_address_line2 in production. You can simulate any value here.

Between 1 and 200 characters

creditor_address_line3

string

The sending bank will set creditor_address_line3 in production. You can simulate any value here.

Between 1 and 200 characters

creditor_name

string

The sending bank will set creditor_name in production. You can simulate any value here.

Between 1 and 200 characters

debtor_address_line1

string

The sending bank will set debtor_address_line1 in production. You can simulate any value here.

Between 1 and 200 characters

debtor_address_line2

string

The sending bank will set debtor_address_line2 in production. You can simulate any value here.

Between 1 and 200 characters

debtor_address_line3

string

The sending bank will set debtor_address_line3 in production. You can simulate any value here.

Between 1 and 200 characters

debtor_name

string

The sending bank will set debtor_name in production. You can simulate any value here.

Between 1 and 200 characters

end_to_end_identification

string

The sending bank will set end_to_end_identification in production. You can simulate any value here.

Between 1 and 200 characters

instructing_agent_routing_number

string

The sending bank will set instructing_agent_routing_number in production. You can simulate any value here.

Between 1 and 200 characters

instruction_identification

string

The sending bank will set instruction_identification in production. You can simulate any value here.

Between 1 and 200 characters

purpose

string

The sending bank will set purpose in production. You can simulate any value here.

Between 1 and 200 characters

unique_end_to_end_transaction_reference

string

The sending bank will set unique_end_to_end_transaction_reference in production. You can simulate any value here.

Between 1 and 200 characters

unstructured_remittance_information

string

The sending bank will set unstructured_remittance_information in production. You can simulate any value here.

Between 1 and 200 characters

wire_drawdown_request_id

string

The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfilling.

More about Wire Drawdown Requests.