送金の削除
まだ銀行に送信されていない送金を完全に削除します。送金が送信された後(sent: true)は削除できません。
リクエストパラメータ
必須 - 1項目必須パラメータ
`id`STRING(required)
送金ID(例: trsf_test_...)。URLパスで指定します。
レスポンス
200
取引成功送金が正常に削除されました。deleted: trueで確認を返します。
レスポンス構造:
object- "transfer"id- 削除された送金のIDdeleted- true(削除を確認)
400
不正なリクエスト送金を削除できません。
一般的な原因:
- 送金は既に銀行に送信済み(
sent: true) - 送金は既に支払済み(
paid: true) - 送金は既に失敗
401
認証エラー認証に失敗しました。無効または欠落したAPIキーです。
一般的な原因:
- Authorizationヘッダーの欠落
- 無効なシークレットキー
- シークレットキーの代わりにパブリックキーを使用
- 不正なHTTP Basic Auth形式
404
見つかりません送金が見つかりません。
一般的な原因:
- 無効な送金ID
- 送金がアカウントに属していない
- 送金は既に削除済み
- テストモードとライブモードのIDが混在
5xx
サーバーエラーサーバー側でエラーが発生しました。これはまれですが、適切に処理する必要があります。
対処方法:
- 指数バックオフでリクエストを再試行
- status.omise.coでサービス障害を確認
- 詳細なガイダンスについてはエラー処理を参照
コードサンプル
- cURL
- Ruby
- Python
- Node.js
- PHP
- Java
- C#
- Go
curl https://api.omise.co/transfers/trsf_test_5xuy4w91xqz7d1w9u0t \
-X DELETE \
-u skey_test_5xuy4w91xqz7d1w9u0t:
require 'omise'
Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'
transfer = Omise::Transfer.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t')
transfer.destroy
import omise
omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'
transfer = omise.Transfer.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t')
transfer.destroy()
const omise = require('omise')({
secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});
await omise.transfers.destroy('trsf_test_5xuy4w91xqz7d1w9u0t');
<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');
$transfer = OmiseTransfer::retrieve('trsf_test_5xuy4w91xqz7d1w9u0t');
$transfer->destroy();
Client client = new Client.Builder()
.secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
.build();
client.transfers().destroy("trsf_test_5xuy4w91xqz7d1w9u0t");
var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");
await client.Transfers.Delete("trsf_test_5xuy4w91xqz7d1w9u0t");
client, _ := omise.NewClient(
"pkey_test_5xuy4w91xqz7d1w9u0t",
"skey_test_5xuy4w91xqz7d1w9u0t",
)
transfer, _ := client.Transfers().Destroy("trsf_test_5xuy4w91xqz7d1w9u0t")
重要な注意事項
- 送信されていない 送金(
sent: false)のみ削除できます - 削除された送金は復元できません
- 削除後、送金IDは再利用できません
- 削除された送金の資金は利用可能な残高に残ります
API認証情報
試してみる
必須 - 1項目
あなたのIP:
...読み込み中...