อัปเดตการเรียกเก็บเงิน

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

อัปเดตคำอธิบายและเมทาดาทาของการเรียกเก็บเงินที่มีอยู่ มีเพียงสองฟิลด์นี้เท่านั้นที่สามารถเปลี่ยนแปลงได้หลังจากสร้างการเรียกเก็บเงินแล้ว

---

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

▼

---

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

จำเป็น - 1 รายการพารามิเตอร์ที่จำเป็น

▼

`id`STRING(required)

ID ของการเรียกเก็บเงินที่ต้องการอัปเดต ต้องเป็นการเรียกเก็บเงินที่ถูกต้องของบัญชีของคุณ

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องเริ่มต้นด้วย chrg_

เพิ่มเติม - 2 รายการพารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

อัปเดตสำเร็จ

การเรียกเก็บเงินถูกอัปเดตสำเร็จ ส่งคืนอ็อบเจ็กต์การเรียกเก็บเงินที่สมบูรณ์พร้อมฟิลด์ที่อัปเดต

ฟิลด์ที่อัปเดต:

• description - คำอธิบายใหม่ (ถ้ามีการระบุ)
• metadata - อ็อบเจ็กต์เมทาดาทาใหม่ (ถ้ามีการระบุ)
• ฟิลด์อื่นๆ ทั้งหมดจะไม่เปลี่ยนแปลง

400

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

ระบุพารามิเตอร์ที่ไม่ถูกต้อง

สาเหตุที่พบบ่อย:

• เมทาดาทาเกิน 15,000 ตัวอักษร
• รูปแบบเมทาดาทาไม่ถูกต้อง
• ไม่ได้ระบุฟิลด์ที่จะอัปเดต

401

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

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

สาเหตุที่พบบ่อย:

• ขาดหายไป Authorization header
• คีย์ลับไม่ถูกต้อง
• ใช้คีย์สาธารณะแทนคีย์ลับ

404

ไม่พบ

ID การเรียกเก็บเงินไม่มีอยู่

สาเหตุที่พบบ่อย:

• ID การเรียกเก็บเงินไม่ถูกต้อง
• การเรียกเก็บเงินจากบัญชีอื่น
• ใช้คีย์ทดสอบสำหรับการเรียกเก็บเงินจริง (หรือในทางกลับกัน)

---

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

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "description=Order #1234 - Shipped" \
  -d "metadata[status]=shipped"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.update('chrg_test_5xuy4w91xqz7d1w9u0t', {
  description: 'Order #1234 - Shipped',
  metadata: { status: 'shipped', tracking: 'TH123456789' }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.update(
    'chrg_test_5xuy4w91xqz7d1w9u0t',
    description='Order #1234 - Shipped',
    metadata={'status': 'shipped', 'tracking': 'TH123456789'}
)

Node.js

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

const charge = await omise.charges.update('chrg_test_5xuy4w91xqz7d1w9u0t', {
  description: 'Order #1234 - Shipped',
  metadata: { status: 'shipped', tracking: 'TH123456789' }
});

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$charge->update(array(
    'description' => 'Order #1234 - Shipped',
    'metadata' => array('status' => 'shipped', 'tracking' => 'TH123456789')
));

Java

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

Map<String, String> metadata = new HashMap<>();
metadata.put("status", "shipped");
metadata.put("tracking", "TH123456789");

Charge charge = client.charges().update("chrg_test_5xuy4w91xqz7d1w9u0t")
    .description("Order #1234 - Shipped")
    .metadata(metadata)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charge = await client.Charges.Update("chrg_test_5xuy4w91xqz7d1w9u0t", new UpdateChargeRequest {
    Description = "Order #1234 - Shipped",
    Metadata = new Dictionary<string, object> {
        { "status", "shipped" },
        { "tracking", "TH123456789" }
    }
});

Go

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

charge, _ := client.UpdateCharge("chrg_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateCharge{
    Description: "Order #1234 - Shipped",
    Metadata: map[string]interface{}{
        "status":   "shipped",
        "tracking": "TH123456789",
    },
})

---

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

ฟิลด์ที่สามารถอัปเดตได้

Field	สามารถอัปเดตได้?	หมายเหตุ
description	ได้	คำอธิบายข้อความสำหรับใช้ภายใน
metadata	ได้	ข้อมูลคีย์-ค่าแบบกำหนดเอง (แทนที่ทั้งหมด)
amount	ไม่ได้	ไม่สามารถเปลี่ยนแปลงหลังจากสร้างแล้ว
currency	ไม่ได้	ไม่สามารถเปลี่ยนแปลงหลังจากสร้างแล้ว
status	ไม่ได้	เปลี่ยนแปลงผ่าน capture/reverse เป็นต้น
card	ไม่ได้	ไม่สามารถเปลี่ยนวิธีการชำระเงิน

พฤติกรรมของเมทาดาทา

การกระทำ	ผลลัพธ์	หมายเหตุสำคัญ
อัปเดตเมทาดาทา	แทนที่อ็อบเจ็กต์ทั้งหมด	ต้องรวมคีย์ทั้งหมดที่ต้องการเก็บไว้
ละเว้นเมทาดาทา	ไม่เปลี่ยนแปลง	เมทาดาทาที่มีอยู่จะถูกเก็บไว้
เมทาดาทาว่าง	ล้างเมทาดาทาทั้งหมด	ข้อมูลที่มีอยู่ทั้งหมดจะถูกลบ

---

ทดลองใช้งาน

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

▼

id(จำเป็น)

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

▼