Inbound Wire Drawdown Requests

Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our Wire Drawdown Requests documentation.

Events

Your application can listen to webhooks about this resource. All of the events about Inbound Wire Drawdown Requests will have the category "inbound_wire_drawdown_request.created" .

The Inbound Wire Drawdown Request object

{
  "amount": 10000,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_account_number": "987654321",
  "creditor_address_line1": "33 Liberty Street",
  "creditor_address_line2": "New York, NY, 10045",
  "creditor_address_line3": null,
  "creditor_name": "Ian Crease",
  "creditor_routing_number": "101050001",
  "currency": "USD",
  "debtor_address_line1": "33 Liberty Street",
  "debtor_address_line2": "New York, NY, 10045",
  "debtor_address_line3": null,
  "debtor_name": "Ian Crease",
  "end_to_end_identification": "Invoice 29582",
  "id": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e",
  "input_message_accountability_data": "20220118MMQFMP0P000001",
  "instruction_identification": "202201180000001",
  "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "type": "inbound_wire_drawdown_request",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
  "unstructured_remittance_information": "INVOICE 2468"
}

Attributes

amount

integer

The amount being requested in cents.

created_at

string

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

creditor_account_number

string

The creditor’s account number.

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.

creditor_routing_number

string

The creditor’s routing number.

currency

string

The ISO 4217 code for the amount being requested. Will always be “USD”.

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.

end_to_end_identification

string

Nullable

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

string

The Wire drawdown request 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.

instruction_identification

string

Nullable

The sending bank’s identifier for the drawdown request.

recipient_account_number_id

string

The Account Number from which the recipient of this request is being requested to send funds.

More about Account Numbers.

type

string

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

unique_end_to_end_transaction_reference

string

Nullable

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

unstructured_remittance_information

string

Nullable

A free-form message set by the sender.

List Inbound Wire Drawdown Requests

