Resources

This page documents the JSON:API resource schema for wallet accounts.

WalletAccount

The WalletAccount resource represents a wallet account that can be used to send and store money on behalf of third parties.

For the complete resource schema, see WalletAccount.

Key Attributes

Attribute	Type	Description
name	string	Optional. Name of the wallet account
status	string	Status of the wallet: Open, Frozen, or Closed
balance	integer	The balance amount (in cents)
hold	integer	The hold amount (in cents)
available	integer	The available balance (in cents)
currency	string	Currency of the wallet (e.g., USD)
tags	object	Optional. See Tags
walletTerms	string	The wallet terms associated with the account
createdAt	RFC3339 Date string	The date the wallet was created
updatedAt	RFC3339 Date string	Optional. The date the wallet was last updated
closedAt	RFC3339 Date string	Optional. The date the wallet was closed
closeReason	string	Optional. The reason for closing (ByCustomer, Fraud, ByBank, NegativeBalance)
frozenAt	RFC3339 Date string	Optional. The date the wallet was frozen
freezeReason	string	Optional. The reason for freezing (Fraud or Other)

Relationships

Relationship	Type	Description
customer	Customer	The customer who owns the wallet
org	Org	The organization the wallet belongs to

Account End-Of-Day

The AccountEndOfDay resource represents a snapshot of an account's balance at the end of each business day.

For the complete resource schema, see Account End-Of-Day.

Key Attributes

Attribute	Type	Description
date	ISO Local Date string	The date of the end-of-day snapshot
balance	integer	The account balance (in cents) at the end of day
hold	integer	The hold amount (in cents) at the end of day
available	integer	The available balance (in cents) at the end of day