KOMOJU

https://ja.doc.komoju.com/
Admin
KOMOJU is a payment system offering an API, hosted pages, and hosted fields for developers to...
Tokens:143,665
Snippets:384
Trust Score:8.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example API Response for Live Application

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

This JSON structure represents a typical response from the Komoju Live Application API. It includes merchant status, payment/payout enablement, and a detailed breakdown of 'requested_fields'. Each field object specifies its type, name, and whether it's optional, guiding the platform merchant on what information needs to be provided.

```json
{
    "merchant_id": "5td723eoi9txn8sj545ww2mv1",
    "status": "incomplete",
    "payments_enabled": false,
    "payouts_enabled": false,
    "requested_fields": [
        {
            "field_type": "phone_number",
            "field": "company_information.company_phone",
            "field_name": "Company Phone",
            "field_properties": {
                "minLength": 1,
                "pattern": "^([() \-_+]*[0-9]){10}[() \-_+0-9]*$"
            },
            "optional": false
        }
      	...
    ],
    "newly_requested_fields": [],
    "errored_fields": []
}
```

--------------------------------

### Webhook Setup

Source: https://ja.doc.komoju.com/docs/payout-merchant-onboarding

Set up webhooks to subscribe to events and receive immediate notifications when the review status of marketplace operator applications is updated.

