ACH Prenotifications

ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).

Events

Your application can listen to webhooks about this resource. The events about ACH Prenotifications will have the categories "ach_prenotification.created" or "ach_prenotification.updated" .

The ACH Prenotification object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "addendum": null,
  "company_descriptive_date": null,
  "company_discretionary_data": null,
  "company_entry_description": "Account Funding",
  "company_name": "National Phonograph Company",
  "created_at": "2020-01-31T23:59:59Z",
  "credit_debit_indicator": "credit",
  "effective_date": "2020-01-31T23:59:59Z",
  "id": "ach_prenotification_ubjf9qqsxl3obbcn1u34",
  "idempotency_key": null,
  "individual_id": null,
  "individual_name": "Ian Crease",
  "notifications_of_change": [],
  "prenotification_return": null,
  "routing_number": "101050001",
  "standard_entry_class_code": "corporate_credit_or_debit",
  "status": "submitted",
  "type": "ach_prenotification"
}

Attributes

account_id

string

Nullable

The account that sent the ACH Prenotification.

More about Accounts.

account_number

string

The destination account number.

addendum

string

Nullable

Additional information for the recipient.

company_descriptive_date

string

Nullable

The description of the date of the notification.

company_discretionary_data

string

Nullable

Optional data associated with the notification.

company_entry_description

string

Nullable

The description of the notification.

company_name

string

Nullable

The name by which you know the company.

created_at

string

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

credit_debit_indicator

enum

Nullable

If the notification is for a future credit or debit.

effective_date

string

Nullable

The effective date in ISO 8601 format.

string

The ACH Prenotification’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.

individual_id

string

Nullable

Your identifier for the recipient.

individual_name

string

Nullable

The name of the recipient. This value is informational and not verified by the recipient’s bank.

notifications_of_change

array

If the receiving bank notifies that future transfers should use different details, this will contain those details.

prenotification_return

dictionary

Nullable

If your prenotification is returned, this will contain details of the return.

routing_number

string

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

standard_entry_class_code

enum

Nullable

The Standard Entry Class (SEC) code to use for the ACH Prenotification.

status

enum

The lifecycle status of the ACH Prenotification.

type

string

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

List ACH Prenotifications

