List Cards

List cards

curl --request GET \
  --url https://api.cartevo.co/api/v1/cards \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "statusCode": 200,
  "message": "Data retrieved successfully",
  "data": {
    "company_id": "eca5e982-00b5-4aa2-b709-7d5cd673e95c",
    "statistics": {
      "total": 5,
      "active": 5,
      "frozen": 0,
      "terminated": 0,
      "pending": 0,
      "failed": 0,
      "total_balance": 16,
      "available_slots": 5,
      "by_customer": {}
    },
    "cards": [
      {
        "id": "91b3c6d6-111b-44da-9f81-16f019bebe8c",
        "customer_id": "4d4dad81-7899-4612-a9f6-133ce56a4507",
        "status": "ACTIVE",
        "balance": 5,
        "masked_number": "**** **** **** 5407",
        "currency": "USD",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "is_active": true,
        "is_virtual": true
      }
    ]
  }
}

GET

cards

List cards

curl --request GET \
  --url https://api.cartevo.co/api/v1/cards \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "statusCode": 200,
  "message": "Data retrieved successfully",
  "data": {
    "company_id": "eca5e982-00b5-4aa2-b709-7d5cd673e95c",
    "statistics": {
      "total": 5,
      "active": 5,
      "frozen": 0,
      "terminated": 0,
      "pending": 0,
      "failed": 0,
      "total_balance": 16,
      "available_slots": 5,
      "by_customer": {}
    },
    "cards": [
      {
        "id": "91b3c6d6-111b-44da-9f81-16f019bebe8c",
        "customer_id": "4d4dad81-7899-4612-a9f6-133ce56a4507",
        "status": "ACTIVE",
        "balance": 5,
        "masked_number": "**** **** **** 5407",
        "currency": "USD",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "is_active": true,
        "is_virtual": true
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

A list of cards with company statistics.

success

boolean

Example:

true

statusCode

integer

Example:

200

message

string

Example:

"Data retrieved successfully"

data

object

Show child attributes

data.company_id

string<uuid>

Example:

"eca5e982-00b5-4aa2-b709-7d5cd673e95c"

data.statistics

object

Show child attributes

data.statistics.total

integer

Example:

5

data.statistics.active

integer

Example:

5

data.statistics.frozen

integer

Example:

0

data.statistics.terminated

integer

Example:

0

data.statistics.pending

integer

Example:

0

data.statistics.failed

integer

Example:

0

data.statistics.total_balance

integer

Example:

16

data.statistics.available_slots

integer

Example:

5

data.statistics.by_customer

object

Show child attributes

data.statistics.by_customer.{key}

object

Show child attributes

data.statistics.by_customer.{key}.customer_id

string<uuid>

data.statistics.by_customer.{key}.cards_count

integer

Example:

1

data.statistics.by_customer.{key}.total_balance

integer

Example:

5

data.statistics.by_customer.{key}.active_cards

integer

Example:

1

data.cards

object[]

Show child attributes

data.cards.id

string<uuid>

Example:

"91b3c6d6-111b-44da-9f81-16f019bebe8c"

data.cards.customer_id

string<uuid>

Example:

"4d4dad81-7899-4612-a9f6-133ce56a4507"

data.cards.status

string

Example:

"ACTIVE"

data.cards.balance

number

Example:

5

data.cards.masked_number

string

Example:

"**** **** **** 5407"

data.cards.currency

string

Example:

"USD"

data.cards.created_at

string<date-time>

data.cards.updated_at

string<date-time>

data.cards.is_active

boolean

Example:

true

data.cards.is_virtual

boolean

Example:

true

Cards Overview Get Card by ID

⌘I

API documentation

Auth

Cards

Customers

Payment Collection

Webhook

Authorizations

Response