送金の作成

POSThttps://api.omise.co/transfers

Omiseアカウントの残高から確認済みの受取人の銀行口座に資金を送るための新しい送金を作成します。送金はデフォルトの受取人または特定の受取人に対して行うことができます。

---

リクエストパラメータ

推奨 - 3項目推奨パラメータ

▼

`amount`INTEGER(optional)

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

Example:100000

Constraints:最小値: 1（最小単位）

`recipient`STRING(optional)

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

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

`metadata`OBJECT(optional)

カスタムキーバリューペア（合計最大15,000文字）。送金参照やその他のカスタムデータの保存に便利です。

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

追加 - 3項目追加パラメータ

▼

---

レスポンス

200

取引成功

送金が正常に作成されました。送金ステータスを確認するにはsentとpaidフィールドをチェックしてください。

送金ステータスインジケータ：

• sendable: true - 送金を開始できます。
• sent: true - 送金は銀行に送信されました。
• paid: true - 送金が完了し、資金が受け取られました。
• failure_code - 送金が失敗した場合に存在（下記のエラーコードを参照）。

400

不正なリクエスト

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

一般的な原因：

• 無効な受取人ID
• 無効な金額（利用可能な残高を超過）
• 銀行口座情報の欠落
• 不正なメタデータ形式

401

認証エラー

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

一般的な原因：

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• 不正なHTTP Basic Auth形式

402

支払いが必要

送金処理に失敗しました。

一般的な原因：

• 残高不足
• 受取人が未確認
• アカウントで送金が停止されている
• 無効な銀行口座詳細

5xx

サーバーエラー

サーバー側でエラーが発生しました。これはまれですが、適切に処理する必要があります。

対処方法：

• 指数バックオフでリクエストを再試行
• status.omise.coでサービス障害を確認
• 詳細なガイダンスについてはエラー処理を参照

---

コードサンプル

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",
})

---

エラーコードと結果コード

一般的なエラーコード

コード	説明	解決方法
insufficient_balance	送金を完了するための資金が不足	課金が決済されるのを待つか、金額を減らす
invalid_recipient	受取人IDが見つからないか無効	受取人が存在し、アクティブであることを確認
transfers_suspended	アカウントで送金が無効化されている	Omiseサポートに連絡
transfer_deleted	送金が削除された	削除された送金は処理できません
transfer_sent	送金は既に送信済み	送信済みの送金は変更できません
transfer_failed	送金処理が失敗	詳細はfailure_messageを確認

送金ステータスインジケータ

インジケータ	説明
sendable: true	送金の準備完了
sent: true	送金が銀行に送信された
paid: true	資金が正常に受け取られた
failure_code	エラーが発生（上記のコードを参照）

---

🔑API認証情報

▼

試してみる

推奨 - 3項目

▼

追加 - 2項目

▼

あなたのIP: ...読み込み中...