Wire Drawdown Requests

Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty’s bank processes these correctly, we ask that you reach out to support@increase.com to enable this feature so we can help you plan your integration. For more information, see our Wire Drawdown Requests documentation.

Events

Your application can listen to webhooks about this resource. The events about Wire Drawdown Requests will have the categories "wire_drawdown_request.created" or "wire_drawdown_request.updated" .

The Wire Drawdown Request object

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 10000,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_address": {
    "city": "New York",
    "country": "US",
    "line1": "33 Liberty Street",
    "line2": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_account_number": "987654321",
  "debtor_address": {
    "city": "New York",
    "country": "US",
    "line1": "33 Liberty Street",
    "line2": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "debtor_external_account_id": null,
  "debtor_name": "Ian Crease",
  "debtor_routing_number": "101050001",
  "end_to_end_identification": "Invoice 29582",
  "fulfillment_inbound_wire_transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
  "id": "wire_drawdown_request_q6lmocus3glo0lr2bfv3",
  "idempotency_key": null,
  "status": "fulfilled",
  "submission": {
    "input_message_accountability_data": "20220118MMQFMP0P000003"
  },
  "type": "wire_drawdown_request",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
  "unstructured_remittance_information": "Invoice 29582"
}

Attributes

account_number_id

string

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

More about Account Numbers.

amount

integer

The amount being requested in cents.

created_at

string

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

creditor_address

dictionary

The creditor’s address.

creditor_name

string

The creditor’s name.

currency

string

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

debtor_account_number

string

The debtor’s account number.

debtor_address

dictionary

The debtor’s address.

debtor_external_account_id

string

Nullable

The debtor’s external account identifier.

More about External Accounts.

debtor_name

string

The debtor’s name.

debtor_routing_number

string

The debtor’s routing number.

end_to_end_identification

string

Nullable

A free-form reference string set by the sender, to be mirrored back in the subsequent wire transfer.

fulfillment_inbound_wire_transfer_id

string

Nullable

If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.

More about Inbound Wire Transfers.

string

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

status

enum

The lifecycle status of the drawdown request.

submission

dictionary

Nullable

After the drawdown request is submitted to Fedwire, this will contain supplemental details.

type

string

A constant representing the object’s type. For this resource it will always be 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

Remittance information the debtor will see as part of the drawdown request.

Sandbox: Refuse a Wire Drawdown Request

Simulates a Wire Drawdown Request being refused by the debtor.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/wire_drawdown_requests/wire_drawdown_request_q6lmocus3glo0lr2bfv3/refuse" \
  -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 wireDrawdownRequest = await client.simulations.wireDrawdownRequests.refuse(
  'wire_drawdown_request_q6lmocus3glo0lr2bfv3',
);

console.log(wireDrawdownRequest.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
)
wire_drawdown_request = client.simulations.wire_drawdown_requests.refuse(
    "wire_drawdown_request_q6lmocus3glo0lr2bfv3",
)
print(wire_drawdown_request.id)

require "increase"

increase = Increase::Client.new(api_key: "My API Key")

wire_drawdown_request = increase.simulations.wire_drawdown_requests.refuse("wire_drawdown_request_q6lmocus3glo0lr2bfv3")

puts(wire_drawdown_request)

package main

