Add a bank account

POST

/v1/bank-accounts/

Adds a new bank account as an off-ramp destination. The type field determines the required fields.

Account Types

Type	Region	Required Fields	Supported Rails
us	United States	routingNumber, accountNumber	ACH, RTP, Wire
ca	Canada	institutionNumber, transitNumber, accountNumber	EFT
uk	United Kingdom	sortCode, accountNumber	FPS
iban	Europe / SEPA	iban, optionally bic	SEPA

Examples

US Bank Account:

{
  "type": "us",
  "ownership": "personal",
  "routingNumber": "021000021",
  "accountNumber": "123456789",
  "accountSubtype": "checking"
}

Canadian Bank Account:

{
  "type": "ca",
  "ownership": "thirdParty",
  "accountHolder": { "firstName": "Jane", "lastName": "Smith" },
  "institutionNumber": "001",
  "transitNumber": "12345",
  "accountNumber": "1234567"
}

IBAN (SEPA) Bank Account:

{
  "type": "iban",
  "ownership": "personal",
  "iban": "DE89370400440532013000"
}

The account will be verified before becoming active.

Authorizations

• bearerAuth
• integratorJwt
• hmacAuth
• integratorKey
• timestamp

Request Body ^required

Create a bank account. The type field determines the required fields.

Any of:

object

US bank account (ACH/Wire)

object

type

required

US bank account type

string

Allowed value: us

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

routingNumber

required

9-digit ABA routing number

string

/^[0-9]{9}$/

accountNumber

required

Bank account number

string

accountSubtype

Any of:

string

string

Allowed value: checking

string

string

Allowed value: savings

label

Friendly name for the account

string

object

Canadian bank account (EFT)

object

type

required

Canadian bank account type

string

Allowed value: ca

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

institutionNumber

required

3-digit financial institution number

string

/^[0-9]{3}$/

transitNumber

required

5-digit branch transit number

string

/^[0-9]{5}$/

accountNumber

required

Bank account number (7-12 digits)

string

accountSubtype

Any of:

string

string

Allowed value: checking

string

string

Allowed value: savings

label

Friendly name for the account

string

object

UK bank account (BACS/FPS)

object

type

required

UK bank account type

string

Allowed value: uk

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

sortCode

required

6-digit sort code

string

/^[0-9]{6}$/

accountNumber

required

8-digit account number

string

/^[0-9]{8}$/

label

Friendly name for the account

string

object

IBAN bank account (SEPA)

object

type

required

IBAN bank account type (SEPA)

string

Allowed value: iban

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

iban

required

International Bank Account Number

string

/^[A-Z]{2}[0-9]{2}[A-Z0-9]{4,30}$/

bic

Bank Identifier Code (SWIFT). Can often be derived from IBAN.

string

/^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/

label

Friendly name for the account

string

Any of:

object

US bank account (ACH/Wire)

object

type

required

US bank account type

string

Allowed value: us

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

routingNumber

required

9-digit ABA routing number

string

/^[0-9]{9}$/

accountNumber

required

Bank account number

string

accountSubtype

Any of:

string

string

Allowed value: checking

string

string

Allowed value: savings

label

Friendly name for the account

string

object

Canadian bank account (EFT)

object

type

required

Canadian bank account type

string

Allowed value: ca

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

institutionNumber

required

3-digit financial institution number

string

/^[0-9]{3}$/

transitNumber

required

5-digit branch transit number

string

/^[0-9]{5}$/

accountNumber

required

Bank account number (7-12 digits)

string

accountSubtype

Any of:

string

string

Allowed value: checking

string

string

Allowed value: savings

label

Friendly name for the account

string

object

UK bank account (BACS/FPS)

object

type

required

UK bank account type

string

Allowed value: uk

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

sortCode

required

6-digit sort code

string

/^[0-9]{6}$/

accountNumber

required

8-digit account number

string

/^[0-9]{8}$/

label

Friendly name for the account

string

object

IBAN bank account (SEPA)

object

type

required

IBAN bank account type (SEPA)

string

Allowed value: iban

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

iban

required

International Bank Account Number

string

/^[A-Z]{2}[0-9]{2}[A-Z0-9]{4,30}$/

bic

Bank Identifier Code (SWIFT). Can often be derived from IBAN.

string

/^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/

label

Friendly name for the account

string

Any of:

object

US bank account (ACH/Wire)

object

type

required

US bank account type

string

Allowed value: us

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

routingNumber

required

9-digit ABA routing number

string

/^[0-9]{9}$/

accountNumber

required

Bank account number

string

accountSubtype

Any of:

string

string

Allowed value: checking

string

string

Allowed value: savings

label

Friendly name for the account

string

object

Canadian bank account (EFT)

object

type

required

Canadian bank account type

string

Allowed value: ca

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

institutionNumber

required

3-digit financial institution number

string

/^[0-9]{3}$/

transitNumber

required

5-digit branch transit number

string

/^[0-9]{5}$/

accountNumber

required

Bank account number (7-12 digits)

string

accountSubtype

Any of:

string

string

Allowed value: checking

string

string

