Retrieve a Card
Retrieve detailed information about a specific card attached to a customer.
API Credentials
Request Parametersโ
Required - 2 fieldsPath Parameters
`id`STRING(required)
Customer ID (must be a valid customer ID starting with cust_).
`card_id`STRING(required)
Card ID (must be a valid card ID starting with card_).
Responsesโ
200
Card retrieved successfullyCard object with complete details.
Card details include:
id- Card IDbrand- Card brand (Visa, MasterCard, JCB, etc.)last_digits- Last 4 digits of card numberfirst_digits- First 6 digits (BIN) - may be nullname- Cardholder nameexpiration_month- Expiration month (1-12)expiration_year- Expiration year (YYYY)bank- Issuing bank namecountry- Card issuing country (ISO 3166-1 alpha-2)fingerprint- Unique card identifiersecurity_code_check- Whether CVV was verified
400
Bad requestInvalid customer ID or card ID format.
Common causes:
- Invalid ID format
- IDs do not start with cust_ or card_
401
UnauthorizedAuthentication 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 foundCustomer or card not found.
Common causes:
- Customer ID does not exist
- Card ID does not exist
- Card does not belong to the specified customer
Code samplesโ
- cURL
- Ruby
- Python
- Node.js
- PHP
- Java
- C#
- Go
curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t/cards/card_test_5xuy4w91xqz7d1w9u0t \
-u skey_test_5xuy4w91xqz7d1w9u0t:
require 'omise'
Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'
card = Omise::Card.retrieve(
'card_test_5xuy4w91xqz7d1w9u0t',
customer_id: 'cust_test_5xuy4w91xqz7d1w9u0t'
)
import omise
omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'
customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')
card = customer.retrieve_card('card_test_5xuy4w91xqz7d1w9u0t')
const omise = require('omise')({
secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});
const card = await omise.customers.retrieveCard(
'cust_test_5xuy4w91xqz7d1w9u0t',
'card_test_5xuy4w91xqz7d1w9u0t'
);
<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');
$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');
$card = $customer->retrieveCard('card_test_5xuy4w91xqz7d1w9u0t');
Client client = new Client.Builder()
.secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
.build();
Card card = client.customer("cust_test_5xuy4w91xqz7d1w9u0t")
.card("card_test_5xuy4w91xqz7d1w9u0t")
.get();
var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");
var card = await client.Customers.GetCard(
"cust_test_5xuy4w91xqz7d1w9u0t",
"card_test_5xuy4w91xqz7d1w9u0t"
);
client, _ := omise.NewClient(
"pkey_test_5xuy4w91xqz7d1w9u0t",
"skey_test_5xuy4w91xqz7d1w9u0t",
)
card, _ := client.Cards().GetCard(
"cust_test_5xuy4w91xqz7d1w9u0t",
"card_test_5xuy4w91xqz7d1w9u0t",
)
Error and result codesโ
Common Error Codesโ
| Code | Description | Resolution |
|---|---|---|
bad_request | Invalid ID format | Check customer and card ID formats |
authentication_failure | Invalid API key | Verify your secret key is correct |
not_found | Customer or card not found | Verify IDs exist and card belongs to customer |
Card Response Fieldsโ
| Field | Description |
|---|---|
id | Card ID (card_*) |
brand | Card brand (Visa, MasterCard, etc.) |
last_digits | Last 4 digits of card number |
first_digits | First 6 digits (BIN) |
name | Cardholder name |
expiration_month | Expiration month (1-12) |
expiration_year | Expiration year (YYYY) |
bank | Issuing bank name |
country | Card issuing country |
fingerprint | Unique card identifier |
security_code_check | Whether CVV was verified |
created_at | Card creation timestamp |
Try it outโ
Required - 2 fields