```APIDOC
## POST /api/webhooks

### Description
Configures webhooks to receive real-time notifications for application status updates.

### Method
POST

### Endpoint
/api/webhooks

### Parameters
#### Request Body
- **event_type** (string) - Required - The type of event to subscribe to (e.g., `application_status_updated`).
- **callback_url** (string) - Required - The URL to send the webhook notifications to.

### Request Example
```json
{
  "event_type": "application_status_updated",
  "callback_url": "https://your-domain.com/komoju-webhook-handler"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation of webhook setup.

#### Response Example
```json
{
  "message": "Webhook configured successfully."
}
```

### Further Information
- For details on Platform Model Webhook events, refer to: [/docs/platform-model-webhooks](/docs/platform-model-webhooks)
```

--------------------------------

### Schema String Formats - JSON Example

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Illustrates the use of built-in string formats within a JSON schema, specifically 'date' or 'email'. This example shows how to specify the 'email' format for a schema property.

```json
"format": "email"
```

--------------------------------

### HTTP Request Example: Ping Event

Source: https://ja.doc.komoju.com/docs/webhooks

Example HTTP POST request for a 'ping' event from Komoju. This is used to test webhook connectivity and includes relevant headers and a simple JSON payload.

```http
POST http://example.com/hook HTTP/1.1

Host: example.com
X-Komoju-Id: 1lqjmj6k7li996cdiqxqqzf1k
X-Komoju-Signature: ee52defb62c1d48125741bfe92a13b6cbffc97b0b3a26b5cab582f766a4ae97e
X-Komoju-Event: ping
User-Agent: Komoju-Webhook
Content-Type: application/json
Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
Accept: */*
{
  "id": "do33foclbroj52ib9whb6yh4m",
  "type": "ping",
  "resource": "event",
  "data": {
    "id": "bll40gxhuhcw19vor5kx55akw",
    "resource": "webhook",
    "url": "http://example.com/hook",
    "active": true,
    "event_list": [
      "ping",
      "payment.captured"
    ],
    "created_at": "2018-11-13T06:19:49Z"
  },
  "created_at": "2018-11-13T06:19:49Z"
}
```

--------------------------------

### HTTP Request Example: Payment Authorized

Source: https://ja.doc.komoju.com/docs/webhooks

Example HTTP POST request for a 'payment.authorized' event from Komoju. This includes headers like X-Komoju-Id and X-Komoju-Signature, and a JSON payload detailing the authorized payment.

```http
POST http://example.com/hook HTTP/1.1

Host: example.com
X-Komoju-Id: 6cul2yma626autvvxz2xre1qr
X-Komoju-Signature: 75e653443e6543ee4c4b0665c73a4818216c9464f4a3ac959bff5ebafc105693
X-Komoju-Event: payment.authorized
User-Agent: Komoju-Webhook
Content-Type: application/json
Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
Accept: */*
{
  "id": "dv7ywuavew3n2meqsllj5bbob",
  "type": "payment.authorized",
  "resource": "event",
  "data": {
    "id": "8xz5cn01gkt37cz0myd98k2f1",
    "resource": "payment",
    "status": "authorized",
    "amount": 1000,
    "tax": 80,
    "customer": null,
    "payment_deadline": "2018-11-20T14:59:59Z",
    "payment_details": {
      "type": "bank_transfer",
      "email": "test@example.com",
      "order_id": "Y5236584956",
      "bank_name": "三井住友銀行",
      "account_branch_name": "ひなぎく",
      "account_number": "6",
      "account_type": "普通預金",
      "account_name": "株式会社DEGICA（カブシキガイシャ デジカ）",
      "instructions_url": "https://komoju.com/ja/instructions/8xz5cn01gkt37cz0myd98k2f1"
    },
    "payment_method_fee": 0,
    "total": 1080,
    "currency": "JPY",
    "description": null,
    "captured_at": null,
    "external_order_num": "123",
    "metadata": {
    },
    "created_at": "2018-11-13T06:19:49Z",
    "amount_refunded": 0,
    "locale": "ja",
    "refunds": [

    ],
    "refund_requests": [

    ]
  },
  "created_at": "2018-11-13T06:19:49Z"
}
```

--------------------------------

### Ping Webhook

Source: https://ja.doc.komoju.com/docs/webhooks

This example demonstrates the structure of a ping webhook event, used to test webhook connectivity.

```APIDOC
## POST /hook (ping)

### Description
This endpoint receives a ping event from Komoju, used to verify that the webhook endpoint is reachable and functioning correctly.

### Method
POST

### Endpoint
/hook

### Headers
- **X-Komoju-Id** (string) - Komoju's identifier for the webhook.
- **X-Komoju-Signature** (string) - HMAC signature of the request body.
- **X-Komoju-Event** (string) - The type of event, 'ping' in this case.
- **User-Agent** (string) - User agent of the sender (Komoju-Webhook).
- **Content-Type** (string) - Specifies the media type of the resource, typically 'application/json'.

### Request Body
- **id** (string) - Unique identifier for the event.
- **type** (string) - Type of the event ('ping').
- **resource** (string) - Type of resource ('event').
- **data** (object) - Contains data related to the ping event.
  - **id** (string) - Unique identifier for the webhook registration.
  - **resource** (string) - Type of resource ('webhook').
  - **url** (string) - The URL of the webhook endpoint.
  - **active** (boolean) - Indicates if the webhook is active.
  - **event_list** (array) - List of events the webhook is subscribed to.
  - **created_at** (string) - Timestamp when the webhook was created.
- **created_at** (string) - Timestamp when the event was created.

### Request Example
```json
{
  "id": "do33foclbroj52ib9whb6yh4m",
  "type": "ping",
  "resource": "event",
  "data": {
    "id": "bll40gxhuhcw19vor5kx55akw",
    "resource": "webhook",
    "url": "http://example.com/hook",
    "active": true,
    "event_list": [
      "ping",
      "payment.captured"
    ],
    "created_at": "2018-11-13T06:19:49Z"
  },
  "created_at": "2018-11-13T06:19:49Z"
}
```

### Response
#### Success Response (200)
- Acknowledges receipt of the ping event.

#### Response Example
(No specific example provided, typically an empty 200 OK response)
```

--------------------------------

### Live Application Update API

Source: https://ja.doc.komoju.com/docs/payout-merchant-onboarding

Updates the live application with merchant information based on required fields. This API guides the onboarding flow step-by-step.

```APIDOC
## PATCH /api/v1/live_application/{id}

### Description
Updates the live application with merchant information. This endpoint is used to submit required fields gathered during the onboarding process. The response includes `newly_required_fields` which are fields that become necessary based on the submitted data.

### Method
PATCH

### Endpoint
`/api/v1/live_application/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the live application.

#### Query Parameters
None

#### Request Body
- **field_name.subfield** (string) - Required/Optional - The value for a specific field. The field names are nested, e.g., `company_information.company_name`.

### Request Example (Updating Company Name)
```bash
curl -X PATCH https://komoju.com/api/v1/live_application/{id} \
  -u platform_merchant_secret_key: \
  -d "company_information.company_name=My Company"
```

### Request Example (Updating Corporation Type)
```bash
curl -X PATCH https://komoju.com/api/v1/live_application/{id} \
  -u platform_merchant_secret_key: \
  -d "company_information.corporation_type=sole_proprietor"
```

### Response
#### Success Response (200)
- **required_fields** (array) - An array of fields that are still required to complete the application.
- **newly_required_fields** (array) - An array of fields that have become newly required based on the submitted data. Each object contains `field`, `field_name`, `field_type`, and `field_properties`.
- **errored_fields** (array) - An array of fields that have errors.

#### Response Example (with `newly_required_fields` for sole proprietor)
```json
{
  "newly_required_fields": [
      {
          "field": "company_information.sole_proprietor_proofs",
          "field_name": "Sole proprietor proofs",
          "field_type": "file_upload",
          "field_properties": {}
      }
  ]
}
```
```

--------------------------------

### Schema External Links - JSON Example

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Shows how to include a list of URLs for external links within a JSON schema, often used to link to related hosted service agreements.

```json
"external_links": ["https://example.com"]
```

--------------------------------

### Get Required Fields for Live Application

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Retrieves the mandatory fields required for a platform merchant's live application. This is essential for completing the merchant onboarding process.

```APIDOC
## GET /api/v1/live_application/{id}

### Description
This endpoint allows you to query the required fields for a platform merchant's live application. You use the platform merchant's `uuid` obtained from a previous step to make this request.

### Method
GET

### Endpoint
`/api/v1/live_application/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier (UUID) of the platform merchant's live application.

#### Query Parameters
- **locale** (string) - Optional - Specifies the language for the response. Defaults to 'en'.

### Request Example
```curl
curl -X GET https://komoju.com/api/v1/live_application/{id}?locale=en \
-u platform_merchant_secret_key:
```

### Response
#### Success Response (200)
- **merchant_id** (string) - The merchant's ID.
- **status** (string) - The current status of the live application (e.g., 'incomplete').
- **payments_enabled** (boolean) - Indicates if payments are enabled for the merchant.
- **payouts_enabled** (boolean) - Indicates if payouts are enabled for the merchant.
- **requested_fields** (array) - An array of objects, where each object represents a field required from the platform merchant.
  - **field_type** (string) - The type of the field (e.g., 'phone_number', 'checkbox'). See 'Field Types' section for a full list.
  - **field** (string) - The property name to use when submitting information for this field.
  - **field_name** (string) - The localized name of the field to be displayed to the user.
  - **field_properties** (object) - Contains information about the constraints and properties of the field. See 'Field Properties' section for details.
  - **optional** (boolean) - Indicates whether the field is mandatory (`false`) or optional (`true`).
- **newly_requested_fields** (array) - Fields that have been newly requested.
- **errored_fields** (array) - Fields that have errors.

#### Response Example
```json
{
    "merchant_id": "5td723eoi9txn8sj545ww2mv1",
    "status": "incomplete",
    "payments_enabled": false,
    "payouts_enabled": false,
    "requested_fields": [
        {
            "field_type": "phone_number",
            "field": "company_information.company_phone",
            "field_name": "Company Phone",
            "field_properties": {
                "minLength": 1,
                "pattern": "^([() \-_+]*[0-9]){10}[() \-_+0-9]*$"
            },
            "optional": false
        }
    ],
    "newly_requested_fields": [],
    "errored_fields": []
}
```

### Field Types
Describes the different `field_types` and the corresponding form components they represent.

| Type                 | Description                                                                                                                               |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| string               | Text string input.                                                                                                                        |
| dropdown             | Dropdown selection. `field_properties['enum']` contains translation ↔ value pairs.                                                                 |
| radio                | Radio button selection. `field_properties['enum']` contains translation ↔ value pairs.                                                               |
| checkbox             | True/false checkbox field.                                                                                                                |
| url                  | URL input.                                                                                                                                |
| text                 | Text box for longer values (e.g., descriptions).                                                                                            |
| email                | Email address input.                                                                                                                      |
| date                 | Date picker, formatted as 'YYYY-MM-DD'.                                                                                                   |
| integer              | Non-negative integer input.                                                                                                               |
| file_upload          | Allows uploading multiple files. Files must be uploaded via the merchant file upload endpoint. The field value will be a list of uploaded file IDs. |
| single_file_upload   | Allows uploading a single file. Files must be uploaded via the merchant file upload endpoint. The field value will be the uploaded file ID.          |
| service_agreement    | Represents a service agreement, displayed as a checkbox. Includes an `external_links` property for the actual agreement URL.                        |
| multi_select         | Allows selecting multiple options. `field_properties['items']['enum']` contains translation ↔ value pairs.                                               |

### Field Properties
Details the properties available within the `field_properties` object for various field types.

| Property    | Type                                                               | Example                                                                                                                                             |
| ----------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| enum        | Dictionary mapping user-facing options to their corresponding values. Options are localized based on `locale`. | `"enum": { "Sole Proprietor": "sole_proprietor", "Corporation": "corporation" }`                                                                           |
| minLength   | Minimum length for string or text fields.                          | `"minLength": 1`                                                                                                                                   |
| minimum     | Minimum value for integer fields.                                  | `"minimum": 0`                                                                                                                                     |
| maximum     | Maximum value for integer fields.                                  | `"maximum": 2147483647`                                                                                                                            |
| format      | Specifies the expected format for certain field types (e.g., 'email'). | `"format": "email"`                                                                                                                              |
| pattern     | Regular expression pattern that the field value must match.        | `"pattern": "^([() \-_+]*[0-9]){10}[() \-_+0-9]*$"`                                                                                               |
| items       | For `multi_select` field types, defines the available options.     | `"items": { "enum": { "Option 1": "value1", "Option 2": "value2" } }`                                                                            |
| external_links | For `service_agreement` field types, provides URLs to terms and conditions. | `"external_links": [{"label": "Terms of Service", "url": "https://example.com/terms"}]`                                                         |
```

--------------------------------

### Live Application: Show

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Requests the details of a live application, which includes URLs for service agreements and privacy policies.

```APIDOC
## GET /api/v1/live_application/{id}

### Description
Requests the details of a live application. This endpoint is used to retrieve information such as service agreement URLs and privacy policy URLs, which are necessary for merchant onboarding.

### Method
GET

### Endpoint
`/api/v1/live_application/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the live application.

### Response
#### Success Response (200)
- **service_agreement.agreed_to_tos** (object) - Contains URLs for KOMOJU Merchant Service Terms and Privacy Policy.

#### Response Example
(Example response structure for service agreement details would be provided here if available in the source text)
```

--------------------------------

### Retrieve Session by ID (PHP)

Source: https://ja.doc.komoju.com/reference/sessions

A PHP example using GuzzleHttp to fetch session details from the Komoju API. It sends a GET request and returns the parsed JSON response.

```php
<?php

require 'vendor/autoload.php'; // If using Composer

use GuzzleHttp\Client;

function getSession($id)
{
    $client = new Client();
    $response = $client->request('GET', "https://komoju.com/api/v1/sessions/{$id}", [
        'headers' => [
            'accept' => 'application/json',
        ],
    ]);

    return json_decode($response->getBody(), true);
}

// Example usage:
// $session = getSession('your_session_id');
// print_r($session);
?>
```

--------------------------------

### Retrieve Session by ID (Node.js)

Source: https://ja.doc.komoju.com/reference/sessions

Example of fetching session details using Node.js with the 'axios' library. It sends a GET request to the Komoju API and handles the JSON response.

```javascript
const axios = require('axios');

const getSession = async (id) => {
  try {
    const response = await axios.get(`https://komoju.com/api/v1/sessions/${id}`, {
      headers: {
        'accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching session:', error);
    throw error;
  }
};

