Enumerations

This index provides a detailed and organized master list of API enumerations, which includes possible values, associated objects, and links to relevant examples and further documentation. This resource aims to improve developer engagement and provide clear guidance on using enumeration values within our APIs.

Custodial Accounts

List Custodial Line Items Endpoint Enumerations

Status

Definition: Filter results based on the status of custodial line items. Multiple values are allowed.

Example: status[]=pending&status[]=settled

Possible Values

Value	Description
`settled`	The custodial line item has settled.
`voided`	The custodial line item has been voided.

Sort

Definition: Sort the results based on specific attributes.

Example: sort=created_at_asc

Possible Values

Value	Description
`created_at_asc`	Sort by creation date (ascending).
`created_at_desc`	Sort by creation date (descending).
`description_asc`	Sort by description (ascending).
`description_desc`	Sort by description (descending).
`settled_in_desc`	Sort by settled index (descending).

Liability

Definition: Filter by liability or asset.

Example: liability=true

Possible Values

Value	Description
`TRUE`	Includes line items flagged as liabilities.
`FALSE`	Includes line items flagged as assets.

Type

Definition: Filter results based on type. Multiple values are allowed.

Example: type[]=dda&type[]=dda_cash_external

Possible Values

Value	Description
`dda`	Demand deposit accounts.
`dda_cash_external`	External cash deposit accounts.

Synthetic Accounts

List Synthetic Line Items Endpoint Enumerations

Status

Definition: Filter results based on the status of synthetic line items. Multiple values are allowed.

Example: status[]=begun&status[]=failed

Possible Values

Value	Description
`begun`	Synthetic line item has begun.
`failed`	Synthetic line item has failed.
`in_progress`	Synthetic line item is in progress.
`settled`	Synthetic line item has settled.

Sort

Definition: Sort the results based on specific attributes.

Example: sort=created_at_asc

Possible Values

Value	Description
`created_at_asc`	Sort by creation date (ascending).
`created_at_desc`	Sort by creation date (descending).
`description_asc`	Sort by description (ascending).
`description_desc`	Sort by description (descending).

Debit Cards

Reissue a Debit Card Endpoint Enumerations

Force Reset

Definition: Used to force retrieval of a new PIN token, restarting the PIN change process for a Debit Card.

Example: force_reset=true

Possible Values

Value	Description
`TRUE`	Forces a new PIN token.
`FALSE`	Uses the existing token.

Reissue Reason

Definition: Specifies the reason for reissuing a debit card. Required when reissuing a card.

Example: reissue_reason=damaged

Possible Values

Value	Description
`Damaged`	The card is physically damaged.
`Lost`	The card has been lost.
`Stolen`	The card has been stolen.

List All Debit Cards Endpoint Enumerations

Locked

Definition: Indicates whether to return only locked or only unlocked cards.

Example: locked=true

Possible Values

Value	Description
`TRUE`	Return only locked cards.
`FALSE`	Return only unlocked cards.

Status

Definition: Filters debit cards based on their current status. Multiple values are allowed.

Example: status[]=issued&status[]=closed

Possible Values

Value	Description
`Queued`	Debit card issuance is queued.
`Issued`	Debit card has been issued.
`Printing`	Physical card is being printed.
`Shipped`	Card has been shipped to the user.
`Usable Without PIN`	Card can be used without requiring a PIN.
`Normal`	Card is in normal status.
`Closed`	Debit card has been closed.
`Damaged`	Card is flagged as damaged.
`Lost`	Card is flagged as lost.
`Stolen`	Card is flagged as stolen.
`Administrative Lock`	Card is locked by an administrator.
`Shipment Returned`	Card shipment was returned.