Card API

Card API สามารถใช้เพื่อเรียกดู, อัพเดต และลบข้อมูลบัตรเครดิตที่ได้มีการจัดเก็บไว้ได้ ส่วนบัตรใบใหม่ๆ ที่มีการสร้างเพิ่มขึ้นมาโดยการใช้ token สามารถสร้างเป็นลูกค้า (customer) ขึ้นใหม่ หรือเพิ่มเข้าไปกับลูกค้าเดิมที่มีอยู่แล้ว

Attribute

Name Type Description
object string

The string card.

id object_id

The CARD_ID matching /card(_test)?_[0-9a-z]+/.

livemode boolean

Whether this is a live (true) or test (false) card.

location string

API path to retrieve the current card object.

bank string

Card bank name. Note: value derived from issuer identification number (IIN) so may not be accurate.

brand string

Card brand (e.g. Visa, Mastercard).

city string

Billing address city.

country string

Billing address country as two-letter ISO 3166 code. Note: if not supplied at token creation, value derived from issuer identification number (IIN) so may not be accurate.

created datetime

The UTC datetime of the creation of the card in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

deleted boolean

Whether the card is deleted.

expiration_month integer

Card expiration month (1-12).

expiration_year integer

Card expiration year.

financing string

Type of credit card financing. One of debit or credit. Note: derived from issuer identification number (IIN); may not be accurate.

fingerprint string

Unique card-based fingerprint. Allows detection of identical cards.

last_digits string

Last 4 digits of the card number.

name string

Card owner full name.

phone_number string

Billing address phone number.

postal_code string

Billing address postal code.

security_code_check boolean

Whether card failed pre-authorization. A card may fail pre-authorization for several reasons including, but not limited to, having an invalid security_code.

state string

Billing address state.

street1 string

Billing address street #1.

street2 string

Billing address street #2.

Example

  • Json Response

List all cards

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

Returns a list of all card objects belonging to the customer.

Request Parameter

Name Type Description
offset integer

(optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning).

limit integer

(optional, default: 20, maximum: 100) Number of records to return.

from datetime

(optional, default: 1970-01-01T00:00:00Z) Earliest UTC date and time for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

to datetime

(optional, default: current UTC datetime) Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

order string

(optional, default: chronological) Order in which to return records. One of chronological (earliest to latest) or reverse_chronological (latest to earliest).

Example

  • List all cards

Retrieve a card

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

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

Example

  • Retrieve a card

Update a card

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

Updates the card which matches CARD_ID and belongs to the customer which matches 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

Destroy a card

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

Destroys the card which matches CARD_ID and belongs to the customer which matches CUSTOMER_ID.

Example

  • Destroy a card

  • JSON Response