// Example usage:
// getSession('your_session_id').then(session => console.log(session));
```

--------------------------------

### File: Create

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Uploads files for platform merchant onboarding. Supported formats are jpg, png, and pdf, with a maximum size of 10 MB per file.

```APIDOC
## POST /api/v1/merchants/{id}/files

### Description
Uploads files for platform merchant onboarding. Supported formats are jpg, png, and pdf, with a maximum size of 10 MB per file.

### Method
POST

### Endpoint
`/api/v1/merchants/{id}/files`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the merchant.

#### Form Data
- **paper** (file) - Required - The file to upload.

### Request Example
```curl
curl -X POST https://komoju.com/api/v1/merchants/{id}/files \
  -u platform_merchant_secret_key: \
  -F "paper=/path/to/file"
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the uploaded file.
- **resource** (string) - The type of resource, which is 'file'.
- **filename** (string) - The name of the uploaded file.
- **size** (integer) - The size of the file in bytes.
- **mime_type** (string) - The MIME type of the file.
- **created_at** (string) - The timestamp when the file was created.
- **updated_at** (string) - The timestamp when the file was last updated.

#### Response Example
```json
{
    "id": "6ssx1zxovw3fgmdsdd1zuzr5u",
    "resource": "file",
    "filename": "blank.png",
    "size": 998,
    "mime_type": "image/png",
    "created_at": "2023-01-10T12:16:00.819+09:00",
    "updated_at": "2023-01-10T12:16:01.085+09:00"
}
```
```