curl \
  --url "${INCREASE_URL}/inbound_wire_drawdown_requests" \
  -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 inboundWireDrawdownRequest of client.inboundWireDrawdownRequests.list()) {
  console.log(inboundWireDrawdownRequest.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_drawdown_requests.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_drawdown_requests.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.InboundWireDrawdownRequests.List(context.TODO(), increase.InboundWireDrawdownRequestListParams{})
	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.inboundwiredrawdownrequests.InboundWireDrawdownRequestListPage;
import com.increase.api.models.inboundwiredrawdownrequests.InboundWireDrawdownRequestListParams;

public final class Main {
    private Main() {}

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

        InboundWireDrawdownRequestListPage page = client.inboundWireDrawdownRequests().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundwiredrawdownrequests.InboundWireDrawdownRequestListPage
import com.increase.api.models.inboundwiredrawdownrequests.InboundWireDrawdownRequestListParams

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

    val page: InboundWireDrawdownRequestListPage = client.inboundWireDrawdownRequests().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->inboundWireDrawdownRequests->list(
    cursor: 'cursor', limit: 1
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.InboundWireDrawdownRequests;

IncreaseClient client = new();

InboundWireDrawdownRequestListParams parameters = new();

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

Returns a list response :

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

Parameters

cursor

string

limit

integer

Retrieve an Inbound Wire Drawdown Request

curl \
  --url "${INCREASE_URL}/inbound_wire_drawdown_requests/inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e" \
  -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 inboundWireDrawdownRequest = await client.inboundWireDrawdownRequests.retrieve(
  'inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e',
);

console.log(inboundWireDrawdownRequest.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_drawdown_request = client.inbound_wire_drawdown_requests.retrieve(
    "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e",
)
print(inbound_wire_drawdown_request.id)

require "increase"

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

inbound_wire_drawdown_request = increase.inbound_wire_drawdown_requests.retrieve("inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e")

puts(inbound_wire_drawdown_request)

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

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundwiredrawdownrequests.InboundWireDrawdownRequest;
import com.increase.api.models.inboundwiredrawdownrequests.InboundWireDrawdownRequestRetrieveParams;

public final class Main {
    private Main() {}

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

        InboundWireDrawdownRequest inboundWireDrawdownRequest = client.inboundWireDrawdownRequests().retrieve("inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.inboundwiredrawdownrequests.InboundWireDrawdownRequest
import com.increase.api.models.inboundwiredrawdownrequests.InboundWireDrawdownRequestRetrieveParams

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

    val inboundWireDrawdownRequest: InboundWireDrawdownRequest = client.inboundWireDrawdownRequests().retrieve("inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e")
}

<?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 {
  $inboundWireDrawdownRequest = $client->inboundWireDrawdownRequests->retrieve(
    'inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.InboundWireDrawdownRequests;

IncreaseClient client = new();

InboundWireDrawdownRequestRetrieveParams parameters = new()
{
    InboundWireDrawdownRequestID = "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e",
};

var inboundWireDrawdownRequest = await client.InboundWireDrawdownRequests.Retrieve(parameters);

Console.WriteLine(inboundWireDrawdownRequest);

Parameters

inbound_wire_drawdown_request_id

string

Required

The identifier of the Inbound Wire Drawdown Request to retrieve.

More about Inbound Wire Drawdown Requests.

Sandbox: Create an Inbound Wire Drawdown request

Simulates receiving an Inbound Wire Drawdown Request.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/inbound_wire_drawdown_requests" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 10000,
    "creditor_account_number": "987654321",
    "creditor_address_line1": "33 Liberty Street",
    "creditor_address_line2": "New York, NY, 10045",
    "creditor_name": "Ian Crease",
    "creditor_routing_number": "101050001",
    "currency": "USD",
    "debtor_account_number": "987654321",
    "debtor_address_line1": "33 Liberty Street",
    "debtor_address_line2": "New York, NY, 10045",
    "debtor_name": "Ian Crease",
    "debtor_routing_number": "101050001",
    "instruction_identification": null,
    "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2"
  }'

import Increase from 'increase';

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

const inboundWireDrawdownRequest = await client.simulations.inboundWireDrawdownRequests.create({
  amount: 10000,
  creditor_account_number: '987654321',
  creditor_routing_number: '101050001',
  currency: 'USD',
  recipient_account_number_id: 'account_number_v18nkfqm6afpsrvy82b2',
});

console.log(inboundWireDrawdownRequest.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_drawdown_request = client.simulations.inbound_wire_drawdown_requests.create(
    amount=10000,
    creditor_account_number="987654321",
    creditor_routing_number="101050001",
    currency="USD",
    recipient_account_number_id="account_number_v18nkfqm6afpsrvy82b2",
)
print(inbound_wire_drawdown_request.id)

require "increase"

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

inbound_wire_drawdown_request = increase.simulations.inbound_wire_drawdown_requests.create(
  amount: 10000,
  creditor_account_number: "987654321",
  creditor_routing_number: "101050001",
  currency: "USD",
  recipient_account_number_id: "account_number_v18nkfqm6afpsrvy82b2"
)

puts(inbound_wire_drawdown_request)

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
	)
	inboundWireDrawdownRequest, err := client.Simulations.InboundWireDrawdownRequests.New(context.TODO(), increase.SimulationInboundWireDrawdownRequestNewParams{
		Amount:                   increase.F(int64(10000)),
		CreditorAccountNumber:    increase.F("987654321"),
		CreditorRoutingNumber:    increase.F("101050001"),
		Currency:                 increase.F("USD"),
		RecipientAccountNumberID: increase.F("account_number_v18nkfqm6afpsrvy82b2"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", inboundWireDrawdownRequest.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.inboundwiredrawdownrequests.InboundWireDrawdownRequest;
import com.increase.api.models.simulations.inboundwiredrawdownrequests.InboundWireDrawdownRequestCreateParams;

public final class Main {
    private Main() {}

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

        InboundWireDrawdownRequestCreateParams params = InboundWireDrawdownRequestCreateParams.builder()
            .amount(10000L)
            .creditorAccountNumber("987654321")
            .creditorRoutingNumber("101050001")
            .currency("USD")
            .recipientAccountNumberId("account_number_v18nkfqm6afpsrvy82b2")
            .build();
        InboundWireDrawdownRequest inboundWireDrawdownRequest = client.simulations().inboundWireDrawdownRequests().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.inboundwiredrawdownrequests.InboundWireDrawdownRequest
import com.increase.api.models.simulations.inboundwiredrawdownrequests.InboundWireDrawdownRequestCreateParams

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

    val params: InboundWireDrawdownRequestCreateParams = InboundWireDrawdownRequestCreateParams.builder()
        .amount(10000L)
        .creditorAccountNumber("987654321")
        .creditorRoutingNumber("101050001")
        .currency("USD")
        .recipientAccountNumberId("account_number_v18nkfqm6afpsrvy82b2")
        .build()
    val inboundWireDrawdownRequest: InboundWireDrawdownRequest = client.simulations().inboundWireDrawdownRequests().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 {
  $inboundWireDrawdownRequest = $client
    ->simulations
    ->inboundWireDrawdownRequests
    ->create(
    amount: 10000,
    creditorAccountNumber: '987654321',
    creditorRoutingNumber: '101050001',
    currency: 'USD',
    recipientAccountNumberID: 'account_number_v18nkfqm6afpsrvy82b2',
    creditorAddressLine1: '33 Liberty Street',
    creditorAddressLine2: 'New York, NY, 10045',
    creditorAddressLine3: 'x',
    creditorName: 'Ian Crease',
    debtorAccountNumber: '987654321',
    debtorAddressLine1: '33 Liberty Street',
    debtorAddressLine2: 'New York, NY, 10045',
    debtorAddressLine3: 'x',
    debtorName: 'Ian Crease',
    debtorRoutingNumber: '101050001',
    endToEndIdentification: 'x',
    instructionIdentification: 'x',
    uniqueEndToEndTransactionReference: 'x',
    unstructuredRemittanceInformation: 'x',
  );

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

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

IncreaseClient client = new();

InboundWireDrawdownRequestCreateParams parameters = new()
{
    Amount = 10000,
    CreditorAccountNumber = "987654321",
    CreditorRoutingNumber = "101050001",
    Currency = "USD",
    RecipientAccountNumberID = "account_number_v18nkfqm6afpsrvy82b2",
};

var inboundWireDrawdownRequest = await client.Simulations.InboundWireDrawdownRequests.Create(parameters);

Console.WriteLine(inboundWireDrawdownRequest);

Parameters

amount

integer

Required

The amount being requested in cents.

creditor_account_number

string

Required

The creditor’s account number.

Between 1 and 200 characters

creditor_address_line1

string

A free-form address field set by the sender representing the first line of the creditor’s address.

Between 1 and 200 characters

creditor_address_line2

string

A free-form address field set by the sender representing the second line of the creditor’s address.

Between 1 and 200 characters

creditor_address_line3

string

A free-form address field set by the sender representing the third line of the creditor’s address.

Between 1 and 200 characters

creditor_name

string

A free-form name field set by the sender representing the creditor’s name.

Between 1 and 200 characters

creditor_routing_number

string

Required

The creditor’s routing number.

Between 1 and 200 characters

currency

string

Required

The ISO 4217 code for the amount being requested. Will always be “USD”.

Between 1 and 200 characters

debtor_account_number

string

The debtor’s account number.

Between 1 and 200 characters

debtor_address_line1

string

A free-form address field set by the sender representing the first line of the debtor’s address.

Between 1 and 200 characters

debtor_address_line2

string

A free-form address field set by the sender representing the second line of the debtor’s address.

Between 1 and 200 characters

debtor_address_line3

string

A free-form address field set by the sender.

Between 1 and 200 characters

debtor_name

string

A free-form name field set by the sender representing the debtor’s name.

Between 1 and 200 characters

debtor_routing_number

string

The debtor’s routing number.

Between 1 and 200 characters

end_to_end_identification

string

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

Between 1 and 200 characters

instruction_identification

string

The sending bank’s identifier for the wire transfer.

Between 1 and 200 characters

recipient_account_number_id

string

Required

The Account Number to which the recipient of this request is being requested to send funds from.

More about Account Numbers.

unique_end_to_end_transaction_reference

string

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

Between 1 and 200 characters

unstructured_remittance_information

string

A free-form message set by the sender.

Between 1 and 200 characters