Person Entity object
An entity represents a person or organization possessing separate and distinct legal rights. You will create entities for each of your customers or users. An entity is required to create a bank account or a loan object. Read about entities in our data model section for more information.
object parameters
person_details
object
Contains all person details of the legal person entity. Only returned when entity type is PERSON.
first_name
string
First name of the legal person
last_name
string
Last name of the legal person
middle_name
string
Middle name of the legal person
ssn
string
Social Security Number
passport
object
Passport Number (only required if SSN is not used)
number
string
Passport number
country_code
string
Country code where the passport was issued
date_of_birth
string
Date of birth (YYYY-MM-DD)
string
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
address
object
line_1
string
Address line 1
line_2
string
Address line 2
city
string
City
state
string
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Postal code
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
documents
array of objects
List of documents which are uploaded with the Submit Document API
id
string
Unique identifier for the object
is_root
boolean
Indicates if the entity is the root entity of the platform.
review_reasons
array
List of reasons the entity is in Manual_Review
type
string
Type of entity. PERSON for a person entity.
verification_status
array
Current status of the entity verification. Can be UNVERIFIED, PENDING,MANUAL_REVIEW, VERIFIED, or DENIED
verification_tags
string
A list of verification tags with more details about its identity verification process.
Person Entity object
Business Entity object
A business entity represents a legal business in the Column data model.
object parameters
business_details
object
Contains all business details of the legal business entity. Only returned when entity type is BUSINESS.
address
object
line_1
string
Address line 1
line_2
string
Address line 2
city
string
City
state
string
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Postal code
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
beneficial_owners
array of objects
Contains all beneficial owners of an entity.
first_name
string
First name of the legal person
last_name
string
Last name of the legal person
middle_name
string
Middle name of the legal person
ssn
string
Social Security Number is required for US beneficial owners. Passport, driver's license, or national ID is required for foreign beneficial owners.
passport
object
Passport Number. SSN, passport, driver's license, or national ID is required.
number
string
Passport number
country_code
string
Country code where the passport was issued
drivers_license
object
Driver's license. SSN, passport, driver's license, or national ID is required.
number
string
Driver's license number
country_code
string
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
national_id
object
National ID. SSN, passport, driver's license, or national ID is required.
number
string
National ID number
country_code
string
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Date of birth (YYYY-MM-DD)
string
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
is_control_person
boolean
Boolean value which specifies if this person is a designated control person.
is_beneficial_owner
boolean
Boolean value which specifies if this person is a designated beneficial owner.
ownership_percentage
integer
Percentage ownership, specified as a integer, of the beneficial owner
job_title
string
Job title of the beneficial owner or control person.
address
object
line_1
string
Address line 1
line_2
string
Address line 2
city
string
City
state
string
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Postal code
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
business_name
string
Legal Business Name
ein
string
Employer Identification Number (Tax ID). This may be SSN for a sole proprietorship.
registration_id
object
Registration ID. EIN or Registration ID is required.
number
string
Business registration ID
country_code
string
Country code where the business registration ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
industry
string
Industry in which the business entity operates.
website
string
Website of the business. Optional, but highly encouraged as it will increase likelihood of an automated verification.
legal_type
string
Type of business. Permitted values are limited-partnership, trust, sole-proprietorship, corporation,llc, general-partnership, professional-association, other.
state_of_incorporation
string
State in which the business is incorporated. Only postal abbreviations (e.g. AL, CA, DE, ...) are allowed. Only required for a root entity.
date_of_incorporation
string
Date on which the business entity was incorporated. Only required for a root entity.
account_usage
array of strings
Indicates possible uses of the accounts an entity may use at Column. Only required for a root entity.
description
string
Description of the business entity. Only required for a root entity.
payment_volumes
string
Expected payment volumes. Only required for a root entity.
countries_of_operation
array of strings
Countries in which the business currently operates or expects to operate. Only ISO 3166-1 Alpha-2 Country Codes (e.g., US, FR, UK, DE, ...) are allowed. Only required for a root entity.
is_root
boolean
Indicates if the entity is the root entity of the platform.
documents
array of objects
List of documents which are uploaded with the Submit Document API
id
string
Unique identifier for the object
review_reasons
array
List of reasons the entity is in Manual_Review
type
string
Type of entity. BUSINESS for a business entity.
verification_status
array
Current status of the entity verification. Can be UNVERIFIED, PENDING,MANUAL_REVIEW, VERIFIED, or DENIED
verification_tags
string
A list of verification tags with more details about its identity verification process.
Entity object
Create a legal person entity
POST
/entities/person
Creates a legal person entity.
body parameters
first_name
string
Required
First name of the legal person
last_name
string
Required
Last name of the legal person
middle_name
string
Optional
Middle name of the legal person
ssn
string
Required
Social Security Number
passport
object
Required
Passport Number (only required if SSN is not used)
number
string
Required
Passport number
country_code
string
Required
Country code where the passport was issued
date_of_birth
string
Required
Date of birth (YYYY-MM-DD)
string
Optional
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
address
object
Required
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Update a legal person entity
PATCH
/entities/person/<entity_id>
Update the information stored for a legal person. Do not use this to change the underlying legal person - only use this if the actual personal information changes (e.g. legal name changes, etc.).
path parameters
entity_id
string
Required
ID of the person entity you're updating
body parameters
first_name
string
Required
First name of the legal person
last_name
string
Required
Last name of the legal person
middle_name
string
Optional
Middle name of the legal person
ssn
string
Required
Social Security Number
passport
object
Required
Passport Number (only required if SSN is not used)
number
string
Required
Passport number
country_code
string
Required
Country code where the passport was issued
date_of_birth
string
Required
Date of birth (YYYY-MM-DD)
string
Optional
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
address
object
Required
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Create a legal business entity
POST
/entities/business
Creates a legal business entity.
body parameters
ein
string
Required
Employer Identification Number (Tax ID)
business_name
string
Required
Legal Business Name
website
string
Optional
Website of the business. Optional, but highly encouraged as it will increase likelihood of an automated verification.
legal_type
string
Optional
Type of business. Permitted values are limited-partnership, trust, sole-proprietorship, corporation,llc, general-partnership, professional-association, other.
address
object
Required
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
beneficial_owners
array of objects
Required
A list of all the persons who have ultimate control over funds in the business, whether through ownership or other means.
This is anyone who owns owns 25 percent or more of the business and those who control the funds. If no one owns more than 25% of the business, just the individual who has ultimate control of the funds must be included.
beneficial_owners
array of objects
Required
Contains all beneficial owners of an entity.
first_name
string
Required
First name of the legal person
last_name
string
Required
Last name of the legal person
middle_name
string
Optional
Middle name of the legal person
ssn
string
Optional
Social Security Number is required for US beneficial owners. Passport, driver's license, or national ID is required for foreign beneficial owners.
passport
object
Optional
Passport Number. SSN, passport, driver's license, or national ID is required.
number
string
Required
Passport number
country_code
string
Required
Country code where the passport was issued
drivers_license
object
Optional
Driver's license. SSN, passport, driver's license, or national ID is required.
number
string
Required
Driver's license number
country_code
string
Required
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
national_id
object
Optional
National ID. SSN, passport, driver's license, or national ID is required.
number
string
Required
National ID number
country_code
string
Required
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Required
Date of birth (YYYY-MM-DD)
string
Optional
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
is_control_person
boolean
Required
Boolean value which specifies if this person is a designated control person.
is_beneficial_owner
boolean
Required
Boolean value which specifies if this person is a designated beneficial owner.
ownership_percentage
integer
Optional
Percentage ownership, specified as a integer, of the beneficial owner
job_title
string
Optional
Job title of the beneficial owner or control person.
address
object
Required
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Update a legal business entity
PATCH
/entities/business/<entity_id>
This updates the information stored for this legal person. Changes to ssn, date of birth, and name will cause a re-verification process. Do not use this to change the underlying legal person - only use this if the actual personal information changes (e.g. legal name changes, etc.).
path parameters
entity_id
string
Required
ID of the business entity you're updating
body parameters
business_name
string
Required
Legal Business Name
website
string
Optional
Website of the business. Optional, but highly encouraged as it will increase likelihood of an automated verification.
address
object
Required
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
beneficial_owners
array of objects
Optional
A list of all the persons who have ultimate control over funds in the business, whether through ownership or other means.
This is anyone who owns owns 25 percent or more of the business and those who control the funds. If no one owns more than 25% of the business, just the individual who has ultimate control of the funds must be included.
beneficial_owners
array of objects
Required
Contains all beneficial owners of an entity.
first_name
string
Required
First name of the legal person
last_name
string
Required
Last name of the legal person
middle_name
string
Optional
Middle name of the legal person
ssn
string
Optional
Social Security Number is required for US beneficial owners. Passport, driver's license, or national ID is required for foreign beneficial owners.
passport
object
Optional
Passport Number. SSN, passport, driver's license, or national ID is required.
number
string
Required
Passport number
country_code
string
Required
Country code where the passport was issued
drivers_license
object
Optional
Driver's license. SSN, passport, driver's license, or national ID is required.
number
string
Required
Driver's license number
country_code
string
Required
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
national_id
object
Optional
National ID. SSN, passport, driver's license, or national ID is required.
number
string
Required
National ID number
country_code
string
Required
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Required
Date of birth (YYYY-MM-DD)
string
Optional
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
is_control_person
boolean
Required
Boolean value which specifies if this person is a designated control person.
is_beneficial_owner
boolean
Required
Boolean value which specifies if this person is a designated beneficial owner.
ownership_percentage
integer
Optional
Percentage ownership, specified as a integer, of the beneficial owner
job_title
string
Optional
Job title of the beneficial owner or control person.
address
object
Required
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Get an entity by ID
GET
/entities/<entity_id>
Retrieve a single legal entity by its ID.
path parameters
entity_id
string
Required
ID of the entity you're requesting. Depending on the entity type, either the business or person object will be returned.
Request
Response
Delete an entity
DELETE
/entities/<entity_id>
Delete the underlying entity.
Removing entities
Entities can only be deleted if all their underlying accounts are deleted. Accounts can only be deleted when they have a $0 balance.
path parameters
entity_id
string
Required
ID of the entity you're deleting.
Request
Response
List all entities
GET
/entities
Retrieve all entities on your platform. Filtered results can be retrieved with extra parameters in the query (`type`, `name`, etc.).
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
type
string
Optional
Return results with this entity type, either PERSON or BUSINESS.
verification_status
string
Optional
Return results with this verification status.
is_root
boolean
Optional
Indicates if the entity is the root entity of the platform.
name
string
Optional
Return entities with this name.
Request
Response
Submit a document
POST
/entities/<entity_id>/documents
Submit a supporting document for manual review of an entity.
path parameters
entity_id
string
Required
ID of the entity for which a supporting document is being submitted.
body parameters
document_front_id
string
Required
ID of the entity for which a supporting document is being submitted.
Accepted formats for person entities: PNG, JPEG, GIF, and TIFF.
document_back_id
string
Optional
ID of the back of the document that is being submitted, starting with docu_. The document must be uploaded first via Document Upload API. This is only required for some forms of documentation. For most documents, only the front side is required.
Accepted formats for person entities: PNG, JPEG, GIF, and TIFF.
description
string
Optional
Description of why the document is being submitted for review. Maximum length: 127 characters.
Request
Response
Bank Account object
A bank account is the object in the Column data model that has the ability to hold, send, and receive funds. Bank accounts are children of entities. An entity can have multiple bank accounts. Bank accounts can have one or multiple account numbers. Read about bank accounts in our data model section for more information.
object parameters
balances
object
Lists all possible balance amounts for an account represented in the smallest unit of the currency.
available_amount
int64
This balance is the amount of money that is available to spend. If the account is not enabled for overdrafts, any requests to move money above this number will fail.
holding_amount
int64
The balance of money which is currently in a HOLD state specified in the Create Book Transfer API.
pending_amount
int64
The total amount of transfers that are in a pending state. These transfers will affect the available_balance unless they are canceled prior to completion.
locked_amount
int64
Only applicable for root accounts. The locked balance is posted on the account but cannot be withdrawn.
created_at
string
The timestamp at which the bank account was created.
currency_code
string
Currency of the balances in the account. For all amounts this will be USD.
default_account_number
string
The externally facing account number tied to this bank account.
default_account_number_id
string
The Column acno_id tied to this bank account.
routing_number
string
The externally facing routing number tied to this bank account.
description
string
A name for the bank account (minimum of three characters)
is_overdraftable
boolean
Whether the account can be overdrafted, must include a overdraft_reserve_account_id
id
string
Unique identifier for the object
owners
array
List of entity_id's which are tied to this bank account
type
string
Bank Account type. Can be CHECKING, OVERDRAFT_RESERVE, or PROGRAM_RESERVE
overdraft_reserve_account_id
string
The overdraft reserve account that this account linked to. If is_overdraftable: true then this field is required.
Bank Account object
Create a new bank account
POST
/bank-accounts
Creates a new bank account under an entity.
body parameters
description
string
Required
A name for the bank account (minimum of three characters)
entity_id
string
Required
The entity to create the account under
is_overdraftable
boolean
Optional
Whether the account can be overdrafted, must include a overdraft_reserve_account_id
overdraft_reserve_account_id
string
Optional
The overdraft reserve account that this account linked to. If `is_overdraftable: true` then this field is required
Request
Response
List all bank accounts
GET
/bank-accounts
List all bank accounts under the platform. Filtered results can be retrieved with extra parameters in the query.
query parameters
entity_id
string
Optional
List all accounts that belong to the entity with the entity_id.
is_overdraftable
boolean
Optional
List all accounts that are overdraftable.
type
string
Optional
Bank Account type. Can be CHECKING, OVERDRAFT_RESERVE, or PROGRAM_RESERVE.
overdraft_reserve_account_id
string
Optional
List all bank accounts with the given overdraft_reserve_account_id.
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
Request
Response
Get a bank account by ID
GET
/bank-accounts/<bank_account_id>
Get a bank account by its id
path parameters
bank_account_id
string
Required
The ID of the bank account you are looking up
Request
Response
Update a bank account
PATCH
/bank-accounts/<bank_account_id>
Updates a bank account by its id
path parameters
bank_account_id
string
Required
body parameters
description
string
Optional
is_overdraftable
boolean
Optional
Whether the account can be overdrafted, must include a overdraft_reserve_account_id
overdraft_reserve_account_id
string
Optional
The overdraft reserve account that this account linked to if is_overdraftable is true
Request
Response
Delete a bank account
DELETE
/bank-accounts/<bank_account_id>
This deletes a bank account
Removing accounts
Bank Accounts can only be deleted when they have a $0 balance.
path parameters
bank_account_id
string
Required
Request
Response
Bank Account Summary object
object parameters
available_balance_credit
string
Total credit amount in cents applied to available_balance. Zero or positive.
available_balance_debit
string
Total debit amount in cents applied to available_balance. Zero or negative.
available_balance_close
string
Close available_balance in cents at the end of effective_on in time_zone.
currency
string
The currency of the balances.
effective_on
string
Effective date of the summary.
holding_balance_credit
string
Total credit amount in cents applied to holding_balance. Zero or positive.
holding_balance_debit
string
Total debit amount in cents applied to holding_balance. Zero or negative.
holding_balance_close
string
Close holding_balance in cents at the end of effective_on in time_zone.
locked_balance_credit
string
Total credit amount in cents applied to locked_balance. Zero or positive.
locked_balance_debit
string
Total debit amount in cents applied to locked_balance. Zero or negative.
locked_balance_close
string
Close locked_balance in cents at the end of effective_on in time_zone.
pending_balance_credit
string
Total credit amount in cents applied to pending_balance. Zero or positive.
pending_balance_debit
string
Total debit amount in cents applied to pending_balance. Zero or negative.
pending_balance_close
string
Close pending_balance in cents at the end of effective_on in time_zone.
time_zone
string
Time zone of effective_on to decide day boundaries. You can set your platform reporting time zone in Platform Settings on Dashboard.
transaction_count
int32
Total number of transactions on the day of effective_on.
Bank Account Summary object
Get bank account summary history
GET
/bank-accounts/<bank_account_id>/history
Get the summary history of a bank account. This endpoint returns a list of summaries, one summary per day, for a single bank account. You must set your platform reporting time zone in Platform Settings on Dashboard to use this endpoint.
path parameters
bank_account_id
string
Required
The ID of the bank account you are looking up
query parameters
from_date
string
Required
Starting date of the history. Format: YYYY-MM-DD.
to_date
string
Required
Ending date of the history. Format: YYYY-MM-DD. Maximum date range: 31 days.
Request
Response
Account number object
An account number is the child of a bank account. A bank account can have one or more account numbers. Think of account numbers as a pointer to a bank account. Account numbers will be used by external banks to transact with Column bank accounts. Read about account numbers in our data model section for more information.
object parameters
account_number
string
The externally facing account number tied to this bank account.
bank_account_id
string
The Column bacc_id tied to this bank account.
created_at
string
The timestamp the account number was created.
description
string
A name for the account number (minimum of three characters)
id
string
The unique id of the object
routing_number
string
The externally facing routing number tied to this bank account.
Account Number object
Create a new account number
POST
/bank-accounts/<bank_account_id>/account-numbers
Creates a new account number that points to the associated bank account
path parameters
bank_account_id
string
Required
The bank account that you want the new account number to point to
body parameters
description
string
Optional
A description for this account number
Request
Response
List all account numbers from a bank account
GET
/bank-accounts/<bank_account_id>/account-numbers
Lists all the account numbers that point to a specific bank account
path parameters
bank_account_id
string
Required
The bank account that you want the new account number to point to
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
Request
Response
Get an account number
GET
/account-numbers/<account_number_id>
Lists all the account numbers that point to a specific bank account
path parameters
account_number_id
string
Required
The id for the account number
Request
Response
Loan object
A loan is an object that lives under an entity, at the same level as a bank account. Just like entities can have multiple bank accounts, entities can have multiple loans. Loans are the foundation for many lending-oriented use cases such as charge cards and term loans. Read about loans in our data model section for more information.
object parameters
balances
object
principal_charged_off
string
The balance of the loan which has been charged off.
principal_holding
string
The balance of the loan which is in a holding state.
principal_outstanding
string
The balance of the loan which is outstanding.
principal_paid
string
The balance of the loan which has been paid.
charged_off_at
string
The timestamp the loan was charged off.
created_at
string
The timestamp the loan was created.
currency
string
The currency of the loan. Currently only USD is supported.
delinquent_at
string
The timestamp the loan was marked as delinquent.
description
string
The description of the loan in the Column dashboard.
disputed_at
string
The timestamp the loan was marked as disputed.
id
string
The id of the loan object.
is_revolving
boolean
Indicates whether or not the loan is revolving. If true the loan can have multiple disbursements.
maturity_date
string
The maturity date of the loan.
max_principal_balance
string
The max principal balance of the loan. This is akin to a credit limit. Disbursements will fail if the resulting principal will be above the max principal.
paid_off_at
string
The timestamp the loan is marked as paid off.
primary_signer_entity_id
string
The Column entity_id which the loan is related to.
status
string
The current status of the loan. A loan can have a status of current, delinquent, charged_off, in_dispute, canceled or paid_off.
Loan object
Create a new loan
POST
/loans
Creates a new loan under an entity.
body parameters
currency
string
Required
The three-letter currency code defined in ISO 4217. e.g. USD
description
string
Required
The description of the loan in the Column dashboard.
entity_id
boolean
Required
The entity to create the loan under.
is_revolving
boolean
Required
Indicates whether or not the loan is revolving. If true the loan can have multiple disbursements.
maturity_date
string
Required
The maturity date of the loan
max_principal_balance
string
Required
The max principal balance of the loan in cents. This is akin to a credit limit. Disbursements will fail if the resulting principal will be above the max principal.
e.g. $1.75 would be represented by 175.
Request
Response
Update a loan
PATCH
/loans/<loan_id>
Updates a loan by its ID.
path parameters
loan_id
string
Required
The ID of the loan you are looking up
body parameters
description
string
Optional
The description of the loan in the Column dashboard.
is_revolving
boolean
Optional
Indicates whether or not the loan is revolving. If true the loan can have multiple disbursements.
maturity_date
string
Optional
The maturity date of the loan.
max_principal_balance
string
Optional
The max principal balance of the loan in cents. This is akin to a credit limit. Disbursements will fail if the resulting principal will be above the max principal.
e.g. $1.75 would be represented by 175.
status
string
Optional
The current status of the loan. A loan can have a status of current, delinquent, charged_off, in_dispute, canceled or paid_off.
Request
Response
Get a loan by ID
GET
/loans/<loan_id>
Retrieve a single loan by its ID.
path parameters
loan_id
string
Required
The ID of the loan you are looking up
Request
Response
List all loans
GET
/loans
List all loans under the platform. Filtered results can be retrieved with extra parameters in the query
query parameters
entity_id
string
Optional
status
string
Optional
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
Request
Response
Create a disbursement
POST
/loans/disbursements
Creates a disbursement for a loan.
body parameters
amount
string
Required
Amount (in cents) of the funds that will be disbursed.
e.g. $1.75 would be represented by 175.
bank_account_id
string
Required
The bank account to which funds will be disbursed.
currency
string
Required
The currency of the loan. Currently only USD is supported.
description
string
Required
The description of the loan disbursement.
hold
boolean
Optional
If true, creates a disbursement in a hold state. The disbursement will not be completed until the clear API is called. Disbursements in a hold state may be updated or canceled.
loan_id
string
Required
The ID of the loan to from which the disbursement is being made.
details
object
Optional
Transfer monitoring details
sender_name
string
Optional
Name of the sender
merchant_name
string
Optional
Name of the merchant for this transaction
merchant_category_code
string
Optional
Category code for the merchant for this transaction
authorization_method
string
Optional
Authorization method for this transaction
website
string
Optional
Website for this transaction
internal_transfer_type
string
Optional
Transfer type in non-column systems
statement_description
string
Optional
Line item on the customer statement for the transfer
address
object
Required
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Update a disbursement
PATCH
/loans/disbursements/<disbursement_id>
Update a disbursement by its ID. Disbursement must be in a "hold" state. Only the amount can be updated.
path parameters
disbursement_id
string
Required
The ID of the disbursement you want to update.
body parameters
amount
string
Required
Amount (in cents) of the funds that will be disbursed.
e.g. $1.75 would be represented by 175.
currency
string
Required
The currency of the loan. Currently only USD is supported.
Request
Response
Clear a disbursement
POST
/loans/disbursements/<disbursement_id>/clear
Clears a disbursement by its ID. Disbursements can only be cleared if they are in a "hold" state.
path parameters
disbursement_id
string
Required
The ID of the disbursement to clear.
body parameters
amount
string
Optional
Updated amount (in cents) of the funds that will be disbursed.
e.g. $1.75 would be represented by 175.
currency
string
Optional
The currency of the loan. Currently only USD is supported.
Request
Response
Cancel a disbursement
POST
/loans/disbursements/<disbursement_id>/cancel
Cancels a disbursement by its ID. Only a disbursement in a "hold" state can be cancelled.
path parameters
disbursement_id
string
Required
The ID of the disbursement to clear.
Request
Response
Get a disbursement
GET
/loans/disbursements/<disbursement_id>
Get a disbursement by its ID.
path parameters
disbursement_id
string
Required
The ID of the disbursement you are looking up.
Request
Response
List all disbursements
GET
/loans/disbursements
List all disbursements under the platform. Filtered results can be retrieved with extra parameters in the query.
query parameters
loan_id
string
Optional
bank_account_id
string
Optional
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
Request
Response
Create a payment
POST
/loans/payments
Creates a payment for a loan.
body parameters
principal_amount
string
Required
Amount (in cents) of the loan payment.
e.g. $1.75 would be represented by 175.
bank_account_id
string
Required
The bank account from which the payment is originated. The balance of the bank account will decrease by the payment amount.
currency
string
Required
The currency of the loan. Currently only USD is supported.
description
string
Required
The description of the loan payment.
loan_id
string
Required
The ID of the loan to which the payment is being made. The principal_outstanding of the loan will decrease by the payment amount.
Request
Response
Get a payment
GET
/loans/payments/<payment_id>
Get a payment by its ID.
path parameters
payment_id
string
Required
The ID of the payment you are looking up.
Request
Response
List all payments
GET
/loans/payments
List all payments under the platform. Filtered results can be retrieved with extra parameters in the query.
query parameters
loan_id
string
Optional
bank_account_id
string
Optional
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
Request
Response
Counterparty object
A counterparty is an external account that you can transfer money to and from. All ACH and Wire transfers originated by Column take in a counterparty_id to identify the transfer destination. Once you have created a counterparty, you can send money to it (or pull from it)! A counterparty stores an external bank account and can also store additional transaction details, as desired or required. Read about counterparties in our data model section for more information.
object parameters
account_number
string
The account number for the bank account.
account_type
string
The type of the account number. Can be checking or savings.
address
object
line_1
string
Address line 1
line_2
string
Address line 2
city
string
City
state
string
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Postal code
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
created_at
string
The timestamp the object was created.
description
string
Description of the counterparty visible only in your platform. Maximum length: 127 characters.
string
The email address of the beneficiary.
id
string
The unique id of the object
is_column_account
boolean
Indicates whether this counterparty account is actually a Column account.
legal_id
string
The legal ID (e.g., Tax ID, Cedula Juridica, etc.) of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 127 characters.
legal_type
string
The legal entity type of the beneficiary. Can be business, non_profit, individual, or sole_proprietor. This field is recommended for international wire transfers, and required in some countries.
local_account_number
string
The local account number (e.g. Cuenta Cliente in Costa Rica) in the beneficiary's bank. This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters.
local_bank_code
string
The local bank code of the beneficiary's bank (e.g., India IFSC, Australia BSB, China CNAPS, etc.). This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters.
name
string
The counterparty name who owns the bank account.
phone
string
The phone number of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 31 characters.
Format for international wire transfers: \+[0-9]{1,3}-[0-9()+\-]{1,30} (e.g. +44-(0)1223-333300).
Format for domestic wire transfers:
+1-(650)123-4567(US international phone number format)650-123-4567(650)123-4567(650) 123-4567650 123 45676501234567
routing_number
string
The routing number of the bank.
routing_number_type
string
The type of the routing number. Can be aba or bic.
updated_at
string
The timestamp the object was last updated.
wire_drawdown_allowed
boolean
Indicates if the counterparty is allowed to send drawdown requests to Column via FedWire. If it is false, all inbound drawdown requests from this counterparty will be rejected.
Counterparty object
Create a counterparty
POST
/counterparties
A counterparty is the legal entity on the other side of the transaction. Depending on the type of transaction, we may need to know more or less about them.
A domestic ACH only requires a counterparty's account and routing number. If you include a counterparty name, Column will by default populate receiver_name on the ACH transfer request. Domestic and international wires require full name and address. Certain countries may require additional fields. Learn more about country-specific details here.
body parameters
routing_number
string
Required
The routing number of the bank.
routing_number_type
string
Optional
The type of the routing number. Can be aba or bic. Default value is aba if this field is not set.
account_number
string
Required
The account number of the bank account.
account_type
string
Optional
The type of the account number. Can be checking or savings.
description
string
Optional
Description of the counterparty visible only in your platform. Maximum length: 127 characters.
wire_drawdown_allowed
boolean
Optional
Indicate if the counterparty is allowed to send drawdown requests to Column via FedWire. If it is false, all inbound drawdown requests from this counterparty will be rejected.
name
string
Optional
The owner name of the bank account. This field is not required to send ACH transfers, but is required to send domestic and international wires.
address
object
Optional
The address object is not required to send ACH transfers, but is required to send domestic and international wires.
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
phone
string
Optional
The phone number of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 31 characters.
Format for international wire transfers: \+[0-9]{1,3}-[0-9()+\-]{1,30} (e.g. +44-(0)1223-333300).
Format for domestic wire transfers:
+1-(650)123-4567(US international phone number format)650-123-4567(650)123-4567(650) 123-4567650 123 45676501234567
string
Optional
The email address of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 127 characters.
legal_id
string
Optional
The legal ID (e.g., Tax ID, Cedula Juridica, etc.) of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 127 characters.
legal_type
string
Optional
The legal entity type of the beneficiary. Can be business, non_profit, individual, or sole_proprietor. This field is recommended for international wire transfers, and required in some countries.
local_bank_code
string
Optional
The local bank code of the beneficiary's bank (e.g., India IFSC, Australia BSB, China CNAPS, etc.). This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters.
local_account_number
string
Optional
The local account number (e.g. Cuenta Cliente in Costa Rica) in the beneficiary's bank. This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters.
Request
Response
List all counterparties
GET
/counterparties
Retrieve all counterparties under your developer account. Filtered results can be retrieved with extra parameters in the query (account_number, routing_number, etc.).
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
account_number
string
Optional
Return counterparties created with given account number.
routing_number
string
Optional
Return counterparties created with given routing number.
Request
Response
Get a counterparty by ID
GET
/counterparties/<counterparty_id>
Retrieve a single counterparty by its ID.
path parameters
counterparty_id
string
Required
ID of the counterparty you're looking up.
Request
Response
Delete a counterparty
DELETE
/counterparties/<counterparty_id>
Delete a counterparty
path parameters
counterparty_id
string
Required
ID of the counterparty you're deleting.
Request
Response
Financial Institution object
object parameters
ach_eligible
bool
Indicate if an institution accepts ACH transfers or not.
city
string
Institution's address city name.
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
created_at
string
The timestamp the object was created.
full_name
string
Institution's official full name.
phone_number
string
Institution's phone number. Only available if ach_eligible = true.
routing_number
string
Institution's routing number. Can be 9-digit ABA routing numbers, or 8/11-character BICs.
routing_number_type
string
The type of the routing number. Can be aba or bic.
short_name
string
Institution's short name.
state
string
Institution's address state code (e.g., CA)
street_address
string
Institution's street address. Only available if ach_eligible = true.
updated_at
string
The timestamp the object was last updated.
wire_eligible
bool
Indicates if an institution accepts wire transfers or not.
wire_settlement_only
bool
Indicates if an institution can only accept bank-to-bank settlement transfers, but cannot accept customer transfers.
zip_code
string
Institution's address zip code. Only available if ach_eligible = true.
Financial Institution object
Get a financial institution
GET
/institutions/<routing_number>
Retrieve a single financial institution by its ABA number or BIC.
path parameters
routing_number
string
Required
ABA number or BIC of the financial institution you're requesting
Request
Response
ACH transfer object
The ACH transfer object represents the current state of a single ACH transfers originated by or received by Column. The ACH object will contain all relevant information about the specific transfer, which are described in the parameters below. Read about more about ACH transfers here.
object parameters
account_number_id
string
ID of the account number that is sending the transfer.
acknowledged_at
string
The timestamp at which an acknowledgement is received for a CCD or CTX ACH transfer.
allow_overdraft
boolean
Allow the account to go negative for the transfer. The bank account needs to have is_overdraftable enabled with an overdraft reserve account linked to it.
amount
int64
Amount (in cents) of the funds that will be transferred between originator and counterparty accounts.
e.g. $1.75 would be represented by 175.
bank_account_id
string
ID of the bank account that is sending the transfer.
cancelled_at
string
The timestamp at which the transfer is cancelled.
company_discretionary_data
string
This optional field allows you to include codes (one or more), of significance only to you, to enable specialized handling of the transfer. There is no standardized interpretation for the value of the field. Maximum length:20 characters.
CIE: This field may contain the Biller's name.
CTX: The Originator's bank account number may be placed in this field.
company_entry_description
string
You can use this optional field to provide the Receiver with a description of the purpose of the transfer. For example, “Gas bill”, “Reg. Salary”, “ins. prem.”, “Soc. Sec.”, “DTC”, “Trade Pay”, “PURCHASE”, etc.
Default value: "PAYMENT". Maximum length: 10 characters.
company_id
string
A 10-digit unique identifier used for identifying entities, called originators, collecting payments via ACH debit. If you would like to use a specific company ID when originating ACH transactions, please contact us.
company_name
string
The name of the originator company that initiated the ACH transfer.
completed_at
string
The timestamp at which the 60 day return window has passed for this ACH transfer, and it is officially completed.
counterparty_id
string
ID of the counterparty that will receive the transfer.
created_at
string
The timestamp at which the transfer request is created.
currency_code
string
The three-letter currency code defined in ISO 4217. e.g. USD.
description
string
Description of the transfer visible only in your platform.
effective_on
string
Datetime (00:00AM in Pacific Time zone) on which the transfer is effective. For incoming transfers, this is 00:00AM on the Settlement Date of the transfer in PT timezone (more details).
entry_class_code
string
Standard Entry Class code of the transfer. More Details Here.
iat
object
This field provides additional IAT (International ACH Transfer) addenda information. More information here.
id
string
The unique id for this object
idempotency_key
string
The idempotency key specified in the ACH transfer.
initiated_at
string
The timestamp at which Column received your ACH request.
is_incoming
boolean
Indicates whether the ACH transfer was incoming (true or outgoing false
is_on_us
boolean
Indicates whether or not the ACH transfer is coming from a Column bank account. If true the request is processed immediately like a book transfer, and not sent to the Fed.
manual_review_at
string
The timestamp at which the ACH transfer went into the manual review state.
notification_of_changes
object
Details of Notifications of Change (NOCs) with the latest information of the counterparty. Available only with ach.outgoing_transfer.noc events.
receiver_id
string
Latest accounting reference number by which the beneficiary should be referred by the originator.
routing_number
string
Latest routing number of the counterparty.
account_number
string
Latest account number of the counterparty.
nsf_deadline
string
For incoming ACH Debits and available only with ach.incoming_transfer.nsf events. The deadline by which the receiver account must be funded with enough credits. Otherwise, Column will file an NSF return for this ACH Transfer. See Incoming Debit ACH Transfers for more details.
odfi_routing_number
string
The externally facing routing number for the ODFI that initiated the ACH Transfer.
payment_related_info
string
Provides additional information on the ACH transfer. It is usually up to 80 characters long but could be longer for CTX, ENR and TRX transfers.
receiver_id
string
This field contains the accounting reference number by which the Receiver is known to the Originator. It is included for further identification and for descriptive purposes.
For example, it may be the number shown on an invoice, statement, billhead, notice, or other communication as the reference for the Receiver to update account receivable records.
receiver_name
string
The name of the receiver, usually the name on the bank account of the Receiver.
Default value: beneficiary name of the counterparty. Maximum length: 22 characters.
return_contested_at
string
The timestamp at which the dishonored return for this transfer was contested by the RDFI.
return_details
array
Details of the return processing history (e.g., initiated, dishonored, dishonor contested, manual review, etc.). Available only with ach.*.returned, ach.*.return_dishonored or ach.*.return_contested events.
return_dishonored_at
string
The timestamp at which the return for this transfer was dishonored by the ODFI.
returned_at
string
The timestamp at which the ACH transfer is returned by the RDFI.
reversal_pair_transfer_id
string
If the transfer is the original transfer of an ACH Reversal, this field is the unique ID of the reversal transfer. If the transfer is the reversal transfer of an ACH Reversal, this field is the unique ID of the original transfer. Please refer to ACH Reversals for more details.
same_day
boolean
Specify if the transfer is a same-day ACH transfer. If it is set as true, it takes precedence over effective_date and overrides it.
settled_at
string
The timestamp at which the ACH was settled.
status
string
The current state of the ACH transfer. See Notifications and States for details. Possible values: INITIATED, PENDING_SUBMISSION, SUBMITTED, SETTLED, RETURNED, COMPLETED, CANCELED, SCHEDULED, PENDING_RETURN, RETURN_DISHONORED, RETURN_CONTESTED, MANUAL_REVIEW, and MANUAL_REVIEW_APPROVED.
submitted_at
string
The timestamp at which the ACH transfer was submitted to the Fed.
trace_number
string
The unique number assigned to every ACH entry by an ODFI which identifies that entry within a specific ACH file.
type
string
ACH transfer type: CREDIT or DEBIT. Learn more.
updated_at
string
The timestamp at which the ACH transfer was lastly updated.
ACH Transfer object
IAT transfer sub-object
object parameters
foreign_correspondent_bank_info
array
Provides additional details around foreign corresponding banks used in the IAT transfer.
foreign_payment_amount
string
The amount for which the transfer was originated by the Foreign ODFI. This will be in USD, since Column will receive IATs from a domestic correspondent bank.
foreign_trace_number
string
Contains the trace number assigned to the transfer in the originating national payments system.
odfi_branch_country_code
string
The two digit alphabetic country code which identifies the country in which the branch of the bank that originated the transfer is located.
odfi_identification
string
The routing number of the DFI originating the transfer.
odfi_identification_number_qualifier
string
Thw two digit numbering scheme used in the ODFI identification number. Possible values are 01(National Clearing System Number), 02(BIC Coder), or 03(IBAN)
odfi_name
string
The name of the ODFI
originator_city_state_province
string
Contains the city, and if applicable the state or province of the originator.
originator_country_postal_code
string
Contains the postal code for the originator street address.
originator_name
string
Contains the name of the originator of the transaction.
originator_street_address
string
Contains the physical street address of the originator.
rdfi_branch_country_code
string
The two digit alphabetic country code which identifies the country in which the branch of the bank that received the transfer is located.
rdfi_identification
string
This field is used by the originator to insert its own number for tracing purposes.
rdfi_identification_number_qualifier
string
Thw two digit numbering scheme used in the RDFI identification number. Possible values are 01(National Clearing System Number), 02(BIC Coder), or 03(IBAN)
rdfi_name
string
The name of the RDFI.
receiver_city_state_province
string
Contains the city, and if applicable the state or province of the receiver.
receiver_country_postal_code
string
Contains the postal code for the receiver street address.
receiver_identification_number
string
Contains the bank identification number of the DFI at which the receiver maintains their account.
receiver_street_address
string
Contains the physical street address of the receiver.
receiving_company_or_individual_name
string
Contains the name of the receiver of the transaction.
IAT transfer sub-object
Create an ACH transfer
POST
/transfers/ach
Creates an ACH transfer between an account and a counterparty.
body parameters
description
string
Optional
Description of the transfer visible only in your platform. Maximum length: 255 characters.
amount
int64
Required
Amount (in cents) of the funds that will be transferred between originator and counterparty accounts.
e.g. $1.75 would be represented by 175.
currency_code
string
Required
The three-letter currency code defined in ISO 4217. e.g. USD
account_number_id
string
Optional
ID of the account number from which the transfer is sent. If no account_number_id is specified, the default account number on a provided bank_account_id is used.
account_number_id or bank_account_id is required.
bank_account_id
string
Optional
ID of the bank account from which the transfer is sent. If no account_number_id is specified, the default account number on the bank_account_id is used.
account_number_id or bank_account_id is required.
counterparty_id
string
Required
ID of the counterparty that will receive the transfer
type
string
Required
ACH transfer type: CREDIT or DEBIT. Learn More.
effective_date
string
Optional
Date (format: YYYY-MM-DD) on which the transfer will be effective
same_day
boolean
Optional
Specify if the transfer is a same-day ACH transfer. If it is set as true, it takes precedence over effective_date and overrides it.
company_discretionary_data
string
Optional
This optional field allows you to include codes (one or more), of significance only to you, to enable specialized handling of the transfer. There is no standardized interpretation for the value of the field. Maximum length:20 characters.
CIE: This field may contain the Biller's name.
CTX: The Originator's bank account number may be placed in this field.
company_entry_description
string
Optional
You can use this optional field to provide the Receiver with a description of the purpose of the transfer. For example, “Gas bill”, “Reg. Salary”, “ins. prem.”, “Soc. Sec.”, “DTC”, “Trade Pay”, “PURCHASE”, etc.
Default value: "PAYMENT". Maximum length: 10 characters.
company_name
string
Optional
This optional field identifies the source of the transfer and is used for descriptive purposes for the Receiver. Except as otherwise noted below, this field must contain the name by which the Originator is known to and readily recognized by the Receiver of the transfer to reduce risk of return by the Receiver
CCD: For a Health Care EFT Transaction, this field must contain the name of the Health Plan, or where an organization is self-insured, the name of the organization's third-party administrator that is recognized by the Health Care Provider and to which the Health Care Provider submits its claims.
CIE: This field contains the bill payment service provider's name.
WEB: For a P2P transfer, this field contains the P2P service provider's name.
Default value: the root entity name of your platform, or "COLUMN NA" if no root entity exists. Maximum length: 16 characters.
payment_related_info
string
Optional
Provides an additional 80 characters to give details on the ACH transaction for outgoing transfers. This information will be surfaced to the RDFI.
receiver_name
string
Optional
The name of the receiver, usually the name on the bank account of the Receiver.
Default value: beneficiary name of the counterparty. Maximum length: 22 characters.
receiver_id
string
Optional
This field contains the accounting reference number by which the Receiver is known to the Originator. It is included for further identification and for descriptive purposes.
For example, it may be the number shown on an invoice, statement, billhead, notice, or other communication as the reference for the Receiver to update account receivable records.
Maximum length: 15 characters.
entry_class_code
string
Optional
Standard Entry Class code of the transfer. Valid values: CCD, CTX, CIE, PPD (default), TEL, WEB. More Details Here.
allow_overdraft
boolean
Optional
Allow the account to go negative for the transfer. The bank account needs to have is_overdraftable enabled with an overdraft reserve account linked to it.
Request
Response
List all ACH transfers
GET
/transfers/ach
Retrieve all ACH transfers under your developer account. Filtered results can be retrieved with extra parameters in the query (bank_account_id, counterparty_id, etc.).
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
bank_account_id
string
Optional
counterparty_id
string
Optional
status
string
Optional
Return results with this status.
Possible enum values:
- INITIATED: the outgoing transfer has been initiated but not submitted yet.
-PENDING_SUBMISSION: the outgoing transfer is to be submitted very soon.
- SUBMITTED: the outgoing transfer has been submitted to the FRB.
- ACKNOWLEDGED: the outgoing CCD/CTX transfer has been acknowledged by the RDFI.
- SETTLED: the transfer has been settled.
- RETURNED: the transfer has been returned. Please use the [ACH Return API](/docs/api/#ach-return/get) to check return details.
- COMPLETED: the transfer has been completed, and no return (except R06 and \`R31\`) is acceptable.
- CANCELED: the outgoing transfer has been cancelled by your request via our ACH Return API.
- SCHEDULED: the incoming transfer has been scheduled to be settled on its Settlement Date
- PENDING_RETURN: the incoming transfer will be returned shortly if no action is taken before the deadline
- RETURN_DISHONORED: the return of the transfer has been dishonored by the ODFI. Please use the ACH Return API to check return details.
- RETURN_CONTESTED: the dishonored return of the transfer has been contested by the RDFI. Please use the ACH Return API to check return details.
- MANUAL_REVIEW: the transfer is under manual review.
is_incoming
boolean
Optional
Return transfers that is either incoming or outgoing.
type
string
Optional
Return transfers that are either CREDIT or DEBIT.
Request