Card(カード)

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

Attribute

Name Type Description
object string

card と返ることで、このJSONレスポンスがCardの内容に関連することを示す。

id object_id

CardのID。

livemode boolean

本番モード (true) あるいはテストモード(false) card。

location string

現在のcardオブジェクトを取得するためのAPIパス。

bank string

カードの識別番号に基づいた銀行名。 ※この情報は、情報提供のみを目的で保管しているデータのため、100%正確な情報ではありません。

brand string

カードのブランド名。(例:Visa, Mastercard,...)。

city string

クレジットカードで登録している住所の '市' 。

country string

カード番号を基にした国コード。ISO 3166 。 ※この情報は、情報提供のみを目的で保管しているデータのため、100%正確な情報ではありません。

created datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でcard作成の協定世界時(UTC)。

deleted boolean

cardが削除されたかどうか。

expiration_month integer

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

expiration_year integer

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

financing string

カードの種類。(debit または credit)※この情報は、情報提供のみを目的で保管しているデータのため、100%正確な情報ではありません。

fingerprint string

カードを基にした一意なフィンガープリント。

last_digits string

カード番号の下4桁。

name string

クレジットカード表面に記載されている所有者の名義。印字されているアルファベットを半角英字で指定。

postal_code string

クレジットカードで登録している住所の '郵便番号' 。

security_code_check boolean

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

Example

  • Json Response

カードリストの取得

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

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

Request Parameter

Name Type Description
offset integer

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

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

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

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

  • カードリストの取得

カード情報の取得

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

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

Example

  • カード情報の取得

カード情報の更新

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

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

Request Parameter

Name Type Description
name string

任意:クレジットカード表面に記載されている所有者の名義。印字されているアルファベットを半角英字で指定。

expiration_month integer

任意:クレジットカード表面に記載されている、有効期限の月を示す数字(1-12)。

expiration_year integer

(任意:クレジットカード表面に記載されている、有効期限の年を示す数字(yyyy)。

postal_code string

任意:クレジットカードで登録している住所の 郵便番号

city string

任意:クレジットカードで登録している住所の

Example

  • カード情報の更新

カード情報の削除

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

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

Example

  • カード情報の削除

  • Response (JSON)