Allowed value: savings

label

Friendly name for the account

string

object

UK bank account (BACS/FPS)

object

type

required

UK bank account type

string

Allowed value: uk

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

sortCode

required

6-digit sort code

string

/^[0-9]{6}$/

accountNumber

required

8-digit account number

string

/^[0-9]{8}$/

label

Friendly name for the account

string

object

IBAN bank account (SEPA)

object

type

required

IBAN bank account type (SEPA)

string

Allowed value: iban

ownership

required

Any of:

string

string

Allowed value: personal

string

string

Allowed value: thirdParty

accountHolder

Account holder details. Required when ownership is “thirdParty”.

object

firstName

required

Account holder first name

string

lastName

required

Account holder last name

string

address

Account holder mailing address

object

street

required

string

street2

string

city

required

string

state

required

string

postalCode

required

string

country

string

iban

required

International Bank Account Number

string

/^[A-Z]{2}[0-9]{2}[A-Z0-9]{4,30}$/

bic

Bank Identifier Code (SWIFT). Can often be derived from IBAN.

string

/^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/

label

Friendly name for the account

string

Responses

201

Bank account details. The type field indicates the account variant.

Any of:

object

US bank account response

object

id

required

Unique identifier for the bank account

string

status

required

Any of:

string

string

Allowed value: active

string

string

Allowed value: pending

string

string

Allowed value: inactive

string

string

Allowed value: rejected

accountHolderName

required

Name of the account holder

string

institution

Financial institution details

object

name

required

Name of the financial institution

string

logo

URL to institution logo

string

supportedRails

required

Payment rails available for this account

Array

label

Friendly name for the account

string

createdAt

required

When the account was created

string format: date-time

type

required

string

Allowed value: us

currency

required

string

Allowed value: USD

accountNumberLast4

required

Last 4 digits of account number

string

routingNumberLast4

required

Last 4 digits of routing number

string

accountSubtype

Any of:

string

string

Allowed value: checking

string

string

Allowed value: savings

object

Canadian bank account response

object

id

required

Unique identifier for the bank account

string

status

required

Any of:

string

string

Allowed value: active

string

string

Allowed value: pending

string

string

Allowed value: inactive

string

string

Allowed value: rejected

accountHolderName

required

Name of the account holder

string

institution

Financial institution details

object

name

required

Name of the financial institution

string

logo

URL to institution logo

string

supportedRails

required

Payment rails available for this account

Array

label

Friendly name for the account

string

createdAt

required

When the account was created

string format: date-time

type

required

string

Allowed value: ca

currency

required

string

Allowed value: CAD

accountNumberLast4

required

Last 4 digits of account number

string

institutionNumber

required

3-digit institution number

string

transitNumberLast3

required

Last 3 digits of transit number

string

accountSubtype

Any of:

string

string

Allowed value: checking

string

string

Allowed value: savings

object

UK bank account response

object

id

required

Unique identifier for the bank account

string

status

required

Any of:

string

string

Allowed value: active

string

string

Allowed value: pending

string

string

Allowed value: inactive

string

string

Allowed value: rejected

accountHolderName

required

Name of the account holder

string

institution

Financial institution details

object

name

required

Name of the financial institution

string

logo

URL to institution logo

string

supportedRails

required

Payment rails available for this account

Array

label

Friendly name for the account

string

createdAt

required

When the account was created

string format: date-time

type

required

string

Allowed value: uk

currency

required

string

Allowed value: GBP

accountNumberLast4

required

Last 4 digits of account number

string

sortCode

required

6-digit sort code (not sensitive)

string

object

IBAN bank account response

object

id

required

Unique identifier for the bank account

string

status

required

Any of:

string

string

Allowed value: active

string

string

Allowed value: pending

string

string

Allowed value: inactive

string

string

Allowed value: rejected

accountHolderName

required

Name of the account holder

string

institution

Financial institution details

object

name

required

Name of the financial institution

string

logo

URL to institution logo

string

supportedRails

required

Payment rails available for this account

Array

label

Friendly name for the account

string

createdAt

required

When the account was created

string format: date-time

type

required

string

Allowed value: iban

currency

required

Any of:

string

string

Allowed value: USD

string

string

Allowed value: CAD

string

string

Allowed value: EUR

string

string

Allowed value: GBP

ibanLast4

required

Last 4 characters of IBAN

string

bic

Bank Identifier Code

string

401

Response for status 401

object

type

A URI reference that identifies the problem type

string

default: about:blank

title

required

A short, human-readable summary of the problem type

string

status

required

The HTTP status code

number

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

realm

The authentication realm

string

scope

The required scope for this resource

string

404

Response for status 404

object

type

A URI reference that identifies the problem type

string

default: about:blank

title

required

A short, human-readable summary of the problem type

string

status

required

The HTTP status code

number

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

resourceType

required

The type of resource that was not found

string

resourceId

required

The identifier of the resource that was not found

string

500

Response for status 500

object

type

A URI reference that identifies the problem type

string

default: about:blank

title

required

A short, human-readable summary of the problem type

string

status

required

The HTTP status code

number

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string