注文ステータス
| ステータス | 説明 | 終局 |
|---|---|---|
PAY_IN_PROGRESS | 注文受付済み。ユーザーが決済中 | いいえ |
AUTHORIZATION_REQUIRED | この決済手段ではユーザー認可が必要 | いいえ |
AUTHED_WAITING_CAPTURE | オーソリ済み、キャプチャ待ち (カード決済) | いいえ |
PAY_SUCCESS | 決済成功 | はい |
ORDER_CLOSE | 注文クローズ (キャンセル/失敗/タイムアウト) | はい |
サブスクリプションステータス
| ステータス | 説明 | 終局 |
|---|---|---|
AUTHORIZATION_REQUIRED | ユーザー認可が必要 | いいえ |
IN_PROGRESS | ユーザーがサブスクリプションを確認中 | いいえ |
ACTIVE | サブスクリプション有効。課金は正常に処理されます | いいえ |
CLOSE | クローズ (タイムアウトまたは失敗) | はい |
MERCHANT_CANCELLED | 加盟店によるキャンセル | はい |
USER_CANCELLED | ユーザーによるキャンセル | はい |
CHANNEL_CANCELLED | チャネルによるキャンセル | はい |
EXPIRED | 有効期限切れ | はい |
サブスクリプション変更ステータス
| ステータス | 説明 | 終局 |
|---|---|---|
IN_PROGRESS | 変更処理中 | いいえ |
AUTHORIZATION_REQUIRED | ユーザー認可が必要 | いいえ |
SUCCESS | 変更成功 | はい |
CLOSED | 変更失敗/クローズ | はい |
返金ステータス
| ステータス | 説明 | 終局 |
|---|---|---|
REFUND_IN_PROGRESS | 返金処理中 | いいえ |
ORDER_PARTIALLY_REFUNDED | 部分返金完了 | はい |
ORDER_FULLY_REFUNDED | 全額返金完了 | はい |
ORDER_REFUND_FAILED | 返金失敗 | はい |
決済手段タイプ
| payMethodType | 説明 |
|---|---|
CREDITCARD | クレジットカード |
DEBITCARD | デビットカード |
EWALLET | 電子ウォレット |
ONLINE_BANKING | オンラインバンキング |
DIGITAL_BANKING | デジタルバンキング |
OTC | オフライン決済 (コンビニエンスストアなど) |
BNPL | 後払い (Buy Now Pay Later) |
VA | バーチャルアカウント |
APPLEPAY | Apple Pay |
GOOGLEPAY | Google Pay |
よく使われる決済手段名
| payMethodName | タイプ | 説明 |
|---|---|---|
CC_VISA | CREDITCARD | Visa クレジットカード |
CC_MASTERCARD | CREDITCARD | Mastercard クレジットカード |
DC_VISA | DEBITCARD | Visa デビットカード |
DC_MASTERCARD | DEBITCARD | Mastercard デビットカード |
DANA | EWALLET | DANA 電子ウォレット |
GCASH | EWALLET | GCash 電子ウォレット |
LINKAJA | EWALLET | LinkAja 電子ウォレット |
MERCADOPAGO | EWALLET | Mercadopago |
APPLEPAY | APPLEPAY | Apple Pay |
GOOGLEPAY | GOOGLEPAY | Google Pay |
SPEI | ONLINE_BANKING | SPEI (メキシコ) |
JENIUSPAY | ONLINE_BANKING | JeniusPay (インドネシア) |
AKULAKU | BNPL | Akulaku |
KREDIVO | BNPL | Kredivo |
INDODANA | BNPL | Indodana |
OXXO | OTC | OXXO (メキシコ) |
OXXOPAY | OTC | OXXO Pay (メキシコ) |
ユーザー端末タイプ
| userTerminal | 説明 |
|---|---|
WEB | Web |
APP | モバイルアプリ |
IN_WALLET_APP | ウォレット内アプリ |
IN_MINI_PROGRAM | ミニプログラム |
Webhook イベントタイプ
| eventType | 説明 |
|---|---|
PAYMENT_NOTIFICATION | 決済結果の通知 |
REFUND_NOTIFICATION | 返金結果の通知 |
SUBSCRIPTION_STATUS_NOTIFICATION | サブスクリプションのステータス変更 |
SUBSCRIPTION_PERIOD_CHANGED_NOTIFICATION | サブスクリプション期間の変更 |
SUBSCRIPTION_CHANGE_NOTIFICATION | サブスクリプションのアップグレード/ダウングレード完了 |
返金元
| refundSource | 説明 |
|---|---|
MERCHANT | 加盟店が発行した返金 |
RDR | Rapid Dispute Resolution (RDR) |
ETHOCA | Ethoca ディスピュートリゾリューション |
共通規約
| 項目 | 規格 |
|---|---|
| 時刻フォーマット | ISO 8601、ミリ秒精度 (例: 2023-04-01T03:00:00.000Z) |
| 通貨 | ISO 4217 (例: IDR、PHP、HKD、USD) |
| 国コード | ISO 3166-1 alpha-3 (例: IDN、PHL、HKG) |
| 金額 | 文字列型、小数点以下 2 桁まで (例: "2.27") |
| 言語 | IETF BCP 47 (例: id-ID、zh-Hant-HK) |
| 成功応答コード | "0" ("SUCCESS" ではありません) |
| 応答メッセージフィールド | msg (message ではありません) |