Token API

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

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

Full credit card data should never go through your server.

Do not send the credit card data to Omise from your servers directly. You must send the card data from the client browser via Javascript (Omise-JS). The methods described on this page should only be used with fake data in test mode (e.g.: quickly creating some fake data, testing our API from a terminal, etc.). If you are PCI-DSS compliant, sending card data from server requires a valid PCI-DSS certification.

You can learn more about this in Security Best Practices.


Name Type Description
object string

The string token.

id object_id

The TOKEN_ID 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 details.

created datetime

UTC datetime of the creation of the token 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.


  • Json Response

Create a token


Request Parameter

Name Type Description
card[name] string

(required) The cardholder name as printed on the card.

card[number] string

(required) The card number. Note that the number you pass can contains spaces and dashes but will be stripped from the response.

card[expiration_month] integer

(required) The expiration month printed on the card in the format M or MM.

card[expiration_year] integer

(required) The expiration year printed on the card in the format YYYY.

card[security_code] string

(optional) The security code (CVV, CVC, etc) printed on the back of the card.

card[street1] string

(optional) Billing address street #1.

card[street2] string

(optional) Billing address street #2.

card[city] string

(optional) Billing address city.

card[state] string

(optional) Billing address state.

card[postal_code] string

(optional) Billing address postal code.

card[country] string

(optional) Billing address country as two-letter ISO 3166 code.

card[phone_number] string

(optional) Billing address phone number.


  • Create a token

Retrieve a token



  • Retrieve a token