ดึงข้อมูลลูกค้า

GEThttps://api.omise.co/customers/:id

ดึงข้อมูลที่สมบูรณ์เกี่ยวกับลูกค้า รวมถึงบัตรที่บันทึกไว้ อีเมล คำอธิบาย และ metadata

---

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

▼

---

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

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

▼

`id`STRING(required)

รหัสลูกค้าที่ต้องการดึงข้อมูล (ต้องเริ่มต้นด้วย cust_)

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

---

การตอบกลับ

200

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

ส่งคืนออบเจ็กต์ลูกค้าพร้อมรายละเอียดทั้งหมด รวมถึงบัตรที่บันทึกไว้

ออบเจ็กต์ลูกค้าประกอบด้วย:

• id - รหัสลูกค้า
• email - ที่อยู่อีเมลของลูกค้า
• description - ชื่อหรือคำอธิบายของลูกค้า
• default_card - รหัสของบัตรชำระเงินเริ่มต้น
• cards - ออบเจ็กต์รายการที่มีบัตรที่บันทึกไว้ทั้งหมด
• metadata - ข้อมูลคีย์และค่าที่กำหนดเอง
• created_at - ประทับเวลา ISO 8601 ของการสร้าง

401

ไม่ได้รับการยืนยันตัวตน

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

สาเหตุทั่วไป:

• ขาดหัวข้อ Authorization
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบรหัสลูกค้า

สาเหตุทั่วไป:

• รหัสลูกค้าไม่มีอยู่
• ลูกค้าถูกลบแล้ว
• รูปแบบรหัสลูกค้าไม่ถูกต้อง

---

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

cURL

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = Omise::Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const customer = await omise.customers.retrieve('cust_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Customer customer = client.customers().get("cust_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var customer = await client.Customers.Get("cust_test_5xuy4w91xqz7d1w9u0t");

Go

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

customer, _ := client.Customers().Retrieve("cust_test_5xuy4w91xqz7d1w9u0t", nil)

---

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

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

Code	คำอธิบาย	วิธีแก้ไข
authentication_failure	คีย์ API ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	ไม่พบลูกค้า	ตรวจสอบว่ารหัสลูกค้ามีอยู่
bad_request	รูปแบบรหัสลูกค้าไม่ถูกต้อง	ตรวจสอบว่ารหัสเริ่มต้นด้วย cust_

ฟิลด์การตอบกลับลูกค้า

Field	คำอธิบาย
id	รหัสลูกค้า (cust_*)
email	ที่อยู่อีเมลของลูกค้า
description	ชื่อหรือคำอธิบายของลูกค้า
default_card	รหัสของบัตรชำระเงินเริ่มต้น
cards	ออบเจ็กต์รายการที่มีบัตรที่บันทึกไว้ทั้งหมด
cards.data	อาร์เรย์ของออบเจ็กต์บัตร
cards.total	จำนวนบัตรที่บันทึกไว้ทั้งหมด
metadata	ข้อมูลคีย์และค่าที่กำหนดเอง
created_at	ประทับเวลาการสร้างลูกค้า

---

ลองใช้งาน

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

▼

id(จำเป็น)