Card API

Attribute

Name	Type	Description
object	string	The string `card`.
id	object_id	The `CARD_ID`.
livemode	boolean	Whether this is a live (`true`) or test (`false`) card.
location	string	Path to retrieve the card.
country	string	Country code based on the card number following the ISO 3166 standard. Note that this information is given for information only and may not always be 100% accurate.
city	string	The city.
bank	string	Bank name based on the issuer identification number of the card (first six digits). Note that this information is given for information only and may not always be 100% accurate.
postal_code	string	The postal code
financing	string	Type of credit card financing (debit or credit). Note that this information is given for information only and may not always be 100% accurate.
last_digits	string	Last 4 digits of the card number.
brand	string	Card brand (e.g.: Visa, Mastercard,...).
expiration_month	integer	Card expiration month (1-12).
expiration_year	integer	Card expiration year.
fingerprint	string	Unique card-based fingerprint. Allows detection of identical cards.
name	string	Card owner full name.
created	datetime	Creation date of the card in ISO 8601 format.

Example

Json Response

{
  "object": "card",
  "id": "card_test_5086xl7amxfysl0ac5l",
  "livemode": false,
  "location": "/customers/cust_test_5086xleuh9ft4bn0ac2/cards/card_test_5086xl7amxfysl0ac5l",
  "country": "us",
  "city": "Bangkok",
  "postal_code": "10320",
  "financing": "",
  "last_digits": "4242",
  "brand": "Visa",
  "expiration_month": 10,
  "expiration_year": 2018,
  "fingerprint": "mKleiBfwp+PoJWB/ipngANuECUmRKjyxROwFW5IO7TM=",
  "name": "Somchai Prasert",
  "security_code_check": true,
  "created": "2015-06-02T05:41:46Z"
}

List all cards

- GET https://api.omise.co/customers/CUSTOMER_ID/cards

Returns a list of cards objects.

Return all cards that belongs to the customer CUSTOMER_ID. You can learn more about lists in the pagination documentation.

Query Parameter

Name	Type	Description
offset	integer	(optional, default: 0) The offset of the first record returned. I.e.: How many records to skip from the beginning.
limit	integer	(optional, default: 20, maximum: 100) The maximum amount of records returned.
from	datetime	(optional, default: `1970-01-01T00:00:00Z`, format: ISO 8601) The UTC date and time limiting the beginning of returned records. E.g.: `2014-10-20T00:00:00Z`
to	datetime	(optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records. E.g.: `2015-01-20T00:00:00Z`
order	string	(optional, default: chronological) The order of the list returned. E.g.: chronological(from earliest to latest), reverse_chronological(from latest to earliest)

Example

List all cards

curl
ruby
python
php
C#
node.js
java
go
elixir

curl -X GET https://api.omise.co/customers/cust_test_4xsjvylia03ur542vn6/cards \
  -u skey_test_4xsjvwfnvb2g0l81sjz:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

customer = Omise::Customer.retrieve("cust_test_4xsjvylia03ur542vn6")
cards = customer.cards

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

customer = omise.Customer.retrieve("cust_test_4xsjvylia03ur542vn6")
cards = customer.cards

<?php

$customer = OmiseCustomer::retrieve('cust_test_4ybb9ymhoi7ju6wuizb');
$cards = $customer->getCards();

var customerId = "cust_test_566l662pnj240tgz61k";
var cards = await Client.Customer(customerId).Cards.GetList();
foreach (var card in cards)
{
    Console.WriteLine($"card: {card.Id} ({card.LastDigits})");
}

omise.customers.listCards('cust_test_4xsjvylia03ur542vn6', function(error, list) {
  /* Response. */
});

ScopedList<Card> cards = client.customer("cust_test_4xsjvylia03ur542vn6")
  .cards().list();
System.out.printf("returned cards: %d", cards.getData().size());
System.out.printf("total no. of cards: %d", cards.getTotal());

cards, list := &omise.CardList{}, &operations.ListCards{
	CustomerID: "cust_test_4xsjvylia03ur542vn6",
}

if e := client.Do(cards, list); e != nil {
	log.Fatalln(e)
}

log.Println("customer:", list.CustomerID, "has this many cards:", len(cards.Data))

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Customer.list_cards("cust_test_4xsjvylia03ur542vn6")

Retrieve a card

- GET https://api.omise.co/customers/CUSTOMER_ID/cards/CARD_ID

Returns a single card object which match CARD_ID and belongs to the customer which match CUSTOMER_ID.

Example

Retrieve a card

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/customers/cust_test_4xsjvylia03ur542vn6/cards/card_test_4xsjw0t21xaxnuzi9gs \
  -u skey_test_4xsjvwfnvb2g0l81sjz:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

customer = Omise::Customer.retrieve("cust_test_4xsjvylia03ur542vn6")
card = customer.cards.retrieve("card_test_4xsjw0t21xaxnuzi9gs")

# Note that you can reload the card once you have an instance of one.
card.reload

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

customer = omise.Customer.retrieve('cust_test_4xsjvylia03ur542vn6')
card = customer.cards.retrieve('card_test_4xsjw0t21xaxnuzi9gs')

# Note that you can reload the card once you have an instance of one.
card.reload()

<?php

$customer = OmiseCustomer::retrieve('cust_test_4xsjvylia03ur542vn6');
$card = $customer->getCards()->retrieve('card_test_4xsjw0t21xaxnuzi9gs');

# Note that you can reload the card once you have an instance of one.
$card->reload();

var customerId = "cust_test_566l662pnj240tgz61k";
var cardId = "card_test_566l661ty3h314lpl9e";
var card = await Client.Customer(customerId).Cards.Get(cardId);
Console.WriteLine($"last digits: {card.LastDigits}");

var omise = require('omise-node')({'secretKey': 'skey_test_4xsjvwfnvb2g0l81sjz'});
omise.customers.retrieveCard(
  'cust_test_4xsjvylia03ur542vn6',
  'card_test_4xsjw0t21xaxnuzi9gs',
  function(error, card) {
    /* Response. */
  }
);

Card card = client.customer("cust_test_4xsjvylia03ur542vn6")
  .cards().get("card_test_4xsjw0t21xaxnuzi9gs");
System.out.printf("card last digits: %s", card.getLastDigits());

card, retrieve := &omise.Card{}, &operations.RetrieveCard{
	CustomerID: "cust_test_4xsjvylia03ur542vn6",
	CardID:     "card_test_4xsjw0t21xaxnuzi9gs",
}

if e := client.Do(card, retrieve); e != nil {
	log.Fatalln(e)
}

log.Println("card:", card.ID, "has last digits:", card.LastDigits)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Customer.retrieve_card("cust_test_4xsjvylia03ur542vn6", "card_test_4xsjw0t21xaxnuzi9gs")

Update a card

- PATCH https://api.omise.co/customers/CUSTOMER_ID/cards/CARD_ID

Update the card which match CARD_ID and belongs to the customer which match CUSTOMER_ID.

Request Parameter

Name	Type	Description
name	string	(optional) The cardholder name as printed on the card.
expiration_month	integer	(optional) The expiration month printed on the card.
expiration_year	integer	(optional) The expiration year printed on the card in the format YYYY.
postal_code	string	(optional) The postal code from the city where the card was issued.
city	string	(optional) The city where the card was issued.

Example

Update a card

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/customers/cust_test_4xsjvylia03ur542vn6/cards/card_test_4xsjw0t21xaxnuzi9gs \
  -X PATCH \
  -u skey_test_4xsjvwfnvb2g0l81sjz: \
  -d "expiration_month=11" \
  -d "expiration_year=2017" \
  -d "name=Somchai Praset" \
  -d "postal_code=10310"

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

customer = Omise::Customer.retrieve("cust_test_4xsjvylia03ur542vn6")
card = customer.cards.retrieve("card_test_4xsjw0t21xaxnuzi9gs")
card.update({
  expiration_month: 11,
  expiration_year: 2017,
  name: "Somchai Praset",
  postal_code: "10310"
})

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

customer = omise.Customer.retrieve("cust_test_4xsjvylia03ur542vn6")
card = customer.cards.retrieve("card_test_4xsjw0t21xaxnuzi9gs")
card.update(
  expiration_month=11,
  expiration_year=2017,
  name="Somchai Praset",
  postal_code="10310"
)

# Or alternatively:
card.expiration_month = 11
card.expiration_year = 2017
card.name = "Somchai Praset"
card.postal_code = "10310"
card.update()

<?php

$customer = OmiseCustomer::retrieve('cust_test_4xsjvylia03ur542vn6');
$card = $customer->getCards()->retrieve('card_test_4xsjw0t21xaxnuzi9gs');
$card->update(array(
  'expiration_month' => 11,
  'expiration_year' => 2017,
  'name' => 'Somchai Praset',
  'postal_code' => '10310'
));

var customerId = "cust_test_566l662pnj240tgz61k";
var cardId = "card_test_566l661ty3h314lpl9e";
var card = await Client.Customer(customerId).Cards.Update(cardId, new UpdateCardRequest
{
    Name = "Somchai Prasert",
    ExpirationMonth = 8,
    ExpirationYear = 2018,
});

Console.WriteLine($"updated card name: {card.Id} ({card.Deleted})");

omise.customers.updateCard(
  'cust_test_4xsjvylia03ur542vn6',
  'card_test_4xsjw0t21xaxnuzi9gs',
  {
    'expiration_month': 11,
    'expiration_year': 2017,
    'name': 'Somchai Praset',
    'postal_code': 10310
  },
  function(error, card) {
    /* Response. */
  }
);

Card card = client.customer("cust_test_4xsjvylia03ur542vn6")
  .cards().update("card_test_4xsjw0t21xaxnuzi9gs", new Card.Update()
                  .expirationMonth("11")
                  .expirationYear("2017")
                  .name("Somchai Prasert")
                  .postalCode("10310"));
System.out.printf("updated card: %s", card.getId());

card, update := &omise.Card{}, &operations.UpdateCard{
	CustomerID: "cust_test_4xsjvylia03ur542vn6",
	CardID:     "card_test_4xsjw0t21xaxnuzi9gs",
}

if e := client.Do(card, update); e != nil {
	log.Fatalln(e)
}

log.Println("updated card name:", card.Name)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Customer.update_card("cust_test_4xsjvylia03ur542vn6", "card_test_4xsjw0t21xaxnuzi9gs", [
  expiration_month: 11,
  expiration_year: 2017,
  name: "Somchai Praset",
  postal_code: "10310",
])

Destroy a card

- DELETE https://api.omise.co/customers/CUSTOMER_ID/cards/CARD_ID

Destroy the card which match CARD_ID and belongs to the customer which match CUSTOMER_ID.

Example

Destroy a card

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/customers/cust_test_4xsjvylia03ur542vn6/cards/card_test_4xsjw0t21xaxnuzi9gs \
  -X DELETE \
  -u skey_test_4xsjvwfnvb2g0l81sjz:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

customer = Omise::Customer.retrieve("cust_test_4xsjvylia03ur542vn6")
card = customer.cards.retrieve("card_test_4xsjw0t21xaxnuzi9gs")
card.destroy

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

customer = omise.Customer.retrieve('cust_test_4xsjvylia03ur542vn6')
card = customer.cards.retrieve('card_test_4xsjw0t21xaxnuzi9gs')
card.destroy()

<?php

$customer = OmiseCustomer::retrieve('cust_test_4xsjvylia03ur542vn6');
$card = $customer->getCards()->retrieve('card_test_4xsjw0t21xaxnuzi9gs');
$card->destroy();

$card->isDestroyed(); # => true

var customer = RetrieveCustomerWithCard();
var card = await Client.Customer(customer.Id).Cards.Destroy(customer.DefaultCard);
Console.WriteLine($"destroyed card: {card.Id} of customer {customer.Id}");

omise.customers.destroyCard(
  'cust_test_4xsjvylia03ur542vn6',
  'card_test_4xsjw0t21xaxnuzi9gs',
  function(error, card) {
    /* Response. */
  }
);

Card card = client.customer("cust_test_4xsjvylia03ur542vn6")
  .cards()
  .destroy("card_test_4xsjw0t21xaxnuzi9gs");
System.out.printf("destroyed card: %s", card.getId());

model, destroy := &omise.Deletion{}, &operations.DestroyCard{
	CustomerID: "cust_test_4xsjvylia03ur542vn6",
	CardID:     "card_test_4xsjw0t21xaxnuzi9gs",
}

if e := client.Do(model, destroy); e != nil {
	log.Fatalln(e)
}

log.Println("card:", model.ID, "has been deleted:", model.Deleted)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Customer.destroy_card("cust_test_4xsjvylia03ur542vn6", "card_test_4xsjw0t21xaxnuzi9gs")

Response (JSON)

curl
ruby
python
php
C#
node.js
java
go
elixir

{
  "object": "card",
  "id": "card_test_4xsjw0t21xaxnuzi9gs",
  "livemode": false,
  "deleted": true
}