สร้าง Recipient

POSThttps://api.omise.co/recipients

สร้าง Recipient ใหม่พร้อมข้อมูลบัญชีธนาคารเพื่อรับการโอนเงินจากยอดคงเหลือ Omise ของคุณ Recipient สามารถเป็นบุคคลธรรมดาหรือนิติบุคคล

---

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

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

▼

`name`STRING(required)

ชื่อ Recipient (ชื่อบุคคลหรือชื่อบริษัท ต้องตรงกับบัญชีธนาคาร)

Example:"John Doe"

`type`STRING(required)

ประเภท Recipient

Example:"individual"

Values:individual, corporation

`bank_account.brand`STRING(required)

รหัสธนาคาร (bbl, kbank, scb, ktb, bay, tmb เป็นต้น)

Example:"bbl"

`bank_account.number`STRING(required)

เลขบัญชีธนาคาร (ไม่มีช่องว่างหรือขีด)

Example:"1234567890"

`bank_account.name`STRING(required)

ชื่อเจ้าของบัญชีตามที่ลงทะเบียนกับธนาคาร (แนะนำให้ใช้ตัวพิมพ์ใหญ่)

Example:"JOHN DOE"

แนะนำ - 2 ฟิลด์พารามิเตอร์ที่แนะนำ

▼

เพิ่มเติม - 2 ฟิลด์พารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

สำเร็จ

สร้าง Recipient สำเร็จ โปรดทราบว่า verified: false โดยค่าเริ่มต้นจนกว่าการยืนยันจะเสร็จสิ้น

แอตทริบิวต์ Recipient ที่ส่งกลับ:

• object - ค่า "recipient"
• id - ตัวระบุ Recipient (recp_*)
• livemode - โหมดไลฟ์หรือโหมดทดสอบ
• location - พาธ API ไปยังออบเจกต์ Recipient
• activated_at - timestamp การเปิดใช้งาน (ISO 8601)
• active - Recipient เปิดใช้งานอยู่หรือไม่
• bank_account - ออบเจกต์บัญชีธนาคารปลายทาง
• created_at - timestamp การสร้าง (ISO 8601)
• default - Recipient เป็นค่าเริ่มต้นของบัญชีหรือไม่
• deleted - Recipient ถูกลบหรือไม่
• description - คำอธิบาย Recipient
• email - อีเมล Recipient
• failure_code - รหัสเหตุผลความล้มเหลว (name_mismatch, account_not_found, bank_not_found)
• metadata - metadata ที่กำหนดเอง
• name - ชื่อ Recipient
• schedule - ตารางการโอนเงิน (ขยายได้)
• tax_id - เลขประจำตัวผู้เสียภาษีของ Recipient
• type - ประเภท Recipient (individual, corporation)
• verified - Recipient ได้รับการยืนยันหรือไม่
• verified_at - timestamp การยืนยัน (ISO 8601)

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความแสดงข้อผิดพลาดสำหรับรายละเอียด

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

• ฟิลด์ที่จำเป็นหายไป (name, type, ฟิลด์ bank_account)
• รูปแบบบัญชีธนาคารไม่ถูกต้อง
• ประเภท Recipient ไม่ถูกต้อง
• รูปแบบ metadata ไม่ถูกต้อง

401

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

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือหายไป

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

• ไม่มี Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

422

ไม่สามารถประมวลผลได้

การตรวจสอบบัญชีธนาคารล้มเหลว

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

• เลขบัญชีธนาคารไม่ถูกต้อง
• ชื่อบัญชีไม่ตรงกับบันทึกของธนาคาร
• ธนาคารไม่รองรับ
• ไม่สามารถยืนยันบัญชีธนาคาร

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ ซึ่งเกิดขึ้นไม่บ่อยแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ลองคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการข้อผิดพลาด สำหรับคำแนะนำโดยละเอียด

---

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

cURL

curl https://api.omise.co/recipients \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "name=John Doe" \
  -d "type=individual" \
  -d "email=john@example.com" \
  -d "bank_account[brand]=bbl" \
  -d "bank_account[number]=1234567890" \
  -d "bank_account[name]=JOHN DOE"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.create({
  name: 'John Doe',
  type: 'individual',
  email: 'john@example.com',
  bank_account: {
    brand: 'bbl',
    number: '1234567890',
    name: 'JOHN DOE'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.create(
    name='John Doe',
    type='individual',
    email='john@example.com',
    bank_account={
        'brand': 'bbl',
        'number': '1234567890',
        'name': 'JOHN DOE'
    }
)

Node.js

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

const recipient = await omise.recipients.create({
  name: 'John Doe',
  type: 'individual',
  email: 'john@example.com',
  bank_account: {
    brand: 'bbl',
    number: '1234567890',
    name: 'JOHN DOE'
  }
});

PHP

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

$recipient = OmiseRecipient::create([
    'name' => 'John Doe',
    'type' => 'individual',
    'email' => 'john@example.com',
    'bank_account' => [
        'brand' => 'bbl',
        'number' => '1234567890',
        'name' => 'JOHN DOE'
    ]
]);

Java

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

BankAccount bankAccount = new BankAccount();
bankAccount.brand("bbl");
bankAccount.number("1234567890");
bankAccount.name("JOHN DOE");

Recipient recipient = client.recipients().create()
    .name("John Doe")
    .type("individual")
    .email("john@example.com")
    .bankAccount(bankAccount)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipient = await client.Recipients.Create(new CreateRecipientRequest
{
    Name = "John Doe",
    Type = "individual",
    Email = "john@example.com",
    BankAccount = new BankAccount
    {
        Brand = "bbl",
        Number = "1234567890",
        Name = "JOHN DOE"
    }
});

Go

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

recipient, _ := client.Recipients().Create(&operations.CreateRecipient{
    Name:  "John Doe",
    Type:  "individual",
    Email: "john@example.com",
    BankAccount: &operations.BankAccount{
        Brand:  "bbl",
        Number: "1234567890",
        Name:   "JOHN DOE",
    },
})

---

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

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

รหัส	คำอธิบาย	การแก้ไข
bad_request	พารามิเตอร์หายไปหรือไม่ถูกต้อง	ตรวจสอบว่ามีฟิลด์ที่จำเป็นทั้งหมด
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
invalid_bank_account	เลขบัญชีธนาคารไม่ถูกต้อง	ตรวจสอบว่าเลขบัญชีถูกต้อง
name_mismatch	ชื่อบัญชีไม่ตรงกับบันทึกของธนาคาร	ใช้ชื่อที่ถูกต้องจากบัญชีธนาคาร
unsupported_bank	ธนาคารไม่รองรับสำหรับ Recipient	ตรวจสอบรายการธนาคารที่รองรับ

ประเภท Recipient

ประเภท	คำอธิบาย
individual	บัญชีธนาคารส่วนบุคคล
corporation	บัญชีธุรกิจ/นิติบุคคล

---

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

▼

ลองใช้งาน

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

▼

name(จำเป็น)

type(จำเป็น)

bank_account[brand](จำเป็น)

bank_account[number](จำเป็น)

bank_account[name](จำเป็น)

แนะนำ - 2 ฟิลด์

▼

เพิ่มเติม - 2 ฟิลด์

▼

IP ของคุณ: ...กำลังโหลด...