List Cards for a Customer

GEThttps://api.omise.co/customers/:id/cards

Retrieve a paginated list of all cards attached to a specific customer with optional ordering.

---

🔑API Credentials

▼

---

Request Parameters

Required - 1 fieldPath Parameters

▼

`id`STRING(required)

Customer ID (must be a valid customer ID starting with cust_).

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

Additional - 3 fieldsPagination & Sorting

▼

---

Responses

200

Cards retrieved successfully

List object containing card objects and pagination information.

Card object includes:

• id - Card ID (card_*)
• brand - Card brand (Visa, MasterCard, JCB, etc.)
• last_digits - Last 4 digits of card number
• name - Cardholder name
• expiration_month - Card expiration month (1-12)
• expiration_year - Card expiration year (YYYY)
• bank - Issuing bank name
• fingerprint - Unique card identifier (for duplicate detection)

400

Bad request

Invalid parameters provided.

Common causes:

• Invalid limit value (exceeds 100)
• Negative offset value
• Invalid order value

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Customer not found.

Common causes:

• Customer ID does not exist
• Customer has been deleted

---

Code samples

cURL

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t/cards \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

cards = Omise::Card.list({
  customer_id: 'cust_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')
cards = customer.cards()

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const cards = await omise.customers.listCards('cust_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');
$cards = $customer['cards'];

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Card> cards = client.customer("cust_test_5xuy4w91xqz7d1w9u0t")
    .cards()
    .list()
    .limit(20L)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var cards = await client.Customers.ListCards("cust_test_5xuy4w91xqz7d1w9u0t", new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

cards, _ := client.Cards().ListCards("cust_test_5xuy4w91xqz7d1w9u0t", &operations.ListCards{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Invalid parameters	Check limit and offset values
authentication_failure	Invalid API key	Verify your secret key is correct
not_found	Customer not found	Verify customer ID exists

Card Fields

Field	Description
id	Card ID (card_*)
brand	Card brand (Visa, MasterCard, etc.)
last_digits	Last 4 digits of card number
name	Cardholder name
expiration_month	Expiration month (1-12)
expiration_year	Expiration year (YYYY)
bank	Issuing bank name
country	Card issuing country
fingerprint	Unique identifier for duplicate detection

---

Try it out

Required - 1 fields

▼

id(Required)

Additional - 3 fields

▼