curl \
  --url "${INCREASE_URL}/ach_prenotifications" \
  -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 achPrenotification of client.achPrenotifications.list()) {
  console.log(achPrenotification.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.ach_prenotifications.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.ach_prenotifications.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.ACHPrenotifications.List(context.TODO(), increase.ACHPrenotificationListParams{})
	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.achprenotifications.AchPrenotificationListPage;
import com.increase.api.models.achprenotifications.AchPrenotificationListParams;

public final class Main {
    private Main() {}

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

        AchPrenotificationListPage page = client.achPrenotifications().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achprenotifications.AchPrenotificationListPage
import com.increase.api.models.achprenotifications.AchPrenotificationListParams

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

    val page: AchPrenotificationListPage = client.achPrenotifications().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->achPrenotifications->list(
    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',
    idempotencyKey: 'x',
    limit: 1,
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.AchPrenotifications;

IncreaseClient client = new();

AchPrenotificationListParams parameters = new();

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

Returns a list response :

{
  "data": [
    { /* ACH Prenotification object */ },
    { /* ACH Prenotification object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

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

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Create an ACH Prenotification

curl -X "POST" \
  --url "${INCREASE_URL}/ach_prenotifications" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "account_number": "987654321",
    "routing_number": "101050001"
  }'

import Increase from 'increase';

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

const achPrenotification = await client.achPrenotifications.create({
  account_id: 'account_in71c4amph0vgo2qllky',
  account_number: '987654321',
  routing_number: '101050001',
});

console.log(achPrenotification.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
)
ach_prenotification = client.ach_prenotifications.create(
    account_id="account_in71c4amph0vgo2qllky",
    account_number="987654321",
    routing_number="101050001",
)
print(ach_prenotification.id)

require "increase"

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

ach_prenotification = increase.ach_prenotifications.create(
  account_id: "account_in71c4amph0vgo2qllky",
  account_number: "987654321",
  routing_number: "101050001"
)

puts(ach_prenotification)

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
	)
	achPrenotification, err := client.ACHPrenotifications.New(context.TODO(), increase.ACHPrenotificationNewParams{
		AccountID:     increase.F("account_in71c4amph0vgo2qllky"),
		AccountNumber: increase.F("987654321"),
		RoutingNumber: increase.F("101050001"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achPrenotification.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achprenotifications.AchPrenotification;
import com.increase.api.models.achprenotifications.AchPrenotificationCreateParams;

public final class Main {
    private Main() {}

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

        AchPrenotificationCreateParams params = AchPrenotificationCreateParams.builder()
            .accountId("account_in71c4amph0vgo2qllky")
            .accountNumber("987654321")
            .routingNumber("101050001")
            .build();
        AchPrenotification achPrenotification = client.achPrenotifications().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.achprenotifications.AchPrenotification
import com.increase.api.models.achprenotifications.AchPrenotificationCreateParams

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

    val params: AchPrenotificationCreateParams = AchPrenotificationCreateParams.builder()
        .accountId("account_in71c4amph0vgo2qllky")
        .accountNumber("987654321")
        .routingNumber("101050001")
        .build()
    val achPrenotification: AchPrenotification = client.achPrenotifications().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 {
  $achPrenotification = $client->achPrenotifications->create(
    accountID: 'account_in71c4amph0vgo2qllky',
    accountNumber: '987654321',
    routingNumber: '101050001',
    addendum: 'x',
    companyDescriptiveDate: 'x',
    companyDiscretionaryData: 'x',
    companyEntryDescription: 'x',
    companyName: 'x',
    creditDebitIndicator: 'credit',
    effectiveDate: '2019-12-27',
    individualID: 'x',
    individualName: 'x',
    standardEntryClassCode: 'corporate_credit_or_debit',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.AchPrenotifications;

IncreaseClient client = new();

AchPrenotificationCreateParams parameters = new()
{
    AccountID = "account_in71c4amph0vgo2qllky",
    AccountNumber = "987654321",
    RoutingNumber = "101050001",
};

var achPrenotification = await client.AchPrenotifications.Create(parameters);

Console.WriteLine(achPrenotification);

Parameters

account_id

string

Required

The Increase identifier for the account that will send the ACH Prenotification.

More about Accounts.

account_number

string

Required

The account number for the destination account.

Between 1 and 200 characters,

addendum

string

Additional information that will be sent to the recipient.

Between 1 and 80 characters

company_descriptive_date

string

The description of the date of the ACH Prenotification.

Between 1 and 6 characters

company_discretionary_data

string

The data you choose to associate with the ACH Prenotification.

Between 1 and 20 characters

company_entry_description

string

The description you wish to be shown to the recipient.

Between 1 and 10 characters

company_name

string

The name by which the recipient knows you.

Between 1 and 16 characters

credit_debit_indicator

enum

Whether the Prenotification is for a future debit or credit.

effective_date

string

The ACH Prenotification effective date in ISO 8601 format.

individual_id

string

Your identifier for the recipient.

Between 1 and 22 characters

individual_name

string

The name of therecipient. This value is informational and not verified by the recipient’s bank.

Between 1 and 22 characters

routing_number

string

Required

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

Exactly 9 characters,

standard_entry_class_code

enum

The Standard Entry Class (SEC) code to use for the ACH Prenotification.

Retrieve an ACH Prenotification

curl \
  --url "${INCREASE_URL}/ach_prenotifications/ach_prenotification_ubjf9qqsxl3obbcn1u34" \
  -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 achPrenotification = await client.achPrenotifications.retrieve(
  'ach_prenotification_ubjf9qqsxl3obbcn1u34',
);

console.log(achPrenotification.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
)
ach_prenotification = client.ach_prenotifications.retrieve(
    "ach_prenotification_ubjf9qqsxl3obbcn1u34",
)
print(ach_prenotification.id)

require "increase"

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

ach_prenotification = increase.ach_prenotifications.retrieve("ach_prenotification_ubjf9qqsxl3obbcn1u34")

puts(ach_prenotification)

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

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achprenotifications.AchPrenotification;
import com.increase.api.models.achprenotifications.AchPrenotificationRetrieveParams;

public final class Main {
    private Main() {}

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

        AchPrenotification achPrenotification = client.achPrenotifications().retrieve("ach_prenotification_ubjf9qqsxl3obbcn1u34");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achprenotifications.AchPrenotification
import com.increase.api.models.achprenotifications.AchPrenotificationRetrieveParams

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

    val achPrenotification: AchPrenotification = client.achPrenotifications().retrieve("ach_prenotification_ubjf9qqsxl3obbcn1u34")
}

<?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 {
  $achPrenotification = $client->achPrenotifications->retrieve(
    'ach_prenotification_ubjf9qqsxl3obbcn1u34'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.AchPrenotifications;

IncreaseClient client = new();

AchPrenotificationRetrieveParams parameters = new()
{
    AchPrenotificationID = "ach_prenotification_ubjf9qqsxl3obbcn1u34"
};

var achPrenotification = await client.AchPrenotifications.Retrieve(parameters);

Console.WriteLine(achPrenotification);

Parameters

ach_prenotification_id

string

Required

The identifier of the ACH Prenotification to retrieve.

More about ACH Prenotifications.