Token API

Token API ใช้เพื่อเรียกข้อมูลเกี่ยวกับโทเค็น โทเค็นเป็นตัวแทนของบัตรและสามารถนำไปใช้ได้เพียงครั้งเดียวเท่านั้น เมื่อสร้างขึ้นแล้วโทเค็นสามารถนำไปแปลงเป็นบัตรเพื่อใช้เก็บไว้กับลูกค้า สำหรับการรับชำระเงินในอนาคต

ในการใช้งานจริงโทเค็นจะถูกสร้างขึ้นโดย Omise.js ส่วน Token API ใช้สำหรับการทดสอบระบบภายในเท่านั้น

Full credit card data should never go through your server.

The endpoints described on this page should only be used with test data. In production, tokens should be created and sent directly to our servers from the client using Omise.js, or, if on mobile, the iOS or Android SDKs.

Sending card data from server requires a valid PCI-DSS certification in order to be compliant. You can learn more about this in Security Best Practices.

Attributes

Name Type Description
object string

The string token.

id object_id

The token identifier matching /tokn(_test)?_[0-9a-z]+/.

livemode boolean

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

location string

API path to retrieve the current token object.

card card

Card containing details of card used to generate token.

created_at datetime

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

used boolean

Whether token has been used. Tokens can be used only once either to make a charge or to associate as a new card on a customer.

Example

  • JSON Response

Create a token

- POST https://vault.omise.co/tokens

Creates and returns a new token.

  • Tokens are single-use only
  • This endpoint accepts public key authentication only
  • This endpoint is for testing. In production, use Omise.js to generate tokens
  • To get the most benefit from our automated fraud protection, it is highly recommended to capture billing address details, especially for customers from the United States and Canada.

Request Parameters

Name Type Description
card[expiration_month] integer

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

card[expiration_year] integer

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

card[name] string

(required) Card owner name.

card[number] string

(required) Card number.

card[city] string

(optional, but recommended) Billing address city.

card[country] string

(optional, but recommended) 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.

card[phone_number] string

(optional, but recommended) Billing address phone number.

card[postal_code] string

(optional, but recommended) Card postal code.

card[security_code] string

(optional, but recommended) Card security code (CVV, CVC, etc). Printed on the back.

card[state] string

(optional, but recommended) Billing address state.

card[street1] string

(optional, but recommended) Billing address street #1.

card[street2] string

(optional, but recommended) Billing address street #2.

Example

  • Create a token

  • Create a token using a US card

Retrieve a token

- GET https://vault.omise.co/tokens/{id}

Returns the token matching :id. Note: this endpoint accepts only public key authentication.

Example

  • Retrieve a token