Ledger Account model

Attribute

Type

Description

object

string

value is "ledger_account".
A Ledger Account represents a business who have consented to access their data. Every LedgerAccont can have multiple data connections to different  partner sources, For example a LedgerAccount can have a single connection to Stripe, single connection to PayPal, a connection to Shopify, multiple connection to OB partners for multiple bank accounts. Such Ledger Accounts are your platform accounts i.e your business customers. When such a customer of yours provides us consent for the first time, we would generate a unique Ledger Id and share with you.

ledgeraccount_id

string

Unique identifier for the object as shared wth the institution

business_profile

hash

business information about the ledger account

account_name_partner

list

Names as captured on the partner source system

object

string

String representing the object’s type. Objects of the same type share the same value. Value is "list"

data

array of hashes

The list of all account names for a connected ledger as maintained on different partner sources (if the ledger has more than one sich connection provided access to)

account_name_type

string

name type of the account as on partner system. Values will be:
Legal
Trading

account_name

string

name of the account as on partner system

account_id_partner

list

Ids as captured on the partner source system

object

string

String representing the object’s type. Objects of the same type share the same value. Value is "list"

data

array of hashes

The list of all account ids for a connected ledger as maintained on different partner sources (if the ledger has more than one such connection provided access to)

account_id

string

id of the account as on partner system

addresses

list

addresses as associated/setup for this account

object

string

String representing the object’s type. Objects of the same type share the same value. Value is "list"

data

array of hashes

The list of all account addresses for a connected ledger as maintained on different partner sources (if the ledger has more than one such connection provided access to)

type

string

Type of address, either:

Primary
Support
Billing
Delivery
Unknown
Trading

line1

string

Line 1 of the address for the connected ledger account

line2

string

Line 2 of the address for the connected ledger account

city

string

City

postal_code

string

Zip code/ Postal code

region

string

Region or County

country

string

Country

business_phone

list

Phone numbers associated/setup for this account

object

string

String representing the object’s type. Objects of the same type share the same value. Value is "list"

data

array of hashes

The list of all business phone numbers for a connected ledger as maintained on different partner sources (if the ledger has more than one such connection provided access to)

type

string

Type of phone number, either:

Primary
Support
Landline
Mobile
Fax
Unknown

number

string

Phone numbers associated/setup for this account

business_email

list

emails associated/setup for this account

object

string

String representing the object’s type. Objects of the same type share the same value. Value is "list"

data

array of hashes

The list of all emails for a connected ledger as maintained on different partner sources (if the ledger has more than one such connection provided access to)

type

string

Type of emails, either:

Support
Business
Store
Unknown

email

string

email address value

weblinks

list

digital/web links (website, social links) associated/setup for this account

object

string

String representing the object’s type. Objects of the same type share the same value. Value is "list"

data

array of hashes

The list of all web links for a connected ledger as maintained on different partner sources (if the ledger has more than one such connection provided access to)

type

string

Type of web link, either:

Website
Website-Trading
Social
Unknown

url

string

web address

mcc

string

The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.

country

string

Accounts country

registrationNumber

string

Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House.

tax_id

string

company’s business VAT number

Legal_entity

string

identifying the legal structure of the company or legal entity, Possible enum values
government_instrumentality
governmental_unit
incorporated_non_profit
limited_liability_partnership
multi_member_llc
private_company
private_corporation
private_partnership
public_company
public_corporation
public_partnership
single_member_llc
sole_proprietorship
tax_exempt_government_instrumentality
unincorporated_association
unincorporated_non_profit
free_zone_llc
sole_establishment
free_zone_establishment
llc
other

legal_entity_description

string

In case where a legal entiy value doesn’t match to a defined value in our unified model, this attribute wil descrive the legal entity in a descriptive manner

nature_and_purpose

string

Describes the nature & purpose of the merchat business if available as part of account boarding with PSP

account_settings

hash

settings enabled/disabled in the commerce partner platform

account_details_provided

Boolean

whether the account details have been submitted. Few partner platforms ensure account do not receive payouts before this is true.

charges_enabled

Boolean

Whether the account can create live charges.

payouts_enabled

Boolean

Whether partner platforms can send payouts to this account.

payouts_on_demand_enabled

Boolean

Whether partner platforms can send payouts on demand to this account.

partner_created_date

date

Date the ledger account was created in the partner platform

partner_modified_date

date

Date the record was last changed in the partner platform system.

business_locations

list

provides details of the various business locations, allows grouping of POS readers

object

string

String representing the object’s type. Objects of the same type share the same value. Value is "list"

data

array of hashes

The list of all stores/locations for a connected ledger as maintained on different partner sources (if the ledger has more than one such connection provided access to)

id

string

name

string

name of the location

address

hash

addresses as associated/setup for this location

line1

string

Line 1 of the address for thelocation

line2

string

Line 2 of the address for the location

city

string

City

postal_code

string

Zip code/ Postal code

region

string

Region or County

country

string

Country

pos_terminals

list

provides details of the various POS devices/readers

object

string

String representing the object’s type. Objects of the same type share the same value. Value is "list"

data

array of hashes

The list of all devices/readers for a connected ledger as maintained on different partner sources (if the ledger has more than one such connection provided access to)

id

string

reader or terminal id (TID) of the reader

terminal_type

string

type of terminal; ingenico or Clover or verifone_p400

business_location

string

location identifier

nick_name

string

Custom label given to the reader for easier identification.

serial_number

string

serial number of the terminal

sw_version

string

latest software version of the terminal

ip_address

string

The local IP address of the terminal

status

string

networking status of the terminal

default_currency

string

Three-letter ISO currency code representing the default currency for the account.