อัปเดตการโอนเงิน

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

อัปเดตข้อมูลสถานะการโอนเงิน endpoint นี้ใช้หลักโดย webhook callbacks เพื่ออัปเดตสถานะความสำเร็จ/ความล้มเหลวของการโอนเงินและรายละเอียดที่เกี่ยวข้อง

---

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

▼

---

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

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Transfer ID (เช่น trsf_test_...) ระบุใน URL path

Example:"trsf_test_5xuy4w91xqz7d1w9u0t"

Additional - 3 fieldsAdditional Parameters

▼

`success`BOOLEAN(optional)

ระบุว่าการโอนเงินสำเร็จหรือล้มเหลว

Example:true

`failure_code`STRING(optional)

รหัสที่ระบุประเภทของความล้มเหลว จำเป็นต้องระบุหาก success เป็น false

Example:"insufficient_balance"

Values:insufficient_balance, invalid_recipient, transfers_suspended, transfer_deleted, transfer_sent, transfer_failed

`failure_message`STRING(optional)

คำอธิบายความล้มเหลวที่อ่านได้ ให้บริบทเพิ่มเติมเกี่ยวกับสิ่งที่ผิดพลาด

Example:"Insufficient funds to complete the transfer"

---

การตอบกลับ

200

ธุรกรรมสำเร็จ

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

แอตทริบิวต์การโอนเงินที่อัปเดต:

• failure_code - รหัสข้อผิดพลาดหากการโอนเงินล้มเหลว
• failure_message - คำอธิบายความล้มเหลวที่อ่านได้
• แอตทริบิวต์การโอนเงินอื่นๆ ยังคงไม่เปลี่ยนแปลง

400

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

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

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

• ค่า failure_code ไม่ถูกต้อง
• ขาด failure_code เมื่อ success เป็น false
• ไม่สามารถอัปเดตการโอนเงินที่เสร็จสมบูรณ์แล้ว

401

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

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

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

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

404

ไม่พบ

ไม่พบการโอนเงิน

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

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

---

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

cURL

curl https://api.omise.co/transfers/trsf_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "success=false" \
  -d "failure_code=insufficient_balance" \
  -d "failure_message=Insufficient funds to complete the transfer"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = Omise::Transfer.update('trsf_test_5xuy4w91xqz7d1w9u0t', {
  success: false,
  failure_code: 'insufficient_balance',
  failure_message: 'Insufficient funds to complete the transfer'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = omise.Transfer.update('trsf_test_5xuy4w91xqz7d1w9u0t',
    success=False,
    failure_code='insufficient_balance',
    failure_message='Insufficient funds to complete the transfer'
)

Node.js

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

const transfer = await omise.transfers.update('trsf_test_5xuy4w91xqz7d1w9u0t', {
  success: false,
  failure_code: 'insufficient_balance',
  failure_message: 'Insufficient funds to complete the transfer'
});

PHP

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

$transfer = OmiseTransfer::retrieve('trsf_test_5xuy4w91xqz7d1w9u0t');
$transfer->update([
    'success' => false,
    'failure_code' => 'insufficient_balance',
    'failure_message' => 'Insufficient funds to complete the transfer'
]);

Java

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

Transfer transfer = client.transfers()
    .update("trsf_test_5xuy4w91xqz7d1w9u0t")
    .success(false)
    .failureCode("insufficient_balance")
    .failureMessage("Insufficient funds to complete the transfer")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var transfer = await client.Transfers.Update("trsf_test_5xuy4w91xqz7d1w9u0t", new UpdateTransferRequest
{
    Success = false,
    FailureCode = "insufficient_balance",
    FailureMessage = "Insufficient funds to complete the transfer"
});

Go

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

transfer, _ := client.Transfers().Update("trsf_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateTransfer{
    Success:        false,
    FailureCode:    "insufficient_balance",
    FailureMessage: "Insufficient funds to complete the transfer",
})

---

รหัสข้อผิดพลาด

รหัสความล้มเหลว

Code	Description
insufficient_balance	เงินทุนไม่เพียงพอในการทำการโอนเงินให้เสร็จสมบูรณ์
invalid_recipient	ไม่พบ Recipient ID หรือไม่ถูกต้อง
transfers_suspended	การโอนเงินถูกปิดใช้งานในบัญชี
transfer_deleted	การโอนเงินถูกลบแล้ว
transfer_sent	การโอนเงินถูกส่งแล้ว
transfer_failed	การประมวลผลการโอนเงินล้มเหลว

---

ลองใช้งาน

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

▼

id(จำเป็น)

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

▼