Create a transfer with chain

POSThttps://api.omise.co/transfers

Create a transfer with merchant_id parameter to link it to a charge chain. This enables manual marketplace transfers with full control over timing and amount.

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 2 fieldsRequired Parameters

▼

`amount`INTEGER(required)

最小通貨単位での振込金額（THBの場合はサタン、USDの場合はセント、JPYの場合は円）。

Example:85000

Constraints:Minimum: 1 (smallest unit)

`recipient`STRING(required)

振込を受け取る受取人ID。検証済みの受取人である必要があります。

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

Recommended - 1 fieldRecommended Parameters

▼

Additional - 1 fieldAdditional Parameters

▼

---

レスポンス

200

作成成功

振込が正常に作成されました。振込は24時間以内に受取人の銀行口座に送金されます。

レスポンスに含まれる内容:

• id - 振込ID
• amount - 振込金額
• recipient - 受取人ID
• sent - 銀行に送金済みかどうか
• paid - 受取人が資金を受け取ったかどうか

400

Bad request

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

一般的な原因:

• 必須フィールドの不足（amount、recipient）
• 無効な金額（負の値またはゼロ）
• 無効な受取人ID形式
• 無効なmerchant_id（課金ID）形式

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーの不足
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用している
• HTTP Basic Auth形式が正しくない

422

Unprocessable entity

ビジネスロジックの制約により、振込を処理できません。

一般的な原因:

• 振込に対する残高不足
• 受取人が未検証
• 受取人が非アクティブまたは取り消されている
• 振込金額が上限を超えている

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = omise.Transfer.create(
    amount=85000,
    recipient='recp_test_5xuy4w91xqz7d1w9u0t',
    merchant_id='chrg_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
bad_request	パラメータの不足または無効	すべての必須フィールドが指定されていることを確認してください
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
insufficient_balance	振込に対する残高不足	アカウント残高を確認してください
recipient_not_verified	受取人が未検証	振込を受け取る前に受取人を検証する必要があります
recipient_inactive	受取人が非アクティブ	受取人のステータスを確認してください

振込ステータスフィールド

フィールド	説明
sent	銀行に送金済みかどうか（false = 保留中、true = 送金済み）
paid	受取人が資金を受け取ったかどうか（false = 送金中、true = 完了）
sent_at	銀行に送金された時刻のタイムスタンプ
paid_at	受取人が資金を受け取った時刻のタイムスタンプ

---

試してみる

必須 - 2項目

▼

amount(必須)

recipient(必須)

推奨 - 1項目

▼

追加 - 1項目

▼