Get All Customer Accounts - Field Descriptions

The following tables describe the fields in the response for the Get All Customer Accounts endpoint.

Header

The following table describes the fields that can be included in the header of the request.

Field	Description	Type	Min Length	Max Length	Mandatory
client-id	Client identifier for the request.	String			Yes
partner-id	Partner identifier for Mastercard configuration. If not provided, uses the default partner ID.	String			No

Response

The following table describes the fields that are included in the response.

Field	Description
request_id	Unique identifier for the request.
customer_accounts	Object that contains information on the customer account.
id	The account identifier.
number	The account number from the institution.
accountNumberDisplay	The account number from a financial institution in truncated format: Last four digits: "1234" Last four digits with suffix: "1234-9" Full value for string accounts: '1234-9'
name	The account name from the institution.
balance	The cleared balance of the account as of balanceDate.
type	The list of supported account types. For example, checking.
status	The status of the account. For example, pending. The
customerId	The customer identifier.
institutionId	The identifier of the financial institution
currency	The currency code.
realAccountNumberLast4	The last 4 digits of the ACH account number.
balanceDate	The timestamp showing when the balance was captured by the FI.
aggregationSuccessDate	The timestamp showing the last successful aggregation of the account. This will not be present until you have run your first aggregation for the account.
aggregationStatusCode	The timestamp showing the last successful aggregation of the account. This will not be present until you have run your first aggregation for the account.
aggregationAttemptDate	The timestamp showing the last aggregation attempt, whether successful or not. This will not be present until you have run your first aggregation for the account.
createdDate	The timestamp showing when the account was added to the system.
lastUpdatedDate	The timestamp showing when the account was last modified to the system.
linkedAccountDate	The timestamp showing when the account was last linked to the system.
lastTransactionDate	The date of the latest transaction on the account. This will not be present until you have run your first aggregation for the account.
institutionLoginId	The institution login ID (from the account record).
displayPosition	The display position of the account at the financial institution, "1" being the top listed account
accountNickname	The account nickname.
oldestTransactionDate	The date of the oldest transaction in the transactions for the account.
marketSegment	The market segment of the account.
detail	Object that contains information on the available balance.
available_balance_amount	The available balance (typically the current balance with adjustments for any pending transactions).
detail	End of the detail object.
customer_accounts	End of the customer_accounts object.
count	The total number of accounts returned.

Updated 7 days ago