Skip to main content
GET
/
card
cURL
curl --request GET \
  --url https://api.slash.com/card \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "accountId": "<string>",
      "last4": "<string>",
      "name": "<string>",
      "expiryMonth": "<string>",
      "expiryYear": "<string>",
      "status": "active",
      "isPhysical": true,
      "virtualAccountId": "<string>",
      "isSingleUse": true,
      "pan": "<string>",
      "cvv": "<string>",
      "cardGroupId": "<string>",
      "cardGroupName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "spendingConstraint": {
        "merchantCategoryRule": {
          "merchantCategories": [
            "<string>"
          ],
          "restriction": "allowlist"
        },
        "merchantRule": {
          "merchants": [
            "<string>"
          ],
          "restriction": "allowlist"
        },
        "spendingRule": {
          "utilizationLimit": {
            "limitAmount": {
              "amountCents": 123
            },
            "preset": "daily",
            "timezone": "<string>",
            "startDate": "<string>"
          },
          "utilizationLimitV2": [
            {
              "limitAmount": {
                "amountCents": 123
              },
              "preset": "daily",
              "timezone": "<string>",
              "startDate": "<string>"
            }
          ],
          "transactionSizeLimit": {
            "minimum": {
              "amountCents": 123
            },
            "maximum": {
              "amountCents": 123
            }
          }
        },
        "countryRule": {
          "countries": [
            "<string>"
          ],
          "restriction": "allowlist"
        },
        "merchantCategoryCodeRule": {
          "merchantCategoryCodes": [
            "<string>"
          ],
          "restriction": "allowlist"
        }
      },
      "userData": {},
      "cardProductId": "<string>",
      "modifiers": [
        {
          "name": "only_allow_recurring_payments",
          "value": true
        }
      ]
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.slash.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Query Parameters

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. Cannot be combined with filter:cardGroupName.

filter:cardGroupName
string

Pass in a card group name, This will return all cards that belong to the card group name passed in. Cannot be combined with filter:cardGroupId.

filter:modifier
string

Filter cards by modifier. Format is "modifier_name:value" (e.g., "only_allow_recurring_payments:true"). Returns cards where the specified modifier has the given value.

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

OK

items
Card · object[]
required
metadata
PaginationResponse · object

Response sent when requesting a list of data