สร้างผู้รับ

POSThttps://api.omise.co/recipients

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

---

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

▼

---

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

Required - 5 fieldsพารามิเตอร์ที่จำเป็น

▼

`name`STRING(required)

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

Example:"John Doe"

`type`STRING(required)

ประเภทของผู้รับ

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"

Recommended - 2 fieldsพารามิเตอร์ที่แนะนำ

▼

Additional - 2 fieldsพารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

ทำรายการสำเร็จ

สร้างผู้รับสำเร็จแล้ว โปรดทราบว่าจะเป็น verified: false โดยค่าเริ่มต้นจนกว่าการตรวจสอบจะเสร็จสมบูรณ์

สถานะการตรวจสอบ:

• verified: false - รอการตรวจสอบ (สร้างใหม่)
• verified: true - บัญชีได้รับการตรวจสอบและพร้อมสำหรับการโอนเงิน
• failure_code != null - การตรวจสอบล้มเหลว (ตรวจสอบ failure_code)
• หมายเลขบัญชีเต็มจะไม่ถูกส่งคืน - แสดงเฉพาะ 4 หลักสุดท้ายเพื่อความปลอดภัย

400

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

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

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

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

401

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

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

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

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

422

ไม่สามารถประมวลผลเอนทิตี

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

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

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

---

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

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",
    },
})

---

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

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

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

ประเภทผู้รับ

Type	คำอธิบาย
individual	บัญชีธนาคารส่วนบุคคล
corporation	บัญชีธุรกิจ/บริษัท

---

ลองใช้งาน

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

▼

name(จำเป็น)

type(จำเป็น)

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

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

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

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

▼

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

▼