Card API

The Card API allows you to retrieve, update, and delete credit card information for a given customer. New cards are created from tokens and can be added to new and existing customers.

Attributes

Name Type Description
object string

The string card.

id object_id

The card identifier 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: derived from issuer identification number (IIN); 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_at datetime

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

deleted boolean

Whether card is deleted.

expiration_month integer

Card expiration month (M or MM).

expiration_year integer

Card expiration year (YYYY).

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 four (4) digits of card number.

name string

Card owner name.

phone_number string

Billing address phone number.

postal_code string

Card 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

Retrieve a card

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

Returns the card matching :card_id belonging to customer matching :id.

Example

  • Retrieve a card

Update a card

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

Updates the card matching :card_id belonging to customer matching :id.

Request Parameters

Name Type Description
expiration_month integer

(optional) Card expiration month (M or MM).

expiration_year integer

(optional) Card expiration year (YY or YYYY).

name string

(optional) Card owner name.

city string

(optional) Billing address city.

postal_code string

(optional) Card postal code.

Example

  • Update a card

Destroy a card

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

Destroys the card matching :card_id belonging to customer matching :id.

Example

  • Destroy a card

  • JSON Response

List cards

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

Returns a list of cards belonging to customer matching :id.

Request Parameters

Name Type Description
from datetime

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

limit integer

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

offset integer

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

order string

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

to datetime

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

Example

  • List all cards