import (
	"context"
	"fmt"

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

func main() {
	client := increase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	wireDrawdownRequest, err := client.Simulations.WireDrawdownRequests.Refuse(context.TODO(), "wire_drawdown_request_q6lmocus3glo0lr2bfv3")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", wireDrawdownRequest.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.simulations.wiredrawdownrequests.WireDrawdownRequestRefuseParams;
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequest;

public final class Main {
    private Main() {}

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

        WireDrawdownRequest wireDrawdownRequest = client.simulations().wireDrawdownRequests().refuse("wire_drawdown_request_q6lmocus3glo0lr2bfv3");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.simulations.wiredrawdownrequests.WireDrawdownRequestRefuseParams
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequest

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

    val wireDrawdownRequest: WireDrawdownRequest = client.simulations().wireDrawdownRequests().refuse("wire_drawdown_request_q6lmocus3glo0lr2bfv3")
}

<?php

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

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

$client = new Client(
  apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);

try {
  $wireDrawdownRequest = $client->simulations->wireDrawdownRequests->refuse(
    'wire_drawdown_request_q6lmocus3glo0lr2bfv3'
  );

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

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

IncreaseClient client = new();

WireDrawdownRequestRefuseParams parameters = new()
{
    WireDrawdownRequestID = "wire_drawdown_request_q6lmocus3glo0lr2bfv3"
};

var wireDrawdownRequest = await client.Simulations.WireDrawdownRequests.Refuse(parameters);

Console.WriteLine(wireDrawdownRequest);

Parameters

wire_drawdown_request_id

string

Required

The identifier of the Wire Drawdown Request you wish to refuse.

More about Wire Drawdown Requests.

Sandbox: Submit a Wire Drawdown Request

Simulates a Wire Drawdown Request being submitted to Fedwire.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/wire_drawdown_requests/wire_drawdown_request_q6lmocus3glo0lr2bfv3/submit" \
  -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 wireDrawdownRequest = await client.simulations.wireDrawdownRequests.submit(
  'wire_drawdown_request_q6lmocus3glo0lr2bfv3',
);

console.log(wireDrawdownRequest.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
)
wire_drawdown_request = client.simulations.wire_drawdown_requests.submit(
    "wire_drawdown_request_q6lmocus3glo0lr2bfv3",
)
print(wire_drawdown_request.id)

require "increase"

increase = Increase::Client.new(api_key: "My API Key")

wire_drawdown_request = increase.simulations.wire_drawdown_requests.submit("wire_drawdown_request_q6lmocus3glo0lr2bfv3")

puts(wire_drawdown_request)

package main

import (
	"context"
	"fmt"

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

func main() {
	client := increase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	wireDrawdownRequest, err := client.Simulations.WireDrawdownRequests.Submit(context.TODO(), "wire_drawdown_request_q6lmocus3glo0lr2bfv3")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", wireDrawdownRequest.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.simulations.wiredrawdownrequests.WireDrawdownRequestSubmitParams;
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequest;

public final class Main {
    private Main() {}

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

        WireDrawdownRequest wireDrawdownRequest = client.simulations().wireDrawdownRequests().submit("wire_drawdown_request_q6lmocus3glo0lr2bfv3");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.simulations.wiredrawdownrequests.WireDrawdownRequestSubmitParams
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequest

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

    val wireDrawdownRequest: WireDrawdownRequest = client.simulations().wireDrawdownRequests().submit("wire_drawdown_request_q6lmocus3glo0lr2bfv3")
}

<?php

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

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

$client = new Client(
  apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);

try {
  $wireDrawdownRequest = $client->simulations->wireDrawdownRequests->submit(
    'wire_drawdown_request_q6lmocus3glo0lr2bfv3'
  );

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

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

IncreaseClient client = new();

WireDrawdownRequestSubmitParams parameters = new()
{
    WireDrawdownRequestID = "wire_drawdown_request_q6lmocus3glo0lr2bfv3"
};

var wireDrawdownRequest = await client.Simulations.WireDrawdownRequests.Submit(parameters);

Console.WriteLine(wireDrawdownRequest);

Parameters

wire_drawdown_request_id

string

Required

The identifier of the Wire Drawdown Request you wish to submit.

More about Wire Drawdown Requests.

List Wire Drawdown Requests

curl \
  --url "${INCREASE_URL}/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 wireDrawdownRequest of client.wireDrawdownRequests.list()) {
  console.log(wireDrawdownRequest.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.wire_drawdown_requests.list()
page = page.data[0]
print(page.id)

require "increase"

increase = Increase::Client.new(api_key: "My API Key")

page = increase.wire_drawdown_requests.list

puts(page)

package main

import (
	"context"
	"fmt"

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

func main() {
	client := increase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.WireDrawdownRequests.List(context.TODO(), increase.WireDrawdownRequestListParams{})
	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.wiredrawdownrequests.WireDrawdownRequestListPage;
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequestListParams;

public final class Main {
    private Main() {}

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

        WireDrawdownRequestListPage page = client.wireDrawdownRequests().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequestListPage
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequestListParams

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

    val page: WireDrawdownRequestListPage = client.wireDrawdownRequests().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') ?: 'My API Key', environment: 'sandbox'
);

try {
  $page = $client->wireDrawdownRequests->list(
    cursor: 'cursor',
    idempotencyKey: 'x',
    limit: 1,
    status: ['in' => ['pending_submission']],
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.WireDrawdownRequests;

IncreaseClient client = new();

WireDrawdownRequestListParams parameters = new();

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

Returns a list response :

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

Parameters

status.in

array of strings

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

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

cursor

string

limit

integer

Create a Wire Drawdown Request

curl -X "POST" \
  --url "${INCREASE_URL}/wire_drawdown_requests" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "amount": 10000,
    "creditor_address": {
      "city": "New York",
      "country": "US",
      "line1": "33 Liberty Street",
      "postal_code": "10045",
      "state": "NY"
    },
    "creditor_name": "National Phonograph Company",
    "debtor_account_number": "987654321",
    "debtor_address": {
      "city": "New York",
      "country": "US",
      "line1": "33 Liberty Street",
      "postal_code": "10045",
      "state": "NY"
    },
    "debtor_name": "Ian Crease",
    "debtor_routing_number": "101050001",
    "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 wireDrawdownRequest = await client.wireDrawdownRequests.create({
  account_number_id: 'account_number_v18nkfqm6afpsrvy82b2',
  amount: 10000,
  creditor_address: {
    city: 'New York',
    country: 'US',
    line1: '33 Liberty Street',
  },
  creditor_name: 'National Phonograph Company',
  debtor_address: {
    city: 'New York',
    country: 'US',
    line1: '33 Liberty Street',
  },
  debtor_name: 'Ian Crease',
  unstructured_remittance_information: 'Invoice 29582',
});

console.log(wireDrawdownRequest.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
)
wire_drawdown_request = client.wire_drawdown_requests.create(
    account_number_id="account_number_v18nkfqm6afpsrvy82b2",
    amount=10000,
    creditor_address={
        "city": "New York",
        "country": "US",
        "line1": "33 Liberty Street",
    },
    creditor_name="National Phonograph Company",
    debtor_address={
        "city": "New York",
        "country": "US",
        "line1": "33 Liberty Street",
    },
    debtor_name="Ian Crease",
    unstructured_remittance_information="Invoice 29582",
)
print(wire_drawdown_request.id)

require "increase"

increase = Increase::Client.new(api_key: "My API Key")

wire_drawdown_request = increase.wire_drawdown_requests.create(
  account_number_id: "account_number_v18nkfqm6afpsrvy82b2",
  amount: 10000,
  creditor_address: {city: "New York", country: "US", line1: "33 Liberty Street"},
  creditor_name: "National Phonograph Company",
  debtor_address: {city: "New York", country: "US", line1: "33 Liberty Street"},
  debtor_name: "Ian Crease",
  unstructured_remittance_information: "Invoice 29582"
)

puts(wire_drawdown_request)

package main

import (
	"context"
	"fmt"

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

func main() {
	client := increase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	wireDrawdownRequest, err := client.WireDrawdownRequests.New(context.TODO(), increase.WireDrawdownRequestNewParams{
		AccountNumberID: increase.F("account_number_v18nkfqm6afpsrvy82b2"),
		Amount:          increase.F(int64(10000)),
		CreditorAddress: increase.F(increase.WireDrawdownRequestNewParamsCreditorAddress{
			City:    increase.F("New York"),
			Country: increase.F("US"),
			Line1:   increase.F("33 Liberty Street"),
		}),
		CreditorName: increase.F("National Phonograph Company"),
		DebtorAddress: increase.F(increase.WireDrawdownRequestNewParamsDebtorAddress{
			City:    increase.F("New York"),
			Country: increase.F("US"),
			Line1:   increase.F("33 Liberty Street"),
		}),
		DebtorName:                        increase.F("Ian Crease"),
		UnstructuredRemittanceInformation: increase.F("Invoice 29582"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", wireDrawdownRequest.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequest;
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequestCreateParams;

public final class Main {
    private Main() {}

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

        WireDrawdownRequestCreateParams params = WireDrawdownRequestCreateParams.builder()
            .accountNumberId("account_number_v18nkfqm6afpsrvy82b2")
            .amount(10000L)
            .creditorAddress(WireDrawdownRequestCreateParams.CreditorAddress.builder()
                .city("New York")
                .country("US")
                .line1("33 Liberty Street")
                .build())
            .creditorName("National Phonograph Company")
            .debtorAddress(WireDrawdownRequestCreateParams.DebtorAddress.builder()
                .city("New York")
                .country("US")
                .line1("33 Liberty Street")
                .build())
            .debtorName("Ian Crease")
            .unstructuredRemittanceInformation("Invoice 29582")
            .build();
        WireDrawdownRequest wireDrawdownRequest = client.wireDrawdownRequests().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.wiredrawdownrequests.WireDrawdownRequest
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequestCreateParams

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

    val params: WireDrawdownRequestCreateParams = WireDrawdownRequestCreateParams.builder()
        .accountNumberId("account_number_v18nkfqm6afpsrvy82b2")
        .amount(10000L)
        .creditorAddress(WireDrawdownRequestCreateParams.CreditorAddress.builder()
            .city("New York")
            .country("US")
            .line1("33 Liberty Street")
            .build())
        .creditorName("National Phonograph Company")
        .debtorAddress(WireDrawdownRequestCreateParams.DebtorAddress.builder()
            .city("New York")
            .country("US")
            .line1("33 Liberty Street")
            .build())
        .debtorName("Ian Crease")
        .unstructuredRemittanceInformation("Invoice 29582")
        .build()
    val wireDrawdownRequest: WireDrawdownRequest = client.wireDrawdownRequests().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') ?: 'My API Key', environment: 'sandbox'
);

try {
  $wireDrawdownRequest = $client->wireDrawdownRequests->create(
    accountNumberID: 'account_number_v18nkfqm6afpsrvy82b2',
    amount: 10000,
    creditorAddress: [
      'city' => 'New York',
      'country' => 'US',
      'line1' => '33 Liberty Street',
      'line2' => 'x',
      'postalCode' => '10045',
      'state' => 'NY',
    ],
    creditorName: 'National Phonograph Company',
    debtorAddress: [
      'city' => 'New York',
      'country' => 'US',
      'line1' => '33 Liberty Street',
      'line2' => 'x',
      'postalCode' => '10045',
      'state' => 'NY',
    ],
    debtorName: 'Ian Crease',
    unstructuredRemittanceInformation: 'Invoice 29582',
    chargeBearer: 'shared',
    debtorAccountNumber: '987654321',
    debtorExternalAccountID: 'debtor_external_account_id',
    debtorRoutingNumber: '101050001',
    endToEndIdentification: 'end_to_end_identification',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.WireDrawdownRequests;

IncreaseClient client = new();

WireDrawdownRequestCreateParams parameters = new()
{
    AccountNumberID = "account_number_v18nkfqm6afpsrvy82b2",
    Amount = 10000,
    CreditorAddress = new()
    {
        City = "New York",
        Country = "US",
        Line1 = "33 Liberty Street",
        Line2 = "x",
        PostalCode = "10045",
        State = "NY",
    },
    CreditorName = "National Phonograph Company",
    DebtorAddress = new()
    {
        City = "New York",
        Country = "US",
        Line1 = "33 Liberty Street",
        Line2 = "x",
        PostalCode = "10045",
        State = "NY",
    },
    DebtorName = "Ian Crease",
    UnstructuredRemittanceInformation = "Invoice 29582",
};

var wireDrawdownRequest = await client.WireDrawdownRequests.Create(parameters);

Console.WriteLine(wireDrawdownRequest);

Parameters

account_number_id

string

Required

The Account Number to which the debtor should send funds.

More about Account Numbers.

amount

integer

Required

The amount requested from the debtor, in USD cents.

charge_bearer

enum

Determines who bears the cost of the drawdown request. Defaults to shared if not specified.

creditor_address

dictionary

Required

The creditor’s address.

creditor_name

string

Required

The creditor’s name.

Between 1 and 140 characters

debtor_account_number

string

The debtor’s account number.

Between 1 and 34 characters,

debtor_address

dictionary

Required

The debtor’s address.

debtor_external_account_id

string

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

More about External Accounts.

debtor_name

string

Required

The debtor’s name.

Between 1 and 140 characters,

debtor_routing_number

string

The debtor’s routing number.

Exactly 9 characters,

end_to_end_identification

string

A free-form reference string set by the sender mirrored back in the subsequent wire transfer.

Between 1 and 35 characters,

unstructured_remittance_information

string

Required

Remittance information the debtor will see as part of the request.

Between 1 and 140 characters,

Retrieve a Wire Drawdown Request

curl \
  --url "${INCREASE_URL}/wire_drawdown_requests/wire_drawdown_request_q6lmocus3glo0lr2bfv3" \
  -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 wireDrawdownRequest = await client.wireDrawdownRequests.retrieve(
  'wire_drawdown_request_q6lmocus3glo0lr2bfv3',
);

console.log(wireDrawdownRequest.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
)
wire_drawdown_request = client.wire_drawdown_requests.retrieve(
    "wire_drawdown_request_q6lmocus3glo0lr2bfv3",
)
print(wire_drawdown_request.id)

require "increase"

increase = Increase::Client.new(api_key: "My API Key")

wire_drawdown_request = increase.wire_drawdown_requests.retrieve("wire_drawdown_request_q6lmocus3glo0lr2bfv3")

puts(wire_drawdown_request)

package main

import (
	"context"
	"fmt"

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

func main() {
	client := increase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	wireDrawdownRequest, err := client.WireDrawdownRequests.Get(context.TODO(), "wire_drawdown_request_q6lmocus3glo0lr2bfv3")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", wireDrawdownRequest.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequest;
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequestRetrieveParams;

public final class Main {
    private Main() {}

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

        WireDrawdownRequest wireDrawdownRequest = client.wireDrawdownRequests().retrieve("wire_drawdown_request_q6lmocus3glo0lr2bfv3");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequest
import com.increase.api.models.wiredrawdownrequests.WireDrawdownRequestRetrieveParams

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

    val wireDrawdownRequest: WireDrawdownRequest = client.wireDrawdownRequests().retrieve("wire_drawdown_request_q6lmocus3glo0lr2bfv3")
}

<?php

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

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

$client = new Client(
  apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);

try {
  $wireDrawdownRequest = $client->wireDrawdownRequests->retrieve(
    'wire_drawdown_request_q6lmocus3glo0lr2bfv3'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.WireDrawdownRequests;

IncreaseClient client = new();

WireDrawdownRequestRetrieveParams parameters = new()
{
    WireDrawdownRequestID = "wire_drawdown_request_q6lmocus3glo0lr2bfv3"
};

var wireDrawdownRequest = await client.WireDrawdownRequests.Retrieve(parameters);

Console.WriteLine(wireDrawdownRequest);

Parameters

wire_drawdown_request_id

string

Required

The identifier of the Wire Drawdown Request to retrieve.

More about Wire Drawdown Requests.