External Account model

External Account data dictionary

What is an External Account object on Groov platform?

External account refers to the payout transfer destinations (Banks, Cards or wallets) for a seller/ledger account or are accounts that relate to a customers saved payment method/source from where recurring payments can be initiated as saved on the sellers commerce/payment provider partner platform.

For the seller/ledger account, this provides a view of the details of the Bank or card account the funds were paid out to, helps reconcile banking entries to detailed transaction breakdown in terms of granular dataset

For the buyer/customer dataset, this provides the various instruments that the seller uses to make the payments (incl subscription based payments) and helps profiling the buyers and their usage patterns using various payment instruments.

The /Bank Account sub model lists the various attributes related to the Bank account as a destination account (seller) or as a payment instrument (buyer/customer). Wherever it relates to a business/seller, the customer_id/customer entry will be blank for such records.

The /Card sub model lists the various attributes related to the card (debit and/or credit) account as a destination account (seller) or as a payment instrument (buyer/customer). Wherever it relates to a business/seller, the customer_id/customer entry will be blank for such records.

The /Other sub model lists the various attributes related to any other form of payment method other than Bank Account or Cards i,e wallets, crypto type of account as a destination account (seller) or as a payment instrument (buyer/customer). Wherever it relates to a business/seller, the customer_id/customer entry will be blank for such records.

Data Dictionary (External Account /Bank Account)


Attribute	Type	Description
bank_account	list	provides details of the external account or payment methods where the mediumis via Bank accounts
object	string	String representing the object’s type. Objects of the same type share the same value. Value is "list"
type	string	Type of external account. Value will be: Bank Account
id	string	Groov identifier of the listed bank account. (prefix used is 'bank')
customer_id	string	id of the customer on Groov platform the external account belongs to (if it’s a customerrelated account). To limit the number of calls to the API, and the size of the responses, our REST API to support the expansion of this
name	string	The name of the person or business that owns the bank account.
category	string	The type of entity that holds the account. This can be either be: personal or business or other
type	string	The bank account type. This can be either be: checkng or savings or other
bank_name	string	Name of the bank account
bank_country	string	Two-letter ISO code representing the country the bank account is located in.
account_currency	currency	currency of the bank account. Three-letter ISO code for the currency
account_number	integer	bank account number
sort_code	integer	routing number or the sort code of the bank account
status	string	Status of the bank account. Values are: Active Inactive
IBAN	string	IBAN number
SWIFTCode	string	SWIFT code
primary	boolean	primary bank account (the one used for settlements).
recordState	string	Shows if the record is active or has been deleted (can be ACTIVE or DELETED)
created_date	timestamp	Date the record was created in the commerce or partner platform
modifiedDate	date	Date the record was last updated in the our system.
recordState	string	Show if the record is deleted (can be ACTIVE or DELETED)

Data Dictionary (External Account /Card)


Attribute	Type	Description
card	list	provides details of the external account or payment methods where the medium is via Cards
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 stored cards associated with the connected ledger (either the ledgers destination settlement account or the ledge account customers paymen account)
id	string	Groov identifier of the listed card account (prefix used is 'card')
customer_id	string	id of the customer on Groov platform the external account belongs to (if it’s a customerrelated account). To limit the number of calls to the API, and the size of the responses, our REST API to support the expansion of this
name	string	cardholder name
card_number	integer	the card number
tokenization_method	string	f the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay) apple_pay masterpass visa_checkout null
address_city	string	City/District/Suburb/Town/Village.
address_postal_code	string	post code or zip code
address_country	string	Billing address country, if provided when creating card.
brand	string	Card brand. Can be American Express Diners Club Discover JCB MasterCard UnionPay Visa Unknown
country	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.
type	string	Card type. Values Can be credit debit prepaid unknown
recordState	string	Shows if the record is active or has been deleted (can be ACTIVE or DELETED)
created_date	timestamp	Date the record was created in the commerce or partner platform
modifiedDate	date	Date the record was last updated in the our system.

Data Dictionary (External Account /Card)


Attribute	Type	Description
other	list	provides details of the external account or payment methods where the medium is anything other than bank account or card
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 other methods of payment associated with the connected ledger (either the ledgers destination settlement account or the ledge account customers paymen account)
id	string	Groov identifier of the listed other payment method account (prefix used is 'other')
customer_id	string	id of the customer on Groov platform the external account belongs to (if it’s a customerrelated account). To limit the number of calls to the API, and the size of the responses, our REST API to support the expansion of this
payment_method	string	Payment method type: ach_credit_transfer ach_debit acss_debit alipay au_becs_debit bancontact card_present eps giropay ideal klarna multibanco p24 sepa_debit sofort stripe_account wechat unknown cash custom invoice swish vipps mobile storecredit paypal prepaid crypto
recordState	string	Shows if the record is active or has been deleted (can be ACTIVE or DELETED)
created_date	timestamp	Date the record was created in the commerce or partner platform
modifiedDate	date	Date the record was last updated in the our system.