Transferの作成

POSThttps://api.omise.co/transfers

Omiseアカウント残高から認証済みrecipientの銀行口座に資金を送金するための新しいtransferを作成します。Transferはデフォルトのrecipientまたは特定のrecipientに対して実行できます。

---

🔑API認証情報

▼

---

リクエストパラメータ

Recommended - 3 fieldsRecommended Parameters

▼

`amount`INTEGER(optional)

最小通貨単位での金額（THBの場合はサタン、USDの場合はセント、JPYの場合は円）。指定しない場合は、送金可能な残高の全額がデフォルトになります。

Example:100000

Constraints:Minimum: 1 (smallest unit)

`recipient`STRING(optional)

Recipient ID（例: recp_test_...）。指定しない場合は、アカウントのデフォルトのrecipientが使用されます。

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

`metadata`OBJECT(optional)

カスタムキーと値のペア（合計最大15,000文字）。転送参照やカスタムデータの保存に便利です。

Example:{"payout_id":"1234","batch":"monthly_payouts"}

Additional - 2 fieldsAdditional Parameters

▼

---

レスポンス

200

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

Transferが正常に作成されました。sentおよびpaidフィールドを確認してtransferのステータスを判断してください。

Transferステータスインジケータ:

• sendable: true - Transferを開始できます。
• sent: true - Transferが銀行に送信されました。
• paid: true - Transfer完了、資金が受領されました。
• failure_code - Transferが失敗した場合に表示されます（以下のエラーコードを参照）。

400

不正なリクエスト

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

一般的な原因:

• 無効なrecipient ID
• 無効な金額（利用可能残高を超過）
• 銀行口座情報の欠落
• 不正な形式のmetadata

401

認証されていません

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

一般的な原因:

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

402

支払いが必要

Transferの処理に失敗しました。

一般的な原因:

• 残高不足
• Recipientが未認証
• アカウントでtransferが停止されています
• 無効な銀行口座の詳細

---

Code samples

cURL

curl https://api.omise.co/transfers \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "amount=100000" \
  -d "recipient=recp_test_5xuy4w91xqz7d1w9u0t"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = Omise::Transfer.create({
  amount: 100000,
  recipient: 'recp_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = omise.Transfer.create(
    amount=100000,
    recipient='recp_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

const transfer = await omise.transfers.create({
  amount: 100000,
  recipient: 'recp_test_5xuy4w91xqz7d1w9u0t'
});

PHP

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

$transfer = OmiseTransfer::create([
    'amount' => 100000,
    'recipient' => 'recp_test_5xuy4w91xqz7d1w9u0t'
]);

Java

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

Transfer transfer = client.transfers().create()
    .amount(100000L)
    .recipient("recp_test_5xuy4w91xqz7d1w9u0t")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var transfer = await client.Transfers.Create(new CreateTransferRequest
{
    Amount = 100000,
    Recipient = "recp_test_5xuy4w91xqz7d1w9u0t"
});

Go

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

transfer, _ := client.Transfers().Create(&operations.CreateTransfer{
    Amount:    100000,
    Recipient: "recp_test_5xuy4w91xqz7d1w9u0t",
})

---

エラーおよび結果コード

一般的なエラーコード

Code	Description	Resolution
insufficient_balance	Transferを完了するための資金が不足しています	請求のクリアを待つか、金額を減らしてください
invalid_recipient	Recipient IDが見つからないか無効です	Recipientが存在しアクティブであることを確認してください
transfers_suspended	アカウントでtransferが無効になっています	Omiseサポートにお問い合わせください
transfer_deleted	Transferが削除されました	削除されたtransferは処理できません
transfer_sent	Transferは既に送信されています	送信済みのtransferは変更できません
transfer_failed	Transferの処理に失敗しました	詳細はfailure_messageを確認してください

Transferステータスインジケータ

Indicator	Description
sendable: true	Transfer送信の準備ができています
sent: true	Transferが銀行に送信されました
paid: true	資金が正常に受領されました
failure_code	エラーが発生しました（上記のコードを参照）

---

Try it out

推奨 - 3項目

▼

追加 - 2項目

▼