Create a charge with chain

POSThttps://api.omise.co/charges

Create a charge with a destination parameter to enable marketplace payment splitting. This creates a chain linking the charge to an automatic transfer to a recipient.

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 3 fieldsRequired Parameters

▼

`amount`INTEGER(required)

最小通貨単位での金額（THBの場合はサタン、USDの場合はセント、JPYの場合は円）。例: 100000サタン = 1,000 THB。

Example:100000

Constraints:Minimum: 1 (smallest unit), Maximum: Varies by payment method and currency

`currency`STRING(required)

ISO 4217の3文字通貨コード（小文字）。

Example:"thb"

Values:thb, jpy, sgd, myr, usd

`destination`STRING(required)

課金成功後に自動振込を受け取る受取人ID。marketplaceの支払い分割に必要です。

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

Required - 1 of 3 fieldsPayment Method (one required)

▼

`card`STRING(optional)

Omise.jsからのトークンID（例: tokn_test_...）または顧客からのカードID（例: card_test_...）。customerとsourceが指定されていない場合は必須です。

Example:"tokn_test_5xuy4w91xqz7d1w9u0t"

`source`STRING(optional)

PromptPay、モバイルバンキング、QRコードなどの代替決済方法のソースID。cardとcustomerが指定されていない場合は必須です。

Example:"src_test_5xuy4w91xqz7d1w9u0t"

`customer`STRING(optional)

顧客ID。顧客のデフォルトカードに課金します。cardと組み合わせて特定のカードを指定することもできます。cardとsourceが指定されていない場合は必須です。

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Recommended - 2 fieldsRecommended Parameters

▼

Additional - 1 fieldAdditional Parameters

▼

---

レスポンス

200

成功

chainを含む課金が正常に作成されました。課金が成功した後、宛先受取人への自動振込が作成されます。

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

• destination - 自動振込の受取人ID
• chain - 課金を振込にリンクするchain ID
• platform_fee - プラットフォーム手数料の詳細
• status - 課金ステータス（successful、pending、failedなど）

400

Bad request

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

一般的な原因:

• 必須フィールドの不足（amount、currency、destination）
• 無効な通貨コード
• 支払い方法が指定されていない（card、source、またはcustomer）
• 無効な宛先受取人ID

401

認証されていません

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

一般的な原因:

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

---

コードサンプル

cURL

curl https://api.omise.co/charges \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "amount=100000" \
  -d "currency=thb" \
  -d "card=tokn_test_5xuy4w91xqz7d1w9u0t" \
  -d "destination=recp_test_5xuy4w91xqz7d1w9u0t"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.create({
  amount: 100000,
  currency: 'thb',
  card: 'tokn_test_5xuy4w91xqz7d1w9u0t',
  destination: 'recp_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.create(
    amount=100000,
    currency='thb',
    card='tokn_test_5xuy4w91xqz7d1w9u0t',
    destination='recp_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

const charge = await omise.charges.create({
  amount: 100000,
  currency: 'thb',
  card: 'tokn_test_5xuy4w91xqz7d1w9u0t',
  destination: 'recp_test_5xuy4w91xqz7d1w9u0t'
});

PHP

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

$charge = OmiseCharge::create([
    'amount' => 100000,
    'currency' => 'thb',
    'card' => 'tokn_test_5xuy4w91xqz7d1w9u0t',
    'destination' => 'recp_test_5xuy4w91xqz7d1w9u0t'
]);

Java

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

Charge charge = client.charges().create()
    .amount(100000L)
    .currency("thb")
    .card("tokn_test_5xuy4w91xqz7d1w9u0t")
    .destination("recp_test_5xuy4w91xqz7d1w9u0t")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charge = await client.Charges.Create(new CreateChargeRequest
{
    Amount = 100000,
    Currency = "thb",
    Card = "tokn_test_5xuy4w91xqz7d1w9u0t",
    Destination = "recp_test_5xuy4w91xqz7d1w9u0t"
});

Go

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

charge, _ := client.Charges().Create(&operations.CreateCharge{
    Amount:      100000,
    Currency:    "thb",
    Card:        "tokn_test_5xuy4w91xqz7d1w9u0t",
    Destination: "recp_test_5xuy4w91xqz7d1w9u0t",
})

---

エラーと結果コード

一般的なエラーコード

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

課金ステータスコード

ステータス	説明
successful	支払いが正常に完了しました
pending	顧客のアクション待ち（例: QRコードのスキャン）
failed	支払いに失敗しました（failure_codeを参照）
reversed	課金がキャンセル/取り消されました
expired	支払い前に課金が期限切れになりました

---

試してみる

必須 - 3項目

▼

amount(必須)

currency(必須)

destination(必須)

必須 - 3項目のうち1つ決済方法（1つ必須）

▼

card(任意)

source(任意)

customer(任意)

推奨 - 2項目

▼

追加 - 1項目

▼