Transferの更新

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

Transferステータス情報を更新します。このエンドポイントは主にwebhookコールバックによって使用され、transferの成功/失敗ステータスおよび関連する詳細を更新します。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Transfer ID（例: trsf_test_...）。URLパスで指定します。

Example:"trsf_test_5xuy4w91xqz7d1w9u0t"

Additional - 3 fieldsAdditional Parameters

▼

`success`BOOLEAN(optional)

Transferが成功したか失敗したかを示します。

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

成功したトランザクション

Transferが正常に更新されました。更新されたtransferオブジェクトが返されます。

更新されたtransfer属性:

• failure_code - Transferが失敗した場合のエラーコード
• failure_message - 人間が読める失敗の説明
• その他のtransfer属性は変更されません

400

不正なリクエスト

リクエストの検証に失敗しました。詳細についてはエラーメッセージを確認してください。

一般的な原因:

• failure_codeの値が無効です
• successがfalseの場合にfailure_codeが欠落しています
• 既に完了したtransferは更新できません

401

認証されていません

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なsecret key
• Secret keyの代わりにpublic keyを使用
• HTTP Basic Auth形式が不正

404

見つかりません

Transferが見つかりません。

一般的な原因:

• 無効なtransfer ID
• Transferがアカウントに属していません
• Transferが削除されています
• テストモードとライブモードのIDを混在させています

---

Code samples

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	Transferを完了するための資金が不足しています
invalid_recipient	Recipient IDが見つからないか無効です
transfers_suspended	アカウントでtransferが無効になっています
transfer_deleted	Transferが削除されました
transfer_sent	Transferは既に送信されています
transfer_failed	Transferの処理に失敗しました

---

Try it out

必須 - 1項目

▼

id(必須)

追加 - 3項目

▼