ดึงข้อมูล Token

GEThttps://vault.omise.co/tokens/:id

ดึงข้อมูลเกี่ยวกับ Token ที่มีอยู่ (รวมถึงสถานะการใช้งานและรายละเอียดบัตรที่เกี่ยวข้อง)

---

🔑ข้อมูลยืนยันตัวตน API

▼

---

พารามิเตอร์คำขอ

จำเป็น - 1 ฟิลด์พารามิเตอร์ที่จำเป็น

▼

`id`STRING(required)

Token ID ที่ต้องการดึงข้อมูล ต้องเริ่มต้นด้วย tokn_ ตามด้วย test_ หรือ live_ และตัวระบุเฉพาะ

Example:"tokn_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องเป็น Token ID ที่ถูกต้อง, รูปแบบ: tokn_(test|live)_[0-9a-z]+

---

การตอบกลับ

200

ดึงข้อมูลสำเร็จ

ดึงข้อมูล Token สำเร็จ ส่งคืนออบเจ็กต์ Token พร้อมรายละเอียดบัตร

การตอบกลับประกอบด้วย:

• id - ตัวระบุ Token
• used - บอกว่า Token ถูกใช้งานหรือไม่ (false หากยังไม่ได้ใช้, true หากใช้แล้ว)
• charge_status - สถานะของการเรียกเก็บเงินที่สร้างด้วย Token (null หากยังไม่ได้ใช้)
• card - ออบเจ็กต์บัตรพร้อมข้อมูลที่ปลอดภัย
• card.brand - แบรนด์บัตร (Visa, Mastercard, JCB เป็นต้น)
• card.last_digits - เลข 4 หลักสุดท้ายของหมายเลขบัตร
• card.fingerprint - ตัวระบุบัตรเฉพาะ
• card.security_code_check - บอกว่ามีการตรวจสอบ CVV หรือไม่

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว คีย์ API ไม่ถูกต้องหรือขาดหายไป

สาเหตุที่พบบ่อย:

• ขาดหายไป Authorization header
• Public key ไม่ถูกต้อง
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบ Token Token ID ที่ระบุไม่มีอยู่

สาเหตุที่พบบ่อย:

• รูปแบบ Token ID ไม่ถูกต้อง
• Token ID ไม่มีอยู่ในบัญชีของคุณ
• กำลังใช้ test key เพื่อเข้าถึง live token (หรือในทางกลับกัน)
• พิมพ์ Token ID ผิด

---

ตัวอย่างโค้ด

cURL

curl https://vault.omise.co/tokens/tokn_test_5xuy4w91xqz7d1w9u0t \
  -u pkey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'pkey_test_5xuy4w91xqz7d1w9u0t'

token = Omise::Token.retrieve('tokn_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_public = 'pkey_test_5xuy4w91xqz7d1w9u0t'

token = omise.Token.retrieve('tokn_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  publicKey: 'pkey_test_5xuy4w91xqz7d1w9u0t'
});

const token = await omise.tokens.retrieve('tokn_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_PUBLIC_KEY', 'pkey_test_5xuy4w91xqz7d1w9u0t');

$token = OmiseToken::retrieve('tokn_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .publicKey("pkey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Token token = client.tokens().get("tokn_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("pkey_test_5xuy4w91xqz7d1w9u0t");

var token = await client.Tokens.Get("tokn_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "",
)

token, _ := client.Tokens().Get("tokn_test_5xuy4w91xqz7d1w9u0t")

---

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	คีย์ API ไม่ถูกต้อง	ตรวจสอบว่า public key ของคุณถูกต้อง
not_found	ไม่พบ Token	ตรวจสอบว่า Token ID ถูกต้องและมีอยู่จริง

สถานะของ Token

ฟิลด์	ค่า	คำอธิบาย
used	false	Token ยังไม่ได้ใช้งานและพร้อมใช้งาน
used	true	Token ถูกใช้งานแล้วและไม่สามารถใช้ซ้ำได้
charge_status	null	Token ยังไม่ได้ถูกใช้งาน
charge_status	successful	Token ถูกใช้สำหรับการเรียกเก็บเงินที่สำเร็จ
charge_status	failed	Token ถูกใช้แต่การเรียกเก็บเงินล้มเหลว
charge_status	pending	Token ถูกใช้แล้ว การเรียกเก็บเงินรออยู่

---

ทดลองใช้งาน

จำเป็น - 1 ฟิลด์

▼

id(จำเป็น)