# KOMOJU Doc (日本語) Documentation > KOMOJUはグローバルなペイメントプロセッサーです。KOMOJU API を使って、あなたのウェブアプリやEコマースサイトでシームレスに支払いを受け付けましょう。 Append .md to any documentation page URL to get its markdown version. ## Guides - [認証](https://ja.doc.komoju.com/docs/authentication.md): KOMOJU APIを使う為の認証 - [冪等リクエスト](https://ja.doc.komoju.com/docs/idempotent-requests.md) - [エラー](https://ja.doc.komoju.com/docs/errors.md): KOMOJU APIで目にするエラー - [Webhooks](https://ja.doc.komoju.com/docs/webhooks.md): KOMOJUから通知を受ける仕組み - [テストカード](https://ja.doc.komoju.com/docs/test-cards.md) - [実装ガイド: ホストフィールドでトークンを利用](https://ja.doc.komoju.com/docs/integration-guide-token.md): ペイメントをサーバーサイドで実行する場合はこちらをご参考ください - [ホストフィールドのカスタマイズ](https://ja.doc.komoju.com/docs/styling-your-fields.md): CSSを利用してホストフィールドをカスタマイズしましょう - [利用可能な支払い方法](https://ja.doc.komoju.com/docs/supported-payment-methods.md): ホストフィールドで利用可能な支払い方法 - [MultiPay (Legacy)](https://ja.doc.komoju.com/docs/multipay-legacy.md) - [Shopify](https://ja.doc.komoju.com/docs/shopify.md): Shopify 連携ガイド - [ShopifyでKOMOJUをはじめる](https://ja.doc.komoju.com/docs/getting-started-with-shopify.md) - [ShopifyにおけるKOMOJU注文・決済の仕組み](https://ja.doc.komoju.com/docs/understanding-komoju-orders-on-shopify.md) - [Shopifyで利用できるKOMOJUの主要機能](https://ja.doc.komoju.com/docs/common-komoju-features-on-shopify.md) - [Woocommerce](https://ja.doc.komoju.com/docs/woocommerce.md) - [WooCommerceをはじめる](https://ja.doc.komoju.com/docs/getting-started-with-woocommerce.md) - [WooCommerceにおけるKOMOJU注文・決済の仕組み](https://ja.doc.komoju.com/docs/understanding-komoju-orders-on-woocommerce.md) - [WooCommerceで利用できる主要機能](https://ja.doc.komoju.com/docs/common-komoju-features-on-woocommerce.md) - [Wix](https://ja.doc.komoju.com/docs/wix.md): Wix連携ガイド - [Wixをはじめる](https://ja.doc.komoju.com/docs/getting-started-with-wix.md) - [WixにおけるKOMOJU注文・決済の仕組み](https://ja.doc.komoju.com/docs/understanding-komoju-orders-on-wix.md) - [[リンク型決済]のご利用方法](https://ja.doc.komoju.com/docs/using-payment-links.md): コードなどの開発は不要な商品販売ツール - [サブスクリプション支払いリンク](https://ja.doc.komoju.com/docs/サブスクリプション支払いリンク.md) - [ダイレクト・インテグレーション](https://ja.doc.komoju.com/docs/direct-integration.md) - [決済の作成](https://ja.doc.komoju.com/docs/creating-payments-directly.md): お客様の決済情報を弊社に直接送信する方法を説明します - [決済の詳細](https://ja.doc.komoju.com/docs/payment-details.md) - [詐欺の詳細](https://ja.doc.komoju.com/docs/fraud-details.md) - [3Dセキュアを使用したテスト決済について](https://ja.doc.komoju.com/docs/3dセキュア3dsによる決済テスト.md) - [概要](https://ja.doc.komoju.com/docs/platform-model-overview.md): プラットフォーム加盟店とマーケットプレイス加盟店の決済い処理要件を満たす - [用語集](https://ja.doc.komoju.com/docs/platform-model-glossary.md): KOMOJU Platform Model で使用される専門用語を収録しています - [ビジネスユースケース](https://ja.doc.komoju.com/docs/platform-model-business-use-case.md): 貴社のビジネスにどのユースケースが当てはまるかを特定する必要があります - [プラットフォーム向け](https://ja.doc.komoju.com/docs/platform-use-case.md): ユースケースはプラットフォーム事業に適用される - [マーケットプレイス向け](https://ja.doc.komoju.com/docs/marketplace-use-case.md): ユースケースはマーケットプレイス事業に適用される - [アカウントのオンボード](https://ja.doc.komoju.com/docs/platform-model-onboard-accounts.md): KOMOJUでの加盟店と販売事業者のオンボーディング概要 - [プラットフォーム加盟店のオンボーディング](https://ja.doc.komoju.com/docs/platform-merchant-platform-business-onboarding.md): 「プラットフォーム加盟店」アカウントを登録する - [プラットフォーム事業者のオンボーディング](https://ja.doc.komoju.com/docs/seller-merchant-onboarding.md): 「プラットフォーム事業者」アカウントを登録する - [マーケットプレイス加盟店のオンボーディング](https://ja.doc.komoju.com/docs/platform-merchant-marketplace-business-onboarding.md): 「マーケットプレイス加盟店」アカウントを登録する - [マーケットプレイス事業者のオンボーディング](https://ja.doc.komoju.com/docs/payout-merchant-onboarding.md): 「マーケットプレイス事業者」アカウントを登録する - [決済処理](https://ja.doc.komoju.com/docs/platform-model-process-payments.md): 貴社と販売事業者間の決済処理方法の概要 - [販売者決済処理モデル (プラットフォーム向け)](https://ja.doc.komoju.com/docs/seller-processing-model.md): 販売者処理モデルで決済を処理する - [プラットフォーム決済処理モデル (マーケットプレイス向け)](https://ja.doc.komoju.com/docs/platform-processing-model.md): プラットフォーム決済処理モデルで決済を処理する - [残高移行](https://ja.doc.komoju.com/docs/platform-model-balance-transfer.md): 加盟店と販売事業者間の残高を転送する - [加盟店と販売事業者への払い出し](https://ja.doc.komoju.com/docs/platform-model-payout-submerchants.md) - [販売事業者の管理](https://ja.doc.komoju.com/docs/platform-model-manage-submerchants.md): 販売事業者を効率的に管理する方法 - [アカウントの管理](https://ja.doc.komoju.com/docs/platform-model-manage-account.md): アカウントを効率的に管理する方法 - [Webhook (プラットフォーム モデル向け)](https://ja.doc.komoju.com/docs/platform-model-webhooks.md): KOMOJU プラットフォーム モデルにおける Webhook の機能 - [Buys の廃止について](https://ja.doc.komoju.com/docs/buys-の廃止について.md) - [React Native](https://ja.doc.komoju.com/docs/react-native.md): KOMOJU React Native SDK は、モバイルアプリケーション内で安全に決済を処理します。 - [Ruby](https://ja.doc.komoju.com/docs/ruby.md) - [Node](https://ja.doc.komoju.com/docs/node.md) - [PHP](https://ja.doc.komoju.com/docs/php.md) - [Apple Pay利用資格基準](https://ja.doc.komoju.com/docs/apple-pay利用資格基準.md) - [Apple Payを使用する(ホストページ・フィールド)](https://ja.doc.komoju.com/docs/apple-payを使用する.md) - [Apple Payを使用する(API)](https://ja.doc.komoju.com/docs/apple-payを使用するapi.md) ## API Reference - [Payment: List](https://ja.doc.komoju.com/reference/listpayments-1.md): Retrieves a paginated list of payments. Pagination can be configured with `page` and `per_page` parameters. Payments can be filtered by `currency`, `external_order_num`, and `status`. A time range can be specified with `start_time`, and `end_time`. - [Payment: Create](https://ja.doc.komoju.com/reference/createpayment-1.md): Creates a payment for a given `amount` and `currency`. There are two ways to create payment: - For one-time payment, you can pass `payment_details` with payment method type and additional attributes. - For recurring payment, you can pass customer's ID via `customer` attribute. Customer's saved payment method will be used for the payment. Note that either `payment_details` or `customer` is required for the payment. However, both of them should not be given at the same time. - [Payment: Show](https://ja.doc.komoju.com/reference/showpayment-1.md): Retrieves a single payment object by its `id`. - [Payment: Update](https://ja.doc.komoju.com/reference/updatepayment-1.md): Updates a payment. Only a payment's `description` and `metadata` can be changed. - [Payment: Capture](https://ja.doc.komoju.com/reference/capturepayment-1.md): Captures a payment. Only works when the payment was created with `capture` set to false, or via a session with `capture` set to `"manual"`. - [Payment: Refund](https://ja.doc.komoju.com/reference/refundpayment-1.md): Refunds an arbitrary amount of money from an existing payment. If no amount is specified, the whole payment is refunded. - [Payment: Cancel](https://ja.doc.komoju.com/reference/cancelpayment-1.md): Cancels a payment. The given payment must have a state of `pending` or `authorized` in order to be canceled. - [Payment: Finalize](https://ja.doc.komoju.com/reference/finalizepayment-1.md): Finalizes a payment. Finalizes an EMV contact transaction by confirming the chip card's final decision (TC for approved, AAC for declined). Use this after authorization to submit the terminal's transaction outcome and determine whether the payment is captured or cancelled. - [Payment: Refund Request](https://ja.doc.komoju.com/reference/createrefundrequest-1.md): A "Refund Request" requests that a payment be refunded manually. This can be used for payment methods that do not support refunds, such as konbini. To support non-refundable payment methods, a bank account must be specified so that we know where to send the funds. Since it is a manual process, the refund will be carried out at a later date, and there's a possibility of it being rejected. - [Payment Method: List](https://ja.doc.komoju.com/reference/listpaymentmethods-1.md): Lists available payment methods. - [Balance: Transfer](https://ja.doc.komoju.com/reference/balancetransfer-1.md): Transfers funds from the currently authenticated merchant's balance to another associated merchant for the given `currency`. - [Balance: Show](https://ja.doc.komoju.com/reference/showmerchantbalance-1.md): Given a currency, view the unsettled balance of the currently authenticated merchant or one of its sub-merchants. - [Balance: Show Settings](https://ja.doc.komoju.com/reference/showmerchantbalancesettings-1.md): Given a currency, view the payout settings of the currently authenticated merchant or one of its sub-merchants. - [Balances: Edit Settings](https://ja.doc.komoju.com/reference/editmerchantbalancesettings-1.md): Given a currency, edit the payout settings of the currently authenticated merchant or one of its sub-merchants. - [Balance: Transfer](https://ja.doc.komoju.com/reference/createmerchantbalancetransfer-1.md): Creates a balance transfer between associated merchants for a given `amount` and `currency`. - [Balance: Transactions](https://ja.doc.komoju.com/reference/merchantbalancetransactions-1.md): Given a currency, view the ledger transactions of the currently authenticated merchant or one of its sub-merchants. Will split ledger transactions into line items when appropriate. - [Balance: Transaction](https://ja.doc.komoju.com/reference/showmerchantbalancetransaction-1.md): Given a currency and a transaction UUID, view the corresponding ledger transaction of the currently authenticated merchant or one of its sub-merchants. Will return one entry per line item of the transaction. - [Settlement: PDF](https://ja.doc.komoju.com/reference/submerchantsettlementpdf-1.md): View a settlement in PDF format given an `id`. - [Settlement: XLS](https://ja.doc.komoju.com/reference/submerchantsettlementxls-1.md): View a settlement in XLS format given an `id`. - [Settlement: CSV](https://ja.doc.komoju.com/reference/submerchantsettlementcsv-1.md): View a settlement in CSV format given an `id`. - [Settlement: Show](https://ja.doc.komoju.com/reference/showsubmerchantsettlement-1.md): View a settlement given an `id`. - [Settlement: List](https://ja.doc.komoju.com/reference/listsubmerchantsettlements-1.md): Lists out past settlements from most-recent to least-recent. - [Payment: List for Merchant](https://ja.doc.komoju.com/reference/listsubmerchantpayments-1.md): Retrieves a paginated list of payments. Pagination can be configured with `page` and `per_page` parameters. Payments can be filtered by `currency`, `external_order_num`, and `status`. A time range can be specified with `start_time`, and `end_time`. - [Merchant: Show](https://ja.doc.komoju.com/reference/showmerchant-1.md): Retrieves the details of a sub-merchant by its `id`, including account settings, payout configuration, and live status. - [Merchant: Update](https://ja.doc.komoju.com/reference/updatemerchant-1.md): Updates a sub-merchant's settings, including payment and payout toggles, email notification preferences, and payment method expiry settings. - [Merchant: Create](https://ja.doc.komoju.com/reference/createmerchant-1.md): Creates a new merchant. - [Merchant: List](https://ja.doc.komoju.com/reference/listmerchants-1.md): Retrieves a paginated list of sub-merchants. Results can be filtered by `live` status, `platform_role`, account `status`, and whether payments or payouts are enabled. - [File: Create](https://ja.doc.komoju.com/reference/createfile-1.md): Creates a new file for the current merchant. - [File: Show](https://ja.doc.komoju.com/reference/showfile-1.md): Retrieves an existing file of the current merchant. - [Live Application: Show](https://ja.doc.komoju.com/reference/showliveapplication-1.md): Shows the live application status of the applicant merchant - [Live Application: Update](https://ja.doc.komoju.com/reference/updateliveapplication-1.md): Updates the live application for the applicant merchant - [Live Application: Show Payment Method](https://ja.doc.komoju.com/reference/showliveapplicationpaymentmethod-1.md): Shows the payment method status of the applicant merchant - [Live Application: Update Payment Method](https://ja.doc.komoju.com/reference/updateliveapplicationpaymentmethod-1.md): Update the payment method application of the applicant merchant - [Live Application: Simulate Payment Method Status](https://ja.doc.komoju.com/reference/simulateliveapplicationpaymentmethodstatus-1.md): Simulate status change on payment method for test merchants - [Live Application: Simulate Status](https://ja.doc.komoju.com/reference/simulateliveapplicationstatus-1.md): Simulate status change on applications for test merchants. In order for status to be changed to "accepted," at least one payment method must be approved. - [Live Application: Payment Methods](https://ja.doc.komoju.com/reference/listliveapplicationpaymentmethods-1.md): List submitted/unsubmitted payment methods - [Balance: Transaction](https://ja.doc.komoju.com/reference/showtransaction-1.md): Retrieves a single ledger transaction by its UUID for the given currency. Will return one entry per line item of the transaction. - [Settlement: Index](https://ja.doc.komoju.com/reference/listsettlements-1.md): Retrieves a paginated list of settlements from most-recent to least-recent. Pagination can be configured with `page` and `per_page` parameters. - [Settlement: Show](https://ja.doc.komoju.com/reference/showsettlement-1.md): Retrieves a single settlement by its `id`, including a breakdown of payments, refunds, fees, corrections, and disbursements. - [Settlement: CSV](https://ja.doc.komoju.com/reference/showsettlementcsv-1.md): Retrieves the settlement in CSV format. - [Settlement: XLS](https://ja.doc.komoju.com/reference/showsettlementxls-1.md): Retrieves the settlement in XLS format. - [Settlement: PDF](https://ja.doc.komoju.com/reference/showsettlementpdf-1.md): Retrieves the settlement in PDF format. - [Balance: Show](https://ja.doc.komoju.com/reference/showbalance.md): Given a currency, view the unsettled balance of the currently authenticated merchant. - [Balance: Transactions](https://ja.doc.komoju.com/reference/balancetransactions.md): Given a currency, view the ledger transactions of the currently authenticated merchant. Will split ledger transactions into line items when appropriate. - [Session: Show](https://ja.doc.komoju.com/reference/showsession-1.md): Retrieves a Session given its ID. A Session's status changes when the user completes or cancels their payment. You can listen for those events via webhooks, or use this API to poll for changes. - [Session: Create](https://ja.doc.komoju.com/reference/createsession-1.md): Creates a session. There're 3 modes for the session: * `payment`: A payment will be created after user completed the session (default). * `customer`: A customer will be created instead of a payment, or updated if `customer_id` is given. This customer resource can then be used to perform delayed billing or subscriptions. * `customer_payment`: A payment will be created, and customer will be created or updated. You can use this mode to charge money upfront and save customer's payment details in one go. - [Session: Cancel](https://ja.doc.komoju.com/reference/cancelsession-1.md): Cancels a session. - [Session: Pay](https://ja.doc.komoju.com/reference/paysession-1.md): Provide customer payment details to pay for a session. - [SecureToken: Create](https://ja.doc.komoju.com/reference/createsecuretoken-1.md): Creates a SecureToken with the given credit card `payment_details` or `customer` ID. There are two ways to create a SecureToken: - Using `payment_details` with credit card information. - Using `customer` ID, which is a unique identifier for a customer created via the [Customer: Create](https://doc.komoju.com/reference/createcustomer) endpoint. Customer's saved payment details will be used as `payment_details`. It is recommended to have a client application make this request directly so that sensitive payment information (e.g. credit card number) doesn't hit your server. Receiving credit card numbers requires your business to be PCI-DSS compliant. Once you create a secure token using a customer's credit card details, you can redirect the customer to the authentication url to perform 3DS authentication. Once a secure token has been authenticated, the secure token id can safely be sent to your server and used as `payment_details` to a future KOMOJU API request. - [External Customer: Destroy](https://ja.doc.komoju.com/reference/showsecuretoken-1.md): Deletes the external customer created by the Hosted Page One-Click feature with the given `id`. This completely erases the stored payment details from our database. - [SecureToken: Show](https://ja.doc.komoju.com/reference/showsecuretoken.md): Retrieves a single SecureToken object by its `id`. - [Token: Create](https://ja.doc.komoju.com/reference/createtoken-1.md): Creates a token with the given `payment_details`. It is recommended to have a client application make this request directly so that sensitive payment information (e.g. credit card number) doesn't hit your server. Receiving credit card numbers requires your business to be PCI-DSS compliant. Once you turn your customer's details into a token, the token string can safely be sent to your server and used as `payment_details` to a future KOMOJU API request. A `currency` may be optionally specified. When `currency` is provided, KOMOJU will ensure that the payment made using the new token is in the same currency. - [Customer: Show](https://ja.doc.komoju.com/reference/showcustomer-1.md): Retrieves customer personal information. - [Customer: Update](https://ja.doc.komoju.com/reference/updatecustomer-1.md): Updates the customer with the given `id`. A new set of `payment_details` may be specified. - [Customer: Destroy](https://ja.doc.komoju.com/reference/deletecustomer-1.md): Deletes the customer with the given `id`. This complete erases the stored payment details from our database. - [Customer: List](https://ja.doc.komoju.com/reference/listcustomers-1.md): Retrieves a paginated list of all previously-registered customers. - [Customer: Create](https://ja.doc.komoju.com/reference/createcustomer-1.md): Creates a new customer with the specified `payment_details`. Customer payment details are stored in a secure, PCI DSS-compliant way. Once you have a customer, you may specify the customer's `id` instead of `payment_details` when creating a payment. - [Subscription: Show](https://ja.doc.komoju.com/reference/showsubscription-1.md): Show an existing subscription, including its customer and scrubbed payment details. - [Subscription: Destroy](https://ja.doc.komoju.com/reference/deletesubscription-1.md): Delete a subscription. Once deleted, the subscription's regular payments will stop. - [Subscription: List](https://ja.doc.komoju.com/reference/listsubscriptions-1.md): List existing subscriptions. - [Subscription: Create](https://ja.doc.komoju.com/reference/createsubscription-1.md): Create a new subscription. A subscription represents a recurring payment. Recurring payments may be on a `weekly`, `monthly`, or `yearly` basis, specified by the period parameter. In order to create a subscription, a customer ID must be supplied. The customer object contains saved payment info, which is regularly charged by the subscription. A subscription can't be modified once it's created. To change a subscription, you must delete it and create a new one. - [Chargeback: List](https://ja.doc.komoju.com/reference/listchargebackrequests.md): Retrieves a paginated list of chargeback requests for the authenticated merchant. Results are ordered with `pending` chargebacks first, followed by non-pending chargebacks. There is no request sort parameter. This endpoint is only available to merchants with the chargeback feature enabled; otherwise it returns `404 Not Found`. - [Chargeback: Show](https://ja.doc.komoju.com/reference/showchargebackrequest.md): Retrieves the details of a single chargeback request, including its timeline, payment, customer, and defense (if one exists). This endpoint is only available to merchants with the chargeback feature enabled; otherwise it returns `404 Not Found`. - [Chargeback: Accept](https://ja.doc.komoju.com/reference/acceptchargebackrequest.md): Accepts a chargeback, agreeing to the dispute. Takes no request body. A chargeback can only be accepted while its status is `pending`. If the due date has passed, the request returns an error. Accepting an already-accepted chargeback returns `204` (idempotent). - [Chargeback: Defend](https://ja.doc.komoju.com/reference/defendchargebackrequest.md): Submits a defense against a chargeback, including supporting documentation. A chargeback can only be defended while its status is `pending`. If the due date has passed, the request returns an error. Defending an already-defended chargeback returns `204` (idempotent). Only one defense can be created per chargeback request. The `document.document_base64` payload must be 15 MB or less. Supported types are PDF, JPG/JPEG, PNG, and GIF; the type is inferred from the file's bytes, not the filename. - [Event: List](https://ja.doc.komoju.com/reference/listevents-1.md): Lists out past webhook events from most-recent to least-recent. - [Event Show](https://ja.doc.komoju.com/reference/showevent-1.md): View an event given an `id`. Event `id`s can be saved from a webhook or found by querying all events. - [Barcode: Show](https://ja.doc.komoju.com/reference/showbarcode-1.md): Fetches the latest barcode for a konbini payment. Barcodes can be displayed in your client application to give your customers a more convenient way to pay. Not all konbini payments are compatible with barcodes. If a payment is compatible, it will have a `barcode_url` field in its `payment_details` object, which is a reference to this endpoint. Newly created payments may not have a barcode available immediately. If the barcode is still being generated, the response will have a `status` of `pending` and a `retry_after` field indicating how many seconds to wait before you may retry the request. The barcodes can only be used for payment for a limited amount of time, by default this is 10 minutes. Subsequent requests to this endpoint will return the same barcode as long as it is still valid. After expiration, a new barcode will be generated and returned.
Fetching barcodes in JavaScript If you're integrating barcodes on your website, the following JavaScript function can be used to fetch barcode data, handling the pending status and retrying. The `barcode_url` parameter is returned from Payments APIs when the payment is compatible with barcodes. ```javascript async function fetchBarcode(barcode_url) { const response = await fetch(barcode_url); if (!response.ok) { throw new Error( `Error fetching barcode: ${response.status} ${response.statusText}` ); } const { status, retry_after, ...barcode } = await response.json(); if (status === 'ready') { return barcode; } else if (status === 'pending') { await new Promise(resolve => setTimeout(resolve, retry_after * 1000)); return fetchBarcode(barcode_url); } else { throw new Error(`Error fetching barcode: unexpected status ${status}`); } } ```
## Recipes - [return_url時セッションの状態チェック](https://ja.doc.komoju.com/recipes/return_url時セッションの状態チェック.md) - [お支払い詳細の例(クレジットカード)](https://ja.doc.komoju.com/recipes/お支払い詳細の例クレジットカード.md) - [お支払い詳細の例(コンビニ)](https://ja.doc.komoju.com/recipes/お支払い詳細の例コンビニ.md) - [お支払い詳細の例(ペイペイ)](https://ja.doc.komoju.com/recipes/お支払い詳細の例ペイペイ.md) - [お支払い詳細の例(銀行振込)](https://ja.doc.komoju.com/recipes/お支払い詳細の例銀行振込.md) - [カスタマーセッションの作成](https://ja.doc.komoju.com/recipes/カスタマーセッションの作成.md) - [クレジットカードの情報をトークン化する](https://ja.doc.komoju.com/recipes/クレジットカードの情報をトークン化する.md) - [セッションを利用した直接支払い](https://ja.doc.komoju.com/recipes/セッションを利用した直接支払い.md) - [ワンクリックで決済セッションを作成](https://ja.doc.komoju.com/recipes/ワンクリックで決済セッションを作成.md) - [決済セッションの作成(最小構成)](https://ja.doc.komoju.com/recipes/決済セッションの作成最小構成.md) ## Pages - [利用可能な決済方法](https://ja.doc.komoju.com/page/supported-payment-methods.md) ## Changelog - [v.2026-01-27](https://ja.doc.komoju.com/changelog/v2026-01-20.md) - [v.2025-01-28](https://ja.doc.komoju.com/changelog/unstable-more-details-in-responses-for-settlements-api-endpoints.md) - [APIバージョン管理の導入](https://ja.doc.komoju.com/changelog/introducing-api-versioning.md)