Card(カード)

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

Attributes

Name Type Description
object string

固定値card

id object_id

/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 datetime

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)でカードが作成されたUTC日時。

deleted boolean

クレジットカード情報が削除されたかどうか。

expiration_month integer

カードの有効期限に記載されている '月' (1-12)。

expiration_year integer

カードの有効期限に記載されている '年' 。

financing string

クレジットカードによる融資種類。 「借方」または「貸方」のいずれか。注:発行者識別番号(IIN)から取得するので正確ではない場合があります。

fingerprint string

カードを基にした一意な指紋。

last_digits string

カード番号の下4桁。

name string

クレジットカード表面に記載されている所有者の名義。

phone_number string

請求先住所の電話番号

postal_code string

Omiseで登録している住所の '郵便番号' 。

security_code_check boolean

カードが事前承認(セキュリティコードチェック)に失敗したかどうか。

state string

請求先住所の状況

street1 string

請求先住所 #1

street2 string

請求先住所 #2

Example

  • JSON Response

カードリストの取得

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

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

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • カードリストの取得

カード情報の取得

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

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

Example

  • カード情報の取得

カード情報の更新

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

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

Request Parameters

Name Type Description
expiration_month integer

(任意) カードの有効期限に記載されている '月' (1-12)。

expiration_year integer

(任意) カードの有効期限に記載されている '年' 。

name string

(任意) クレジットカード表面に記載されている所有者の名義。

city string

(任意) クレジットカードで登録している住所の「市」 。

postal_code string

(任意) Omiseで登録している住所の '郵便番号' 。

Example

  • カード情報の更新

カード情報の削除

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

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

Example

  • カード情報の削除

  • レスポンス (JSON)