ลบ Recipient

DELETEhttps://api.omise.co/recipients/:id

ลบ Recipient อย่างถาวรเพื่อป้องกันการโอนเงินในอนาคต การโอนเงินที่มีอยู่ไปยัง Recipient จะไม่ได้รับผลกระทบ

---

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

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

▼

`id`STRING(required)

Recipient ID (เช่น recp_test_...) ระบุใน URL path

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

สำเร็จ

ลบ Recipient สำเร็จ ส่งกลับการยืนยันพร้อม deleted: true

แอตทริบิวต์ 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)

401

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

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

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

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

404

ไม่พบ

ไม่พบ Recipient

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

• Recipient ID ไม่ถูกต้อง
• Recipient ไม่ได้อยู่ในบัญชีของคุณ
• Recipient ถูกลบแล้ว
• ใช้ ID โหมดทดสอบและโหมดไลฟ์ปนกัน

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t \
  -X DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
recipient.destroy

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
recipient.destroy()

Node.js

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

await omise.recipients.destroy('recp_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');
$recipient->destroy();

Java

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

client.recipients().destroy("recp_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

await client.Recipients.Delete("recp_test_5xuy4w91xqz7d1w9u0t");

Go

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

recipient, _ := client.Recipients().Destroy("recp_test_5xuy4w91xqz7d1w9u0t")

---

หมายเหตุสำคัญ

• Recipient ที่ถูกลบไม่สามารถกู้คืนได้
• การโอนเงินที่มีอยู่ไปยัง Recipient ที่ถูกลบจะไม่ได้รับผลกระทบ
• เมื่อลบแล้ว Recipient ID ไม่สามารถใช้ซ้ำได้
• หากต้องการอัปเดตข้อมูลบัญชีธนาคาร ให้ลบและสร้าง Recipient ใหม่

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

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