ลบผู้รับเงิน

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

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

---

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

▼

---

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

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Recipient ID (เช่น recp_test_...) ระบุในพาธของ URL

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

ลบผู้รับเงินสำเร็จแล้ว ส่งคืนการยืนยันด้วย deleted: true

โครงสร้างการตอบกลับ:

• object - "recipient"
• id - ID ของผู้รับเงินที่ถูกลบ
• deleted - true (ยืนยันการลบ)

401

ไม่ได้รับการยืนยันตัวตน

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

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

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

404

ไม่พบ

ไม่พบผู้รับเงิน

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

• recipient ID ไม่ถูกต้อง
• ผู้รับเงินไม่ได้เป็นของบัญชีของคุณ
• ผู้รับเงินถูกลบไปแล้ว
• ผสม ID โหมดทดสอบและโหมดจริง

---

Code samples

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 ID ไม่สามารถนำกลับมาใช้ใหม่ได้
• หากต้องการอัปเดตรายละเอียดบัญชีธนาคาร ให้ลบและสร้างผู้รับเงินใหม่

---

Try it out

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

▼

id(จำเป็น)