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

Authorizations

​
X-API-Key
string
header
required

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. 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.

​
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

OK

The response is of type object.