バージョン: 最新版

Omise APIリファレンス

Omise RESTful APIで強力な決済統合を構築しましょう。東南アジアと日本で40以上の決済方法をサポートします。

概要

Omise APIは、予測可能なリソース指向URL、JSONエンコードされたリクエストとレスポンス、標準的なHTTPレスポンスコードと動詞を備えたRESTの原則に基づいて構成されています。

ベースURL

サーバー	URL	用途
APIサーバー	`https://api.omise.co`	チャージ、顧客、送金、アカウント操作
Vaultサーバー	`https://vault.omise.co`	トークン作成（安全なカードデータ処理）

現在のAPIバージョン

バージョン: 2019-05-29

Omise-Versionヘッダーを使用してAPIバージョンを指定します（オプション、デフォルトはアカウントのAPIバージョン）:

Omise-Version: 2019-05-29

クイックスタート

1. APIキーを取得する

Omise DashboardでAPIキーを見つけます:

公開鍵 (pkey_*) - クライアントサイド操作用（トークン、ソース）
秘密鍵 (skey_*) - サーバーサイド操作用（チャージ、顧客）

秘密鍵を安全に保管してください

クライアントサイドコード、GitHubリポジトリ、公開の場所で秘密鍵を公開しないでください。環境変数とサーバーサイドコードのみを使用してください。

2. リクエストを認証する

OmiseはHTTP Basic認証を使用します:

ユーザー名: APIキー
パスワード: 空白のまま（空文字列）

# Using secret key
curl https://api.omise.co/charges \
  -u skey_test_YOUR_SECRET_KEY:

# Using public key
curl https://vault.omise.co/tokens \
  -u pkey_test_YOUR_PUBLIC_KEY:

3. 最初のリクエストを作成する

テストチャージを作成します:

curl https://api.omise.co/charges \
  -X POST \
  -u skey_test_YOUR_SECRET_KEY: \
  -d "amount=100000" \
  -d "currency=thb" \
  -d "card=tokn_test_no1t4tnemucod0e51mo"

レスポンス:

{
  "object": "charge",
  "id": "chrg_test_5xuy4w91xqz7d1w9u0t",
  "amount": 100000,
  "currency": "thb",
  "status": "successful",
  "authorized": true,
  "captured": true,
  ...
}

APIリソース

コア決済処理

💳 チャージ

すべてのサポートされている決済方法でチャージを作成、キャプチャ、管理します。

POST /charges • GET /charges/:id • PATCH /charges/:id

🔐 トークン

PCI準拠の負担なしにクレジットカード情報を安全にトークン化します。

POST /tokens • GET /tokens/:id

📱 ソース

PromptPay、モバイルバンキング、QRコードなどの代替決済方法用の決済ソースを作成します。

POST /sources • GET /sources/:id

↩️ 返金

完了したチャージの全額または一部の返金を発行します。

POST /charges/:id/refunds • GET /refunds/:id

顧客管理

👤 顧客

継続課金のために顧客情報と保存された決済方法を保存します。

POST /customers • GET /customers/:id • PATCH /customers/:id

💳 カード

顧客に紐付けられた保存されたクレジット/デビットカードを管理します。

GET /customers/:id/cards • DELETE /customers/:id/cards/:card_id

資金管理

💸 送金

銀行口座への資金送金と自動送金スケジュールを管理します。

POST /transfers • GET /transfers/:id • GET /transfers/schedules

🏦 受取人

送金用の銀行口座受取人を作成および確認します。

POST /recipients • GET /recipients/:id • POST /recipients/:id/verify

💰 残高

すべての通貨での利用可能残高と保留中の残高を確認します。

GET /balance

📊 取引

会計と照合のための詳細な取引履歴を表示します。

GET /transactions • GET /transactions/:id

追加リソース

⚖️ 紛争

チャージバックと紛争を管理します。

📢 イベント

Webhook用のイベントログにアクセスします。

📅 スケジュール

定期的なチャージと送金を設定します。

🔗 決済リンク

共有可能な決済リンクを作成します。

🔍 検索

すべてのリソースを検索します。

⚙️ アカウント

アカウント設定を表示および更新します。

必須ガイド

特定のエンドポイントに入る前に、これらの中核となる概念を理解してください:

🔐 認証

公開鍵と秘密鍵を使用したAPIリクエストの認証方法、APIバージョニングの処理、統合のセキュリティ確保について学びます。

❌ エラー処理

エラーレスポンス形式、一般的なエラーコード、失敗を適切に処理するためのベストプラクティスを理解します。

📄 ページネーション

オフセットとリミットパラメータを使用して、大きな結果セットを効率的にナビゲートします。

🔁 べき等性

べき等性キーを使用して、操作を重複させずにリクエストを安全に再試行します。

🏷️ API バージョニング

APIバージョンの変更を管理し、後方互換性を維持します。

⏱️ レート制限

APIレート制限内に留まり、レート制限エラーを処理します。

一般的なワークフロー

クレジットカード決済を受け付ける

クライアントサイド: カードデータでトークンを作成
```
POST https://vault.omise.co/tokens
```
サーバーサイド: トークンでチャージを作成
```
POST https://api.omise.co/charges
```

完全なガイドを見る →

PromptPay QR決済を受け付ける

サーバーサイド: PromptPayソースを作成
```
POST https://api.omise.co/sources
```
QRコードを表示 顧客に
Webhookを受信 支払い完了時に

完全なガイドを見る →

将来のチャージ用にカードを保存

顧客を作成
```
POST https://api.omise.co/customers
```
顧客にカードトークンを紐付け
```
PATCH https://api.omise.co/customers/:id
```
顧客のデフォルトカードに課金
```
POST https://api.omise.co/charges
```

完全なガイドを見る →

レスポンス形式

すべてのAPIレスポンスは、リソースタイプを示すobjectフィールドを含むJSONエンコードされたオブジェクトです:

{
  "object": "charge",
  "id": "chrg_test_5xuy4w91xqz7d1w9u0t",
  "livemode": false,
  "amount": 100000,
  "currency": "thb",
  ...
}

リストオブジェクト

リストエンドポイントはページネーションされた結果を返します:

{
  "object": "list",
  "data": [
    { "object": "charge", "id": "chrg_..." },
    { "object": "charge", "id": "chrg_..." }
  ],
  "limit": 20,
  "offset": 0,
  "total": 142,
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-02-07T23:59:59Z"
}