อัปเดตผู้รับเงิน

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

อัปเดตรายละเอียดผู้รับเงินรวมถึงชื่อ อีเมล คำอธิบาย และ metadata โปรดทราบว่าไม่สามารถอัปเดตรายละเอียดบัญชีธนาคารได้

---

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

▼

---

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

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

รหัสผู้รับเงิน (เช่น recp_test_...) ระบุใน URL path

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

Additional - 4 fieldsAdditional Parameters

▼

`name`STRING(optional)

ชื่อผู้รับเงินที่อัปเดต

Example:"John Smith"

`email`STRING(optional)

ที่อยู่อีเมลที่อัปเดต

Example:"john.smith@example.com"

`description`STRING(optional)

คำอธิบายที่อัปเดต

Example:"Marketplace seller - Premium"

`metadata`OBJECT(optional)

metadata ที่อัปเดต (แทนที่ metadata ที่มีอยู่ทั้งหมด)

Example:{"seller_id":"SELL-12345","tier":"premium"}

---

การตอบกลับ

200

สำเร็จ

อัปเดตผู้รับเงินสำเร็จ ส่งคืนออบเจ็กต์ผู้รับเงินที่อัปเดตแล้ว

คุณสมบัติผู้รับเงินที่อัปเดต:

• name - ชื่อผู้รับเงินที่อัปเดต
• email - ที่อยู่อีเมลที่อัปเดต
• description - คำอธิบายที่อัปเดต
• metadata - metadata ที่อัปเดต
• รายละเอียดบัญชีธนาคารไม่มีการเปลี่ยนแปลง

400

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

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

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

• รูปแบบอีเมลไม่ถูกต้อง
• metadata มีรูปแบบไม่ถูกต้อง
• metadata เกิน 15,000 ตัวอักษร

401

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

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

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

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

404

ไม่พบ

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

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

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

---

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

cURL

curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "name=John Smith" \
  -d "email=john.smith@example.com"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.update('recp_test_5xuy4w91xqz7d1w9u0t', {
  name: 'John Smith',
  email: 'john.smith@example.com'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
recipient.name = 'John Smith'
recipient.email = 'john.smith@example.com'
recipient.update()

Node.js

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

const recipient = await omise.recipients.update('recp_test_5xuy4w91xqz7d1w9u0t', {
  name: 'John Smith',
  email: 'john.smith@example.com'
});

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');
$recipient->update([
    'name' => 'John Smith',
    'email' => 'john.smith@example.com'
]);

Java

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

Recipient recipient = client.recipients()
    .update("recp_test_5xuy4w91xqz7d1w9u0t")
    .name("John Smith")
    .email("john.smith@example.com")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipient = await client.Recipients.Update("recp_test_5xuy4w91xqz7d1w9u0t", new UpdateRecipientRequest
{
    Name = "John Smith",
    Email = "john.smith@example.com"
});

Go

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

recipient, _ := client.Recipients().Update("recp_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateRecipient{
    Name:  "John Smith",
    Email: "john.smith@example.com",
})

---

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

• ไม่สามารถอัปเดตรายละเอียดบัญชีธนาคารได้
• หากต้องการเปลี่ยนบัญชีธนาคาร ให้ลบผู้รับเงินและสร้างใหม่
• พารามิเตอร์ metadata จะแทนที่ metadata ที่มีอยู่ทั้งหมด
• หากต้องการรักษา metadata ที่มีอยู่ ให้ดึงข้อมูลผู้รับเงินก่อนและรวมเข้าด้วยกัน

---

ลองใช้งาน

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

▼

id(จำเป็น)

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

▼