Transferの削除

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

まだ銀行に送信されていないtransferを完全に削除します。Transferが送信された後（sent: true）は削除できません。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

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

Example:"trsf_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

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

Transferが正常に削除されました。deleted: trueの確認が返されます。

レスポンス構造:

• object - "transfer"
• id - 削除されたtransferのID
• deleted - true（削除を確認）

400

不正なリクエスト

Transferを削除できません。

一般的な原因:

• Transferは既に銀行に送信されています（sent: true）
• Transferは既に支払済みです（paid: true）
• 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 DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = Omise::Transfer.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t')
transfer.destroy

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = omise.Transfer.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t')
transfer.destroy()

Node.js

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

await omise.transfers.destroy('trsf_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$transfer = OmiseTransfer::retrieve('trsf_test_5xuy4w91xqz7d1w9u0t');
$transfer->destroy();

Java

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

client.transfers().destroy("trsf_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

await client.Transfers.Delete("trsf_test_5xuy4w91xqz7d1w9u0t");

Go

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

transfer, _ := client.Transfers().Destroy("trsf_test_5xuy4w91xqz7d1w9u0t")

---

重要な注意事項

• 送信されていないtransfer（sent: false）のみ削除できます
• 削除されたtransferは復元できません
• 削除後、transfer IDは再利用できません
• 削除されたtransferの資金は利用可能残高に残ります

---

Try it out

必須 - 1項目

▼

id(必須)