Recipients API
Recipients API ช่วยให้คุณสามารถจัดการปลายทางบัญชีธนาคารสำหรับการโอนเงินได้ Recipients แสดงถึงบัญชีธนาคารที่ได้รับการยืนยันแล้วซึ่งสามารถรับการจ่ายเงินจากยอดคงเหลือ Omise ได้
ภาพรวม
Recipients ช่วยให้คุณสามารถทำสิ่งต่อไปนี้ได้:
- จัดเก็บรายละเอียดบัญชีธนาคารอย่างปลอดภัยเพื่อทำการโอนเงินซ้ำๆ
- ยืนยันความเป็นเจ้าของบัญชีเพื่อป้องกันการฉ้อโกงและข้อผิดพลาด
- จัดการผู้รับเงิน(ผู้ขายในตลาดกลาง ผู้ข าย พันธมิตร)
- รองรับหลายธนาคาร(ในประเทศต่างๆ)
- ติดตาม Metadata ของ Recipientเพื่อการจัดหมวดหมู่และรายงาน
ประเภทของ Recipient
Recipient บุคคล
บัญชีธนาคารสำหรับบุคคล ต้องการ:
- ชื่อเต็ม (ตรงกับบัญชีธนาคาร)
- รายละเอียดบัญชีธนาคาร
- ที่อยู่อีเมล (ตัวเลือกแต่แนะนำให้มี)
Recipient นิติบุคคล
บัญชีธนาคารของบริษัทหรือนิติบุคคล ต้องการ:
- ชื่อบริษัท (ตรงกับบัญชีธนาคาร)
- เลขประจำตัวผู้เสียภาษีหรือหมายเลขทะเบียน
- รายละเอียดบัญชีธนาคาร
- ที่อยู่อีเมล
วงจรชีวิตของ Recipient
- สร้าง - เพิ่ม Recipient ใหม่พร้อมรายละเอียดบัญชีธนาคาร
- ยืนยัน - ยืนยันความเป็นเจ้าของบัญชี (อัตโนมัติหรือด้วยตนเอง)
- ใช้งานได้ - Recipient สามารถรับการโอนเงินได้
- อัปเดต - เปลี่ยนแปลงรายละเอียดหรือ Metadata ของ Recipient
- ลบ - ลบ Recipient (ไม่สามารถใช้สำหรับการโอนเงินได้)
ข้อมูลบัญชีธนาคาร
Recipient ต้องการรายละเอียดบัญชีธนาคาร:
- แบรนด์ ธนาคาร - รหัสธนาคาร (bbl, scb, kbank, ktb, bay เป็นต้น)
- หมายเลขบัญชี - หมายเลขบัญชีธนาคารฉบับสมบูรณ์
- ชื่อบัญชี - ชื่อเจ้าของบัญชี (ต้องตรงกับบันทึกของธนาคาร)
- สาขา(ตัวเลือก) - สาขาธนาคารสำหรับบางประเทศ
ธนาคารที่รองรับ (ประเทศไทย)
| Bank Code | Bank Name |
|---|---|
| bbl | Bangkok Bank |
| kbank | Kasikornbank |
| scb | Siam Commercial Bank |
| ktb | Krung Thai Bank |
| bay | Bank of Ayudhya (Krungsri) |
| tmb | TMB Bank |
| citi | Citibank |
| smbc | Sumitomo Mitsui Banking Corporation |
| sc | Standard Chartered |
กระบวนการยืนยัน
Recipient ต้องได้รับการยืนยันก่อนรับการโอนเงิน:
การยืนยันอัตโนมัติ
- Omise จะยืนยันรายละเอียดบัญชีกับธนาคาร
- โดยปกติจะเสร็จภายในไม่กี่นาที
- สถานะ Recipient จะเปลี่ยนเป็น
verified: true
การยืนยันด้วยตนเอง
- สำหรับกรณีที่ซับซ้อนหรือธนาคารบางประเภท
- อาจต้องการเอกสารเพิ่มเติม
- กรุณาติดต่อฝ่ายสนับสนุนสำหรับการยืนยันด้วยตนเอง
สถานะการยืนยัน
verified: false- รอการยืนยันverified: true- ยืนยันแล้วและพร้อมสำหรับการโอนเงิน- หากการยืนยันล้มเหลว จะเกิดข้อผิดพลาดเมื่อสร้างการโอนเงิน
การยืนยันตัวตน
Endpoint ของ Recipient ทั้งหมดต้องการSecret Keyเพื่อการยืนยันตัวตน ห้ามเปิดเผย Secret Key ในโค้ดฝั่งไคลเอ็นต์
Endpoint ที่มีให้บริการ
| Method | Endpoint | Description |
|---|---|---|
| POST | /recipients | สร้าง Recipient ใหม่ |
| GET | /recipients/:id | ดึงข้อมูล Recipient ที่ระบุ |
| GET | /recipients | แสดงรายการ Recipient ทั้งหมด |
| PATCH | /recipients/:id | อัปเดตรายละเอียด Recipient |
| DELETE | /recipients/:id | ลบ Recipient |
| PATCH | /recipients/:id/verify | ยืนยันบัญชี Recipient |
กรณีการใช้งานทั่วไป
การจ่ายเงินในตลาดกลาง
สร้างบัญชี Recipient สำหรับผู้ขายแต่ละรายและประมวลผลการจ่ายเงินเป็นระยะตามยอดขาย
การจัดการผู้ขาย
จัดเก็บบัญชีธนาคารของผู้ขายเพื่อการชำระค่าใช้จ่ายตามใบแจ้งหนี้และการเบิกค่าใช้จ่ายอัตโนมัติ
โปรแกรมพันธมิตร
จัดการบัญชีธนาคารของพันธมิตรเพื่อการจ่ายค่าคอมมิชชั่น
การเบิกค่าใช้จ่ายให้พนักงาน
จัดเก็บบัญชีธนาคารของพนักงานเพื่อการเบิกค่าใช้จ่ายและการจ่ายเงินเดือน
การจ่ายเงินหลายสกุลเงิน
รองรับ Recipient ต่างประเทศที่มีสกุลเงินและระบบธนาคารที่แตกต่างกัน
แนวทางปฏิบัติที่ดีที่สุด
- ยืนยัน Recipient ทันทีหลังจากสร้าง
- บันทึก Recipient ID ลงในฐานข้อมูลของคุณ
- ใช้ชื่อที่เข้าใจง่ายเพื่อการระบุที่ง่ายขึ้น
- เพิ่มที่อยู่อีเมลเพื่อการแจ้งเตือนและยืนยัน
- ใช้ Metadataเพื่อการจัดหมวดหมู่ (vendor_type, region เป็นต้น)
- จัดการกับความล้มเหลวในการยืนยันอย่างเหมาะสม
- ทดสอบด้วยจำนวนเงินเล็กน้อยก่อนทำการโอนเงินจำนวนมาก
- รักษาข้อมูล Recipient ให้เป็นปัจจุบัน(แจ้งเตือนเมื่อรายละเอียดธนาคารเปลี่ยนแปลง)
ข้อควรพิจารณาด้านความปลอดภัย
- ความเป็นไปตามข้อกำหนด PCI - ข้อมูลบัญชีธนาคารถูกเข้ารหัสเมื่อจัดเก็บ
- การยืนยันบัญชี - ป้องกันการโอนเงินที่ฉ้อโกง
- การควบคุมการเข้าถึง - ใช้การยืนยันตัวตน Secret Key
- บันทึกตรวจสอบ - ติดตามการเปลี่ยนแปลง Recipient ทั้งหมด
- การเก็บรักษาข้อมูล - สามารถลบ Recipient ที่ไม่จำเป็นได้
ทรัพยากรที่เกี่ยวข้อง
- Transfers API - โอนเงินไปยัง Recipient
- Balance API - ตรวจสอบยอดคงเหลือที่มี
- Transactions API - ดูธุรกรรมการโอนเงิน
- Webhooks - รับเหตุการณ์การยืนยัน Recipient
ต้องการความช่วยเหลือหรือไม ่? สำหรับการยืนยันบัญชีธนาคาร ธนาคารที่รองรับ หรือความช่วยเหลือในการรวมระบบ กรุณาติดต่อ support@omise.co