Get cards

List cards available to the authenticated Partner.

GET /api/partner/v1/cards

Get cards

cURL

curl --request GET \
  --url https://app.payemcard.com/api/partner/v1/cards \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "current_page": 123,
  "page_size": 123,
  "results": [
    {
      "id": 123,
      "type": "EMPLOYEE",
      "status": "UNACTIVATED",
      "label": "<string>",
      "last_four": "<string>",
      "card_network": "<string>",
      "classification": {
        "department_id": 123,
        "account_id": 123,
        "class_id": 123,
        "location_id": 123
      },
      "vendor_details": {
        "id": 123,
        "name": "<string>"
      },
      "subsidiary_details": {
        "id": 123,
        "name": "<string>"
      },
      "employee_details": {
        "id": 123,
        "email": "<string>"
      },
      "spend_controls": {
        "periodic_limits": {
          "max_daily_amount": 123,
          "max_weekly_amount": 123,
          "max_monthly_amount": 123,
          "max_quarter_amount": 123,
          "max_yearly_amount": 123
        },
        "hard_limit": 123,
        "max_single_transaction": 123,
        "max_transactions_count": 123,
        "valid_from": "2023-12-25",
        "valid_to": "2023-12-25"
      },
      "usage": {
        "day": 123,
        "week": 123,
        "month": 123,
        "quarter": 123,
        "year": 123,
        "hard_limit": 123
      },
      "shared_with": [
        123
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Short-lived OAuth 2.0 access token. Tokens expire after five minutes.

Query Parameters

card_owner_id · integer

Filter by card owner ID. Applied only when card_type is also provided.

card_type · enum<string>

Filter by card type.

Available options: EMPLOYEE, SINGLE-USE, VENDOR

last_four · string

Filter by the last four digits of the card number.

page · integer · default: 1

Page number

page_size · integer · default: 50

Number of results per page. Defaults to 50. Values above 100 are clamped to 100.

search · string · default: ""

Search string

status · enum<string>

Filter by card status.

Available options: ACTIVE, ADMIN_SUSPENDED, AUTO_SUSPENDED, IN_PROCESS, PREACTIVE, TERMINATED, UNACTIVATED, USER_SUSPENDED

subsidiary_id · integer

Filter by subsidiary ID.

Response

200 - application/json

count · integer · required

current_page · integer · required

page_size · integer · required

results · object[] · required

Show child attributes