List cards

GET

card

Authorizations

X-API-Key

string

headerrequired

Authentication from public API requests

Query Parameters

filter:legalEntityId

string

Pass in a legal entity ID to filter for cards in accounts under a specific legal entity.

filter:accountId

string

Pass in an account ID to filter for cards under a specific account.

filter:virtualAccountId

string

Pass in a virtual account ID to filter for cards under a specific virtual account.

cursor

string

A cursor string to fetch the next page of results

filter:status

enum<string>

Returns all cards matching the status passed in.

Available options:

active,

paused,

closed,

inactive

filter:cardGroupId

string

Pass in a card group ID, This will return all cards that belong to the card group ID passed in.

sort

enum<string>

Sorts card by creation date or name.

Available options:

createdAt,

name

sortDirection

enum<string>

The direction to apply the sort filter by. Default ASC.

Available options:

ASC,

DESC

Response

200 - application/json

items

object[]

required

items.id

string

required

items.accountId

string

required

The account that this card is associated with

items.virtualAccountId

string

The virtual account that this card is associated with

items.last4

string

required

The last 4 digits of the card number

items.name

string

required

The name assigned to the card that appears on the user dashboard

items.expiryMonth

string

required

The month the card expires formatted as MM (01, 02, ..., 12)

items.expiryYear

string

required

The year the card expires formatted as YYYY (2024, 2025, ...)

items.status

enum<string>

required

The status of the card

Available options:

active,

paused,

inactive,

closed

items.isPhysical

boolean

required

When true, a physical card has been issued. Otherwise, this is a virtual card.

items.isSingleUse

boolean

When true, the card will be automatically closed after a single authorization attempt. Note that the card will be closed even if the authorization declines or drops

items.pan

string

This field contains the full PAN which will only be sent on a request for a single card when you set the query param "include_pan" to "true"

items.cvv

string

This field will contain full CVV which will only be sent on a request for a single card when you set the query param "include_pan" to "true"

items.cardGroupId

string

The card group the card belongs to.

items.createdAt

string

items.spendingConstraint

object

The spending constraint applied to the card

items.spendingConstraint.spendingRule

object

required

items.spendingConstraint.spendingRule.utilizationLimit

object

items.spendingConstraint.spendingRule.utilizationLimitV2

object[]

items.spendingConstraint.spendingRule.transactionSizeLimit

object

items.spendingConstraint.merchantCategoryRule

object

items.spendingConstraint.merchantRule

object

items.userData

object

Arbitrary information that can be attached to the card. See the PATCH /card/{cardId} endpoint for more details on how to add user data.

items.cardProductId

string

The ID of the card product this card was created with.

metadata

object

Response sent when requesting a list of data

Send money to a slash handle Retrieve card

Overview

Entities

Legal Entity

Account

Virtual Account

Transaction

Slash Pay

Card

Card Group

Merchant

Webhooks

Authorizations

Query Parameters

Response