--------------------------------

### List Events using PHP

Source: https://ja.doc.komoju.com/reference/events

This PHP example demonstrates fetching webhook events via an HTTP GET request to the Komoju API. It utilizes cURL to handle the request and processes the JSON response.

```PHP
<?php

$url = 'https://komoju.com/api/v1/events';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('accept: application/json'));

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    $data = json_decode($response, true);
    print_r($data);
}

curl_close($ch);
?>
```

--------------------------------

### Live Application: Update

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Submits information to the platform merchant based on the received `requested_fields`. This API is used to complete the onboarding process by providing necessary details.

```APIDOC
## PATCH /api/v1/live_application/{id}

### Description
Submits information to the platform merchant based on the received `requested_fields`. This API is used to complete the onboarding process by providing necessary details. It can also be used to submit agreements to terms and conditions.

### Method
PATCH

### Endpoint
`/api/v1/live_application/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the live application.

#### Request Body
- **field_name** (string or array) - Required - The name of the field to update. Can be a single value or an array for multi-select or file upload fields.

### Request Example (Single Value)
```bash
curl -X PATCH https://komoju.com/api/v1/live_application/{id} \
  -u platform_merchant_secret_key: \
  -d "company_information.company_name=My Company"
```

### Request Example (Array Value)
```curl
curl -X PATCH https://komoju.com/api/v1/live_application/{id} \
  -u platform_merchant_secret_key: \
  -d '{ 
    "visa_mastercard_credit_card.countermeasures_during_card_registration": 
      [ "access_restrictions_during_card_registration"]
  }'
```

### Response
#### Success Response (200)
- **newly_requested_fields** (array) - An array of fields that are newly required based on the last update to the live application.

#### Response Example
```json
"newly_required_fields": [
      {
          "field": "company_information.sole_proprietor_proofs",
          "field_name": "Sole proprietor proofs",
          "field_type": "file_upload",
          "field_properties": {}
      }
  ]
```
```

--------------------------------

### List Events using Node.js

Source: https://ja.doc.komoju.com/reference/events

This Node.js example shows how to fetch a list of webhook events from the Komoju API. It uses the 'node-fetch' library to make the HTTP GET request and handles the JSON response.

```JavaScript
import fetch from 'node-fetch';

const url = 'https://komoju.com/api/v1/events';

fetch(url, {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
```

--------------------------------

### Live Application: Simulate Status API

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Simulate the business application status to be either 'accepted' or 'declined'. This is useful for testing the flow in your environment.

```APIDOC
## POST /reference/simulateliveapplicationstatus

### Description
Simulates the status of a business application to be either 'accepted' or 'declined'.

### Method
POST

### Endpoint
/reference/simulateliveapplicationstatus

### Parameters
#### Query Parameters
- **status** (string) - Required - The simulated status, either 'accepted' or 'declined'.

### Request Example
```json
{
  "status": "accepted"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the simulation was successful.

#### Response Example
```json
{
  "message": "Business application status simulated successfully."
}
```
```

--------------------------------

### Submit KOMOJU Fields via JavaScript `submit()`

Source: https://ja.doc.komoju.com/docs/integration-guide-token

This example shows how to trigger the submission of KOMOJU fields using JavaScript. The `submit()` function is called on the `komoju-fields` element, which returns a promise resolving with the token object. This token's ID is then sent to your backend for processing, offering more control over the submission flow.

```html
<script type="module" src="https://multipay.komoju.com/fields.js"></script>

<komoju-fields
  id="fields"
  session-id={your_session_id}
  publishable-key={your_publishable_key}
></komoju-fields>

<button type="button" onclick="submit()">Pay</button>

<script>
  async function submit() {
    const fields = document.getElementById('fields');
    const token = await fields.submit();

    await sendTokenToBackendForProcessing(token.id);
  }
</script>
```

--------------------------------

### Merchant: Create Platform Provider Account

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Create a platform provider account by making a Merchant: Create request and setting the `platform_role` to `seller`.

```APIDOC
## POST /api/v1/merchants

### Description
Creates a platform provider account for a new seller merchant.

### Method
POST

### Endpoint
https://komoju.com/api/v1/merchants

### Parameters
#### Request Body
- **name** (string) - Required - The name of the platform provider merchant.
- **platform_role** (dropdown) - Required - The role of the sub-merchant account. Set this to `"seller"` for platform providers.

### Request Example
```curl
curl -X POST https://komoju.com/api/v1/merchants \
-u <platform merchant secret key>: \
-d name='New Seller Merchant 1' \
-d platform_role="seller"
```

### Response
#### Success Response (200)
- **merchant_id** (string) - The unique identifier for the created merchant.
- **name** (string) - The name of the merchant.
- **platform_role** (string) - The role assigned to the merchant account.
```

--------------------------------

### Session: Create API

Source: https://ja.doc.komoju.com/docs/seller-processing-model

Creates a session for the Hosted Page solution, which handles PCI compliance and 3D Secure by default.

```APIDOC
## POST /reference/createsession

### Description
Creates a session to initiate the KOMOJU Hosted Page solution. This solution provides PCI compliance and handles 3D Secure automatically. Customers are redirected to a KOMOJU hosted page to complete the payment.

### Method
POST

### Endpoint
/reference/createsession

### Parameters
#### Request Body
- **processing_merchant_id** (string) - Required - The ID of the platform operator processing the payment.
- **submerchant_id** (string) - Required - The ID of the submerchant.
- **platform_fee** (integer) - Required - The platform fee amount to be paid by the platform operator.
- **amount** (integer) - Required - The amount to be credited to the platform operator.
- **capture_mode** (string) - Optional - The capture mode for the payment. Can be "auto" (capture immediately) or "manual" (capture later).

### Request Example
```json
{
  "platform_details": {
    "processing_merchant": "submerchant_one",
    "submerchants": [
      {
        "submerchant_id": "submerchant_one",
        "platform_fee": "100",
        "amount": "700"
      }
    ]
  },
  "capture_mode": "auto"
}
```

### Response
#### Success Response (200)
- **session_id** (string) - The unique identifier for the created session.
- **hosted_page_url** (string) - The URL of the KOMOJU hosted page where the customer will complete the payment.

#### Response Example
```json
{
  "session_id": "sess_abcdef12345",
  "hosted_page_url": "https://komoju.com/hosted-page/sess_abcdef12345"
}
```
```

--------------------------------

### JavaScript Integration for MultiPay Payment Widget

Source: https://ja.doc.komoju.com/docs/multipay-legacy

This JavaScript example shows how to integrate the KOMOJU MultiPay widget dynamically. It involves configuring the payment handler with a publishable key and a token callback function. An event listener on a custom button triggers the payment modal, allowing users to complete the payment. The generated token is then submitted via a hidden input field in a form.

```javascript
var payForm = document.getElementById("pay-form")

var handler = Komoju.multipay.configure({
  key: "your_publishable_key",
  token: function(token) {
    payForm.komojuToken.value = token.id;
    payForm.submit();
  }
});

document.getElementById("customButton").addEventListener("click", function(e) {
  handler.open({
    amount:       1000,
    endpoint:     "https://komoju.com",
    locale:       "en",
    currency:     "JPY",
    title:        "Product Name",
    description:  "Product Description",
    methods: [
      "credit_card","konbini","bank_transfer","pay_easy","web_money","bit_cash","net_cash","japan_mobile","paypay","linepay","merpay","rakutenpay","nanaco","dospara","steam_prepaid_card"
    ],
    hideCreditCardBrands: ['visa', 'master']
  });

  e.preventDefault();
});
```

--------------------------------

### Live Application: Update Payment Method

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Apply for specific payment methods by requesting this API. Details for applying to each payment method are provided.

```APIDOC
## Live Application: Update Payment Method

### Description

Apply for specific payment methods. Details for applying to each payment method are provided within the API documentation for this endpoint.

### Method

PUT (or POST, depending on implementation)

### Endpoint

`/api/v1/live_application/{id}/payment_methods/{payment_method_id}`

### Request Body

(Details on the request body specific to each payment method would be listed here, including required fields for application.)

### Response

#### Success Response (200)

(Details on the success response, typically indicating the application status or confirmation.)

#### Error Response

(Details on possible error responses, e.g., invalid payment method ID, missing required fields.)

```

--------------------------------

### Submit KOMOJU Fields via Form Submission

Source: https://ja.doc.komoju.com/docs/integration-guide-token

This example demonstrates how to integrate KOMOJU fields within an HTML form for standard submission. The `komoju-fields` component acts like an input field, generating a token whose ID is passed in the form's `action` attribute. This token is then used on the backend to create a payment, ensuring sensitive information is handled server-side.

```html
<script type="module" src="https://multipay.komoju.com/fields.js"></script>

<form method="POST" action="/pay">
  <komoju-fields
    session-id={your_session_id}
    publishable-key={your_publishable_key}
    name="komoju_token"
  ></komoju-fields>
  
  <button type="submit">Pay</button>
</form>
```

--------------------------------

### Initialize KOMOJU Fields in HTML

Source: https://ja.doc.komoju.com/docs/fields-overview

This snippet shows the basic HTML structure for integrating KOMOJU Fields. It includes the necessary script tag and the `<komoju-fields>` custom element with session ID and publishable key. It also demonstrates an optional payment method picker using `<komoju-picker>`.

```html
<script type="module" src="https://multipay.komoju.com/fields.js"></script>

<form>
  <!-- optional payment method picker -->
  <komoju-picker></komoju-picker>

  <komoju-fields
  	session-id={your_session_id}
    publishable-key={your_publishable_key}
  ></komoju-fields>

  <button type="submit">Pay</button>
</form>
```

--------------------------------

### Install KOMOJU React Native SDK

Source: https://ja.doc.komoju.com/docs/react-native

Installs the KOMOJU React Native package into your React Native application using either Yarn or npm.

```bash
yarn add @komoju/komoju-react-native  
or  
npm install @komoju/komoju-react-native  
```

--------------------------------

### Live Application: Payment Methods

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

List the payment methods that a platform merchant can apply for. This API returns a list of submitted and unsubmitted payment methods.

```APIDOC
## Live Application: Payment Methods

### Description

List available payment methods that a platform merchant can apply for. This API returns lists of `submitted_payment_methods` and `unsubmitted_payment_methods`.

### Method

GET

### Endpoint

`/api/v1/live_application/{id}/payment_methods`

### Request Example

```bash
curl -X GET https://komoju.com/api/v1/live_application/{id}/payment_methods \
  -u platform_merchant_secret_key: \
```

### Response

#### Success Response (200)

- **submitted_payment_methods** (array) - A list of payment methods the platform merchant has applied for.
- **unsubmitted_payment_methods** (array) - A list of available payment methods the platform merchant has not yet applied for.

```

--------------------------------

### Komoju API: 決済方法一覧取得 (Bash)

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Komoju APIを使用して、プラットフォーム事業者が申請可能な決済手段と、まだ申請していない決済手段を一覧表示するBashコマンドです。このリクエストは、`platform_merchant_secret_key` を使用して認証を行います。返却される`submitted_payment_methods` と `unsubmitted_payment_methods` のリストを確認できます。

```bash
curl -X GET https://komoju.com/api/v1/live_application/{id}/payment_methods \
  -u platform_merchant_secret_key: \

```

--------------------------------

### Schema String Pattern - JSON Example

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Demonstrates the use of a 'pattern' property in a JSON schema to define a regular expression for validating string values. This example provides a specific pattern for a string.

```json
"pattern": "^([() \-_+]_[0-9]){10}\[() \-_+0-9]_$"
```

--------------------------------

### Handling Convenience Store Payments

Source: https://ja.doc.komoju.com/docs/creating-payments-directly

Specific instructions for handling responses related to convenience store payments, including necessary URLs and receipt codes.

```APIDOC
## Convenience Store Payment Handling

### Description
When dealing with convenience store payments, the response may include additional fields to facilitate the payment process for the customer.

### Fields
- **instructions_url** (string) - A URL providing detailed instructions for payment at a convenience store. This URL should be communicated to the customer.
- **receipt** (string) - A payment code usable at convenience stores. 
  - For Seven-Eleven, this code is invalid. Customers must use the `instructions_url` to get payment information.
  - For other convenience stores, this code can be provided to the customer along with the `confirmation_code`.
- **confirmation_code** (string) - Applicable for convenience stores other than Seven-Eleven. Used in conjunction with the `receipt` for customer payments.

### Recommendation
It is recommended to provide the customer with either the `receipt` and `confirmation_code` or solely the `instructions_url` for a seamless payment experience. For Seven-Eleven, only the `instructions_url` should be provided.
```

--------------------------------

### List Events using Python

Source: https://ja.doc.komoju.com/reference/events

This Python snippet shows how to get a list of webhook events using the 'requests' library. It makes an HTTP GET request to the Komoju API and prints the JSON response.

```Python
import requests

url = 'https://komoju.com/api/v1/events'
headers = {'accept': 'application/json'}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f'Error: {response.status_code}')
```

--------------------------------

### Live Application: Simulate Payment Method Status API

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Simulate the application status of a selected payment method to be either 'accepted' or 'declined'.

```APIDOC
## POST /reference/simulateliveapplicationpaymentmethodstatus

### Description
Simulates the application status for a selected payment method, setting it to either 'accepted' or 'declined'.

### Method
POST

### Endpoint
/reference/simulateliveapplicationpaymentmethodstatus

### Parameters
#### Query Parameters
- **payment_method** (string) - Required - The payment method to simulate the status for.
- **status** (string) - Required - The simulated status, either 'accepted' or 'declined'.

### Request Example
```json
{
  "payment_method": "credit_card",
  "status": "accepted"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the simulation was successful.

#### Response Example
```json
{
  "message": "Payment method application status simulated successfully."
}
```
```

--------------------------------

### Live Application: Show

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Retrieve all submitted information for a live application, including the `submitted_fields` array which contains already submitted data.

```APIDOC
## Live Application: Show

### Description

Retrieve all submitted information for a live application.

### Method

GET

### Endpoint

`/api/v1/live_application/{id}`

### Response

#### Success Response (200)

- **submitted_fields** (array) - An array containing all the information already submitted for the application.
```

--------------------------------

### KOMOJU API JSON Error Object Example

Source: https://ja.doc.komoju.com/docs/errors

This is an example of a JSON error object returned by the KOMOJU API. It includes a detailed message, an error code for programmatic identification, and the specific parameter that caused the error, if applicable. This structure helps in understanding and handling API errors effectively.

```json
"error": {
  "message": "A required parameter (amount) is missing",
  "code": "missing_parameter",
  "param": "amount"
}
```

--------------------------------

### cURL GET Request for Barcode

Source: https://ja.doc.komoju.com/reference/barcodes

This snippet demonstrates how to make a GET request to the Komoju Barcode API using cURL. It targets a specific payment ID to retrieve its barcode information, assuming the payment is compatible with barcodes. The request includes an `accept` header for JSON responses.

```bash
curl --request GET \
     --url https://komoju.com/api/v1/barcodes/payment_id \
     --header 'accept: application/json'
```

--------------------------------

### Payment Authorized Webhook

Source: https://ja.doc.komoju.com/docs/webhooks

This example demonstrates the structure of a payment.authorized webhook event received from Komoju.

```APIDOC
## POST /hook (payment.authorized)

### Description
This endpoint receives webhook notifications for payment authorization events from Komoju.

### Method
POST

### Endpoint
/hook

### Headers
- **X-Komoju-Id** (string) - Komoju's identifier for the webhook.
- **X-Komoju-Signature** (string) - HMAC signature of the request body.
- **X-Komoju-Event** (string) - The type of event, 'payment.authorized' in this case.
- **User-Agent** (string) - User agent of the sender (Komoju-Webhook).
- **Content-Type** (string) - Specifies the media type of the resource, typically 'application/json'.

### Request Body
- **id** (string) - Unique identifier for the event.
- **type** (string) - Type of the event ('payment.authorized').
- **resource** (string) - Type of resource ('event').
- **data** (object) - Contains the details of the payment event.
  - **id** (string) - Unique identifier for the payment.
  - **resource** (string) - Type of resource ('payment').
  - **status** (string) - Current status of the payment ('authorized').
  - **amount** (integer) - The amount of the payment.
  - **tax** (integer) - The tax amount.
  - **customer** (object | null) - Customer details, or null if not provided.
  - **payment_deadline** (string) - The deadline for payment.
  - **payment_details** (object) - Details about the payment method.
    - **type** (string) - Type of payment method (e.g., 'bank_transfer').
    - **email** (string) - Customer's email address.
    - **order_id** (string) - The order ID.
    - **bank_name** (string) - Name of the bank.
    - **account_branch_name** (string) - Bank account branch name.
    - **account_number** (string) - Bank account number.
    - **account_type** (string) - Type of bank account.
    - **account_name** (string) - Name of the account holder.
    - **instructions_url** (string) - URL for payment instructions.
  - **payment_method_fee** (integer) - Fee for the payment method.
  - **total** (integer) - Total amount including tax and fees.
  - **currency** (string) - Currency of the payment (e.g., 'JPY').
  - **description** (string | null) - Description of the payment.
  - **captured_at** (string | null) - Timestamp when the payment was captured.
  - **external_order_num** (string) - External order number.
  - **metadata** (object) - Custom metadata.
  - **created_at** (string) - Timestamp when the payment was created.
  - **amount_refunded** (integer) - Amount that has been refunded.
  - **locale** (string) - Locale of the payment (e.g., 'ja').
  - **refunds** (array) - List of refunds.
  - **refund_requests** (array) - List of refund requests.
- **created_at** (string) - Timestamp when the event was created.

### Request Example
```json
{
  "id": "dv7ywuavew3n2meqsllj5bbob",
  "type": "payment.authorized",
  "resource": "event",
  "data": {
    "id": "8xz5cn01gkt37cz0myd98k2f1",
    "resource": "payment",
    "status": "authorized",
    "amount": 1000,
    "tax": 80,
    "customer": null,
    "payment_deadline": "2018-11-20T14:59:59Z",
    "payment_details": {
      "type": "bank_transfer",
      "email": "test@example.com",
      "order_id": "Y5236584956",
      "bank_name": "三井住友銀行",
      "account_branch_name": "ひなぎく",
      "account_number": "6",
      "account_type": "普通預金",
      "account_name": "株式会社DEGICA（カブシキガイシャ デジカ）",
      "instructions_url": "https://komoju.com/ja/instructions/8xz5cn01gkt37cz0myd98k2f1"
    },
    "payment_method_fee": 0,
    "total": 1080,
    "currency": "JPY",
    "description": null,
    "captured_at": null,
    "external_order_num": "123",
    "metadata": {
    },
    "created_at": "2018-11-13T06:19:49Z",
    "amount_refunded": 0,
    "locale": "ja",
    "refunds": [

    ],
    "refund_requests": [

    ]
  },
  "created_at": "2018-11-13T06:19:49Z"
}
```

### Response
#### Success Response (200)
- Acknowledges receipt of the webhook.

#### Response Example
(No specific example provided, typically an empty 200 OK response)
```

--------------------------------

### Webhook Configuration

Source: https://ja.doc.komoju.com/docs/seller-merchant-onboarding

Configure webhooks to subscribe to events and receive notifications when the review status of a platform merchant's application is updated.

```APIDOC
## Webhook Configuration

### Description

Set up webhooks to subscribe to events and receive notifications regarding updates to platform merchant application review status.

Refer to [Platform Model Webhooks](/docs/platform-model-webhooks) for details on webhook events for the platform model.

```
Tokens:
Raw