สร้าง Linked Account
สร้าง linked account ใหม่เพื่อเริ่มการลงทะเบียนวิธีการชำระเงิน การตอบกลับจะรวม registration_uri ที่เจ้าของบัญชีสามารถดำเนินการลงทะเบียนให้เสร็จสมบูรณ์ได้
พารามิเตอร์คำขอ
จำเป็น - 2 ฟิลด์พารามิเตอร์จำเป็น
`type`STRING(required)
ประเภทของ linked account ประเภทที่ใช้ได้ขึ้นอยู่กับวิธีการชำระเงิน (เช่น direct_debit_kbank, direct_debit_scb, direct_debit_bbl สำหรับธนาคารไทย)
`return_uri`STRING(required)
URI สำหรับ redirect เจ้าของบัญชีหลังจากดำเนินการลงทะเบียนเสร็จสิ้น
เพิ่มเติม - 2 ฟิลด์พารามิเตอร์เพิ่มเติม
การตอบกลับ
200
สร้าง linked account สำเร็จสร้าง Linked account แล้ว Redirect เจ้าของบัญชีไปยัง registration_uri เพื่อดำเนินการลงทะเบียนให้เสร็จสิ้น
ฟิลด์อ็อบเจกต์ linked account:
object- เป็น "linked_account" เสมอid- Linked account ID (lacct_*) เก็บไว้ในฐานข้อมูลของคุณlivemode- เป็น linked account โหมด live หรือ teststatus- สถ านะบัญชี: failed, expired, pending, successful หรือ deletedtype- ประเภทของ linked accountlast_digits- ตัวเลขท้ายของ linked account identifier (ถ้ามี)registration_uri- URI ที่เจ้าของบัญชีดำเนินการลงทะเบียนให้เสร็จสิ้นreturn_uri- URI สำหรับ redirect หลังลงทะเบียนexpires_at- เวลาหมดอายุของลิงก์ลงทะเบียนcreated_at- timestamp การสร้าง linked accountregistered_at- เวลาที่ลงทะเบียนเสร็จสิ้น (null ถ้ายังรอดำเนินการ)failure_code- รหัสข้อผิดพลาดถ้าลงทะเบียนล้มเหลว (null ถ้าไม่ล้มเหลว)failure_message- ข้อความข้อผิดพลาดถ้าลงทะเบียนล้มเหลว (null ถ้าไม่ล้มเหลว)metadata- ข้อมูลคีย์-ค่าที่กำหนดเอง
400
คำขอไม่ถูกต้องการตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความแสดงข้อผิดพลาดสำหรับรายละเอียด
สาเหตุทั่วไป:
- ไม่มีพารามิเตอร์จำเป็น (type หรือ return_uri)
- ค่ า type ไม่ถูกต้อง
- รูปแบบ return_uri ไม่ถูกต้อง
- รูปแบบ citizen_id ไม่ถูกต้อง
- Metadata เกิน 15,000 ตัวอักษร
401
ไม่ได้รับอนุญาตการยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือไม่มี
สาเหตุทั่วไป:
- ไม่มี Authorization header
- Secret key ไม่ถูกต้อง
- ใช้ public key แทน secret key
- รูปแบบ HTTP Basic Auth ไม่ถูกต้อง
422
ไม่สามารถประมวลผลได้คำขอถูกต้องแต่ไม่สามารถประมวลผลได้
สาเหตุทั่วไป:
- ประเภท linked account ไม่ได้เปิดใช้งานสำหรับบัญชีของคุณ
- ถึงขีดจำกัดบัญชี
- วิธีการชำระเงินไม่มีในภูมิภาคของคุณ
5xx
ข้อผิดพลาดเซิร์ฟเวอร์เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ เหตุการณ์เหล่านี้หายากแต่ ควรจัดการอย่างเหมาะสม
วิธีจัดการ:
- ลองส่งคำขอใหม่ด้วย exponential backoff
- ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
- ดู การจัดการข้อผิดพลาด สำหรับคำแนะนำโดยละเอียด
ตัวอย่างโค้ด
- cURL
- Ruby
- Python
- Node.js
- PHP
- Java
- C#
- Go
curl https://api.omise.co/linked_accounts \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "type=direct_debit_kbank" \
-d "return_uri=https://example.com/linked-accounts/complete"
require 'omise'
Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'
linked_account = Omise::LinkedAccount.create({
type: 'direct_debit_kbank',
return_uri: 'https://example.com/linked-accounts/complete'
})
import omise
omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'
linked_account = omise.LinkedAccount.create(
type='direct_debit_kbank',
return_uri='https://example.com/linked-accounts/complete'
)
const omise = require('omise')({
secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});
const linkedAccount = await omise.linkedAccounts.create({
type: 'direct_debit_kbank',
return_uri: 'https://example.com/linked-accounts/complete'
});
<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');
$linked_account = OmiseLinkedAccount::create([
'type' => 'direct_debit_kbank',
'return_uri' => 'https://example.com/linked-accounts/complete'
]);
Client client = new Client.Builder()
.secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
.build();
LinkedAccount linkedAccount = client.linkedAccounts().create()
.type("direct_debit_kbank")
.returnUri("https://example.com/linked-accounts/complete")
.send();
var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");
var linkedAccount = await client.LinkedAccounts.Create(new CreateLinkedAccountRequest
{
Type = "direct_debit_kbank",
ReturnUri = "https://example.com/linked-accounts/complete"
});
client, _ := omise.NewClient(
"pkey_test_5xuy4w91xqz7d1w9u0t",
"skey_test_5xuy4w91xqz7d1w9u0t",
)
linkedAccount, _ := client.LinkedAccounts().Create(&operations.CreateLinkedAccount{
Type: "direct_debit_kbank",
ReturnUri: "https://example.com/linked-accounts/complete",
})
รหัสข้อผิดพลาดและผลลัพธ์
รหัสข้อผิดพลาดทั่วไป
| รหัส | คำอธิบาย | วิธีแก้ไข |
|---|---|---|
bad_request | พารามิเตอร์ขาดหายหรือไม่ถูกต้อง | ตรวจสอบว่า type และ return_uri ถูกต้อง |
authentication_failure | API key ไม่ถูกต้อง | ตรวจสอบ secret key ของคุณ |
invalid_linked_account_type | ไม่รองรับประเภท | ตรวจสอบประเภท linked account ที่มี |
not_enabled | ฟีเจอร์ไม่ได้เปิดใช้งาน | ติดต่อฝ่ายสนับสนุนเพื่อเปิดใช้งาน linked accounts |
ค่าสถานะ Linked Account
| สถานะ | คำอธิบาย |
|---|---|
pending | กำลังดำเนินการลงทะเบียน รอดำเนินการให้เสร็จสิ้น |
successful | ลงทะเบียนสำเร็จ |
failed | ลงทะเบียนล้มเหลว (ตรวจสอบ failure_code และ failure_message) |
expired | ลิงก์ลงทะเบียนหมดอายุก่อนดำเนินการเสร็จสิ้น |
deleted | Linked account ถูกลบแล้ว |
ฟิลด์ Linked Account
| ฟิลด์ | คำอธิบาย |
|---|---|
id | Linked account ID (เก็บไว้ในฐานข้อมูลของคุณ) |
type | ประเภทของ linked account |
status | สถานะปัจจุบันของ linked account |
registration_uri | URL สำหรับเจ้าของบัญชีดำเนินการลงทะเบียนให้เสร็จสิ้น |
return_uri | URL redirect หลังลงทะเบียน |
last_digits | ตัวเลขท้ายของ account identifier |
expires_at | เวลาหมดอายุของลิงก์ลงทะเบียน |
registered_at | เวลาที่ลงทะเบียนเสร็จสิ้น |
failure_code | รหัสข้อผิดพลาดถ้าลงทะเบียนล้มเหลว |
failure_message | ข้อความข้อผิดพลาดที่อ่านได้ |
metadata | ข้อมูลคีย์-ค่าที่กำหนดเอง |
created_at | timestamp การสร้าง linked account |
ข้อมูลยืนยันตัวตน API
ทดลองใช้งาน
จำเป็น - 2 ฟิลด์
เพิ่มเติม - 2 ฟิลด์
IP ของคุณ:
...กำลังโหลด...