バージョン: 最新版

Transfers API

Transfers APIを使用すると、Omiseアカウントの残高から受取人の銀行口座に資金を送金できます。Transferは、販売者、ベンダー、または個人に資金を移動する支払いプロセスの最終ステップです。

概要

Transfersでは以下のことができます：

受取人への資金送金 - Omise残高から銀行口座へ送金
支払いのスケジュール設定 - 受取人への資金送信のタイミングを制御
Transferステータスの追跡 - 保留中、送信済み、支払済み、失敗したTransferを監視
Metadataの管理 - 照合とレポート用のカスタムデータを添付
失敗の処理 - 失敗したTransferを特定して再試行

Transferのライフサイクル

作成 - 受取人へのTransferを開始
保留中 - Transferは処理のためにキューに入れられる
送信済み - Transferは銀行システムに送信された
支払済み - 資金が受取人の銀行口座に正常に到達
失敗 - Transferが失敗（残高不足、無効な口座など）

主要な概念

受取人

Transferには受取人が必要です。受取人は確認済みの銀行口座の送金先です。Transferを開始する前に受取人を作成する必要があります。

残高要件

Transferは利用可能残高から差し引かれます。Transferを作成する前に十分な資金があることを確認してください。

処理時間

タイ: 国内銀行送金の場合1〜2営業日
海外: 送金先の国により3〜7営業日

Transfer制限

Transfer制限は、アカウント設定と受取人の確認ステータスによって異なります。カスタム制限についてはサポートにお問い合わせください。

認証

すべてのTransferエンドポイントには、認証のためにSecret Keyが必要です。クライアント側のコードでSecret Keyを公開しないでください。

利用可能なエンドポイント

Method	Endpoint	Description
POST	`/transfers`	新しいTransferを作成
GET	`/transfers/:id`	特定のTransferを取得
GET	`/transfers`	すべてのTransferを一覧表示
PATCH	`/transfers/:id`	Transferを更新
DELETE	`/transfers/:id`	保留中のTransferをキャンセル

一般的な使用例

マーケットプレイスの支払い

取引成功後に自動手数料控除で販売者に資金を送金します。

アフィリエイトコミッション

Metadataに保存されたパフォーマンス指標に基づいて、アフィリエイトへの月次Transferをスケジュール設定します。

銀行口座への返金

元の支払い方法の代わりに、顧客の銀行口座に直接返金を処理します。

ベンダーへの支払い

会計システムと統合された自動Transferでサプライヤーやベンダーに支払います。

ベストプラクティス

受取人を確認してからTransferを開始する
残高を確認して十分な資金があることを確認する
Metadataを使用して照合と追跡を行う
Webhookを実装してTransferステータスの変更を監視する
失敗を適切に処理し、再試行ロジックを使用する
徹底的にテストし、本番Transferを処理する前にテストモードで確認する

概要​

Transferのライフサイクル​

主要な概念​

受取人​

残高要件​

処理時間​

Transfer制限​

認証​

利用可能なエンドポイント​

一般的な使用例​

マーケットプレイスの支払い​

アフィリエイトコミッション​

銀行口座への返金​

ベンダーへの支払い​

ベストプラクティス​

関連リソース​

概要