Card（カード）

Card API（カード）は、Customer（顧客）へ紐付けているカード情報を扱います。

Attributes

Name	Type	Description
object	string	固定値`card`。
id	string	`/card(_test)?_[0-9a-z]+/`に一致する`CARD_ID`。
livemode	boolean	本番モード (`true`) あるいはテストモード(`false`) か。
location	string	現在の`card`オブジェクトを取得するためのAPIパス。
bank	string	カード会社名注：発行者識別番号(IIN)から取得するので正確ではない場合があります。
brand	string	カードのブランド名。（例：Visa, Mastercard）。
city	string	クレジットカードで登録している住所の「市」。
country	string	2文字の国コードISO 3166 。注：発行者識別番号(IIN)から取得するので正確ではない場合があります。
created_at	string	ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`)でカードが作成されたUTC日時。
deleted	boolean	クレジットカード情報が削除されたかどうか。
email	string	TBD
expiration_month	integer	カードの有効期限に記載されている '月' （1-12）。
expiration_year	integer	カードの有効期限に記載されている '年' 。
financing	string	クレジットカードによる融資種類。「借方」、「貸方」または「前払い」のいずれか。注：発行者識別番号(IIN)から取得するので正確ではない場合があります。
fingerprint	string	カードを基にした一意な指紋。
first_digits	string	クレジットカード番号の最初の6桁。追加のセキュリティ/ビジネス評価に基づいて、特定の加盟店にのみ表示されます。
last_digits	string	カード番号の下4桁。
name	string	クレジットカード表面に記載されている所有者の名義。
phone_number	string	電話番号
postal_code	string	Omiseで登録している住所の '郵便番号' 。
security_code_check	boolean	クレジットカードが事前承認をパスしたかどうか。クレジットカードは、いくつかの理由で事前認証に失敗する場合があります。これには、無効な `security_code`が含まれることなどがありますが、これに限定されません。 2020年4月1日以降、この属性は実際の事前承認の結果に関係なく、trueのみを返します。
state	string	請求先住所の状況
street1	string	請求先住所 #1
street2	string	請求先住所 #2
tokenization_method	string	カードをトークン化する方法です。以下指定できます。 `googlepay` （Google Payによるトークン化） `null` （Opnによるトークン化）これがデフォルトです。

Example

JSON Response

{
  "object": "card",
  "id": "card_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "location": "/customers/cust_test_no1t4tnemucod0e51mo/cards/card_test_no1t4tnemucod0e51mo",
  "deleted": false,
  "street1": "1448/4 Praditmanutham Road",
  "street2": null,
  "city": "Bangkok",
  "state": null,
  "phone_number": "0123456789",
  "postal_code": "10320",
  "country": "th",
  "financing": "credit",
  "bank": "Bank of the Unbanked",
  "brand": "Visa",
  "fingerprint": "XjOdjaoHRvUGRfmZacMPcJtm0U3SEIIfkA7534dQeVw=",
  "first_digits": null,
  "last_digits": "4242",
  "name": "Somchai Prasert",
  "expiration_month": 12,
  "expiration_year": 2024,
  "security_code_check": true,
  "tokenization_method": null,
  "created_at": "2019-12-31T12:59:59Z"
}

カード情報の削除

- DELETE https://api.omise.co/customers/{id}/cards/{card_id}

Customer IDで指定した対象の顧客から、Card IDで指定したカード情報を削除します。

Example

カード情報の削除

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

curl https://api.omise.co/customers/cust_test_5g0221fe8iwtayocgja/cards/card_test_5g021zls9ei5suyryss \
  -X DELETE \
  -u $OMISE_SECRET_KEY:

<?php

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

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

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

const card = omise.customers.destroyCard(
  'cust_test_no1t4tnemucod0e51mo',
  'card_test_no1t4tnemucod0e51mo',
);
console.log(card);

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

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

public void destroyCard() throws Exception {
    Request < Card > request =
        new Card.DeleteRequestBuilder(CUSTOMER_ID, CARD_ID)
        .build();
    Card card = client.sendRequest(request);

    System.out.printf("destroyed card: %s", card.getId());
}

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

customer = omise.Customer.retrieve("cust_test_no1t4tnemucod0e51mo")
card = customer.cards.retrieve("card_test_no1t4tnemucod0e51mo")
card.destroy()

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Deletion{}
err := client.Do(result, &operations.DestroyCard{
	CustomerID: "cust_test_no1t4tnemucod0e51mo",
	CardID:     "card_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

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

カードリストの取得

- GET https://api.omise.co/customers/{id}/cards

cardに属するすべての顧客オブジェクトの list を返します。

Request Parameters

Name	Type	Description
from	string	(任意, default: `1970-01-01T00:00:00Z`) ISO 8601 形式(`YYYY-MM-DDThh:mm:ssZ`)で返されたレコードの最新のUTC日時。
limit	integer	(任意, default: `20`) 返されるレコードの数。
offset	integer	(任意, default: `0`) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。
order	string	(任意, default: `chronological`, one of: `chronological`, `reverse_chronological`) listのオーダーが`chronological` (古い順) or `reverse_chronological` (新しい順)で返されます。エントリがない場合は `null`となります。
to	string	(任意) ISO 8601形式 (`YYYY-MM-DDThh:mm:ssZ`)で返されたレコードの最新のUTC日付と時刻。

Example

カードリストの取得

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

curl https://api.omise.co/customers/cust_test_5g0221fe8iwtayocgja/cards \
  -u $OMISE_SECRET_KEY:

<?php

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

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

const card = await omise.customers.listCards('cust_test_no1t4tnemucod0e51mo');
console.log(card);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

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

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})");
}

Request<ScopedList<Card>> request =
        new Card.ListRequestBuilder("cust_test_4xsjvylia03ur542vn6").build();
ScopedList<Card> cards = client().sendRequest(request);

System.out.printf("Total no. of cards: %d", cards.getTotal());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

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

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.CardList{}
err := client.Do(result, &operations.ListCards{
	CustomerID: "cust_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Customer.list_cards("cust_test_4xsjvylia03ur542vn6")

カード情報の取得

- GET https://api.omise.co/customers/{id}/cards/{card_id}

過去に作成済みのカード(card)オブジェクトを取得します。課金はカードID(Card ID)によって識別されます。ここで返す情報は、カードオブジェクトの作成時に返ってくる情報と同じです。

Example

カード情報の取得

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

curl https://api.omise.co/customers/cust_test_5g0221fe8iwtayocgja/cards/card_test_5g021zls9ei5suyryss \
  -u $OMISE_SECRET_KEY:

<?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();

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

const card = await omise.customers.retrieveCard(
  'cust_test_no1t4tnemucod0e51mo',
  'card_test_no1t4tnemucod0e51mo',
);
console.log(card);

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

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}");

public void getCard() throws Exception {
    Request < Card > request = new Card.GetRequestBuilder(
        CUSTOMER_ID, CARD_ID).build();
    Card card = client.sendRequest(request);

    System.out.println("Card retrieved: " + card.getId());
}

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

customer = omise.Customer.retrieve("cust_test_no1t4tnemucod0e51mo")
card = customer.cards.retrieve("card_test_no1t4tnemucod0e51mo")

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

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Card{}
err := client.Do(result, &operations.RetrieveCard{
	CustomerID: "cust_test_no1t4tnemucod0e51mo",
	CardID:     "card_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

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

カード情報の更新

- PATCH https://api.omise.co/customers/{id}/cards/{card_id}

Customer IDで指定した対象の顧客の、Card IDで指定したカード情報を更新します。

Request Parameters

Name	Type	Description
city	string	(任意だが推奨) 請求先住所の都市名。カード保有者の請求先住所を指定し、米国、英国、カナダのカード保有者の承認率を向上させます。
expiration_month	integer	(任意) カードの有効期限に記載されている '月' （1-12）。
expiration_year	integer	(任意) カードの有効期限に記載されている '年' 。
name	string	(任意) クレジットカード表面に記載されている所有者の名義。
postal_code	string	(任意だが推奨) クレジットカード請求先の郵便番号。カード保有者の請求先住所を指定すると、米国、英国、カナダのカード保有者の承認率が向上します。

Example

カード情報の更新

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

curl https://api.omise.co/customers/cust_test_5g0221fe8iwtayocgja/cards/card_test_5g021zls9ei5suyryss \
  -X PATCH \
  -u $OMISE_SECRET_KEY: \
  -d "expiration_month=12" \
  -d "expiration_year=2022" \
  -d "name=Somchai Prasert" \
  -d "postal_code=10310"

<?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'
));

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

const card = await omise.customers.updateCard(
  'cust_test_no1t4tnemucod0e51mo',
  'card_test_no1t4tnemucod0e51mo',
  {
    expiration_month: 11,
    expiration_year: 2028,
    name: 'John Doe',
    postal_code: 10310,
  },
);
console.log(card);

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"
})

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 = 2022,
});

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

Request<Card> request =
        new Card.UpdateRequestBuilder("card_test_4xsjw0t21xaxnuzi9gs", "cust_test_4xsjvylia03ur542vn6")
                .expirationMonth(4)
                .expirationYear(2020)
                .name("John Doe")
                .postalCode("10101")
                .build();
Card card = client().sendRequest(request);

System.out.printf("Updated card: %s", card.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

customer = omise.Customer.retrieve("cust_test_no1t4tnemucod0e51mo")
card = customer.cards.retrieve("card_test_no1t4tnemucod0e51mo")
card.update(
    expiration_month=11,
    expiration_year=2022,
    name="Somchai Prasert",
    postal_code="10310",
)

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

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Card{}
err := client.Do(result, &operations.UpdateCard{
	CustomerID:     "cust_test_no1t4tnemucod0e51mo",
	CardID:         "card_test_no1t4tnemucod0e51mo",
	City:           "Bangkok",
	ExpirationYear: 2026,
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

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",
])