PG Multi-Payment Service

https://docs.gmo-pg.com/mulpay
Admin
PG Multi-Payment Service is a comprehensive payment gateway providing APIs for over 30 payment...
Tokens:368,353
Snippets:2,592
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Import Result File Example

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/credit/card/bulk/bulk-modeb-format

Provides an example of import result files generated after uploading a specific data file.

```text
Ibulk_m_multi_0000000000001_20211105_01.txt.gz
Ibulk_m_multi_0000000000001_20211105_01.txt.gz.ok
```

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

### PayPay Accept Start Request Body Example

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/json/paypay-accept-start

Example of the form data expected for the PayPay Accept Start API request. This includes the AccessID and Token required for transaction processing.

```urlencoded
AccessID=84636abd0bb03500ffce1e1a78deb1b2&Token=107c44550ac7f47cbc6dbef22c4c27fd
```

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

### Screen Image Example

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/wallet/dbarai/continuance/overview

Example of the payment details confirmation screen.

```APIDOC
## Screen Image

This is the payment details confirmation screen.

![d払い payment details confirmation screen screenshot](../assets/img/dbarai-onetime-index-screenshot1.png)

Parameters specified in [Transaction Registration (`EntryTranDocomoContinuance`)](/apis/protocol-type/idpass/entry-tran-docomo-continuance)[api] or [Payment Execution (`ExecTranDocomoContinuance`)](/apis/protocol-type/idpass/exec-tran-docomo-continuance)[api] will be reflected.

| Parameter Name | Content |
|---|---|
| Payment Amount | Amount ( `Amount` ) + Tax ( `Tax` ) will be displayed. |
| Payment Details | The value specified in Store Name ( `DispShopName` ) will be displayed. If not specified, the shop name registered in this service will be displayed. *For directly contracted merchants, the merchant name (site name) submitted to NTT Docomo will be displayed.* *For net-inclusive contract merchants, the store name submitted to NTT Docomo will be displayed.* |
| Merchant Name | The value specified in Company Name ( `DispCompanyName` ) will be displayed. If not specified, the company name registered in this service will be displayed. *For directly contracted merchants, the store name ( `DispShopName` ) will be displayed.* If not specified, company information (company name) submitted to NTT Docomo will be displayed. *For net-inclusive contract merchants, the company name submitted to NTT Docomo will be displayed.* |
| Details | The values specified in Docomo Display Item 1 ( `DocomoDisp1` ) and 2 ( `DocomoDisp2` ) will be displayed. Use this for product details or messages to the customer. |
```

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

### d払い (Continuous Payment) - Getting Started

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/wallet/dbarai/continuance/overview

Steps to start using d払い for continuous payments, including contract confirmation, application, and testing.

```APIDOC
## Getting Started with d払い (Continuous Payment)

1. **Contract Confirmation and Application**
   A contract is required to use d払い (continuous payment). If you have not contracted, please contact your sales representative.

1. **Test Environment Verification**
   Refer to [here](/docs/developer-support/test-environment/overview) for information on the test environment.

1. **Production Launch**
   Start production operation after completing verification.
   Refer to [here](/docs/developer-support/test-environment/production-checklist) for the test environment to production environment transition checklist.
```

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

### SFTP Bulk Upload OK File Example

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/credit/card/bulk/bulk-modeb-format

Provides an example of an OK file used to signal the completion of an upload file transmission via SFTP.

```text
bulk_m_multi_0000000000001_20211105_01.txt.gz
bulk_m_multi_0000000000001_20211105_01.txt.gz.ok
```

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

### Sales Result File Example

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/credit/card/bulk/bulk-modeb-format

Provides an example of sales result files generated after uploading a specific data file.

```text
Rbulk_m_multi_0000000000001_20211105_01.txt.gz
Rbulk_m_multi_0000000000001_20211105_01.txt.gz.ok
```

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

### SB Accept Start Request

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/idpass/sb-accept-start

This snippet details the request parameters required to initiate the SB Accept Start process. It includes AccessID and Token for authentication and transaction identification.

```APIDOC
## POST /idpass/sb-accept-start

### Description
Initiates the SoftBank payment acceptance process by submitting transaction details.

### Method
POST

### Endpoint
/idpass/sb-accept-start

### Parameters
#### Request Body
- **AccessID** (string) - Required - **取引ID**(半角英数32桁)
- **Token** (string) - Required - **トークン**（半角英数記号256桁）

### Request Example
{
  "example": "AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL"
}

### Response
#### Success Response (200)
- Description: 決済事業者へリダイレクト
```

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

### SFTP Import Result File Example

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/credit/card/bulk/bulk-modea-format

Provides an example of an import result file name for SFTP transfers. It shows the 'I' prefix followed by the original data file name.

```text
Ibulk_m_uri_0000000000001_20211105_01.txt.gz
```

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

### Verification Start

Source: https://docs.gmo-pg.com/mulpay/apis/openapi-type/verification-start

Initiates the verification process.

```APIDOC
## POST /verification/start

### Description
Initiates the verification process.

### Method
POST

### Endpoint
/verification/start

### Parameters
#### Header Parameters
- **Idempotency-Key** (string) - Required - Unique key for idempotency, up to 36 characters. See [Idempotency](https://example.com/mulpay/docs/connection-method/openapi-type/request-spec#idempotence) for details.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Rakutenpay Payment Start Request

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/idpass/rakutenpay-start

This snippet shows the structure of the request to start a Rakutenpay payment. It requires an AccessID and a Token.

```APIDOC
## POST /apis/protocol-type/idpass/rakutenpay-start

### Description
Initiates a Rakutenpay payment transaction.

### Method
POST

### Endpoint
/apis/protocol-type/idpass/rakutenpay-start

### Parameters
#### Request Body
- **AccessID** (string) - Required - Transaction ID (32 alphanumeric characters).
- **Token** (string) - Required - Token issued by ExecTranRakutenpay.

### Request Example
{
  "AccessID": "a6a6b0061347e90cdef806b39bd28705",
  "Token": "rT735NHvr5rGDDFsG/iMIoKv5SEiiINgsNuAZ4G2s+ewBS7yYvxSiC0zeMVH+O5A"
}

### Response
#### Success Response (200)
- Redirects to the payment provider.
```

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

### SbContinuanceStart

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/wallet/sb/continuance/api-list

Starts the Softbank continuous payment process and receives registration results.

```APIDOC
## SbContinuanceStart

### Description
Starts the Softbank continuous payment process and receives registration results.

### Method
POST

### Endpoint
/sb-continuance-start

### Request Body
- **order_id** (string) - Required - Order ID
- **service_id** (string) - Required - Service ID
- **service_user_id** (string) - Required - Service user ID
- **user_token** (string) - Required - User token

### Response
#### Success Response (200)
- **status** (string) - Process status
- **redirect_url** (string) - Redirect URL
```

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

### PayPay Start

Source: https://docs.gmo-pg.com/mulpay/llms-apis.txt

Initiates a payment process and receives the payment result.

```APIDOC
## POST /mulpay/apis/protocol-type/json/paypay-start

### Description
Starts the payment process and receives the payment result.

### Method
POST

### Endpoint
/mulpay/apis/protocol-type/json/paypay-start
```

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

### Docomo Start Request

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/idpass/docomo-start

Initiates the Docomo payment process by submitting AccessID and Token.

```APIDOC
## POST /docomo/start

### Description
Initiates the Docomo payment process. This endpoint is typically called after a user has selected Docomo as their payment method and provided necessary authentication details.

### Method
POST

### Endpoint
/docomo/start

### Request Body
- **AccessID** (string) - Required - The transaction ID provided by the payment gateway.
- **Token** (string) - Required - A security token for the transaction.

### Request Example
```json
{
  "AccessID": "a6a6b0061347e90cdef806b39bd28705",
  "Token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL"
}
```

### Response
#### Success Response (200)
- The response indicates a successful redirection to the Docomo payment page. No specific fields are detailed in the source, but it implies a redirect.

#### Response Example
(Redirection to Docomo payment page)
```

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

### PayPay Accept Start

Source: https://docs.gmo-pg.com/mulpay/llms-apis.txt

Initiates a payment process and receives the payment result for acceptance.

```APIDOC
## POST /mulpay/apis/protocol-type/json/paypay-accept-start

### Description
Starts the payment process and receives the payment result for acceptance.

### Method
POST

### Endpoint
/mulpay/apis/protocol-type/json/paypay-accept-start
```

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

### RakutenPay Start

Source: https://docs.gmo-pg.com/mulpay/llms-apis.txt

Initiates the payment procedure interface and receives the payment result.

```APIDOC
## POST /mulpay/apis/protocol-type/json/rakutenpay-start

### Description
Initiates the payment procedure interface and receives the payment result.

### Method
POST

### Endpoint
/mulpay/apis/protocol-type/json/rakutenpay-start
```

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

### Start Account Registration / Receive Payment Result

Source: https://docs.gmo-pg.com/mulpay/llms-apis.txt

Initiates the account registration procedure and receives the payment result.

```APIDOC
## POST /bank-direct-start

### Description
Initiates the account registration procedure and receives the payment result.

### Method
POST

### Endpoint
/bank-direct-start

### Parameters
#### Request Body
- **transaction_id** (string) - Required - The transaction ID for account registration.
- **payment_details** (object) - Required - Details of the payment.
```

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

### Example Import Result and OK Files

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/credit/card/bulk/bulk-modec-format

Illustrates the naming of import result and OK files based on a sample uploaded file.

```text
Ibulk_c_multi_0000000000001_20211105_01.txt.gz
Ibulk_c_multi_0000000000001_20211105_01.txt.gz.ok
```

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

### SFTP Bulk Upload File Placement Example

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/credit/card/bulk/bulk-modeb-format

Illustrates the directory structure for placing bulk upload files and their corresponding OK files on an SFTP server.

```text
ホームディレクトリ
  ├  bulk_m_multi_0000000000001_20211105_01.txt.gz
  └  bulk_m_multi_0000000000001_20211105_01.txt.gz.ok
```

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

### Payment Procedure Start IF (AupayStart)

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/wallet/aupayweb/flow-protocol

Redirects the customer to the au PAY payment screen to start the payment procedure. This is an interface that the merchant system guides the customer to.

```APIDOC
## AupayStart

### Description
Initiates the payment procedure by redirecting the customer to the au PAY payment screen.

### Method
GET

### Endpoint
/apis/protocol-type/idpass/aupay-start

### Query Parameters
- **Example**: (Details not provided in source)
```

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

### Example Sales Result and OK Files

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/credit/card/bulk/bulk-modec-format

Illustrates the naming of sales result and OK files based on a sample uploaded file.

```text
Rbulk_c_multi_0000000000001_20211105_01.txt.gz
Rbulk_c_multi_0000000000001_20211105_01.txt.gz.ok
```

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

### Import Result File Storage Example

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/credit/card/bulk/bulk-modeb-format

Illustrates the storage structure for import result files on an SFTP server, including the data file and its corresponding OK file.

```text
ホームディレクトリ
  ├  Ibulk_m_multi_0000000000001_20211105_01.txt.gz
  └  Ibulk_m_multi_0000000000001_20211105_01.txt.gz.ok
```

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

### 支払手続き開始IFの呼び出し/決済結果受信 (Rakutenpay Start)

Source: https://docs.gmo-pg.com/mulpay/llms-apis.txt

Initiates the payment procedure interface and receives payment results. This is the primary interface for starting payment processes.

```APIDOC
## POST /mulpay/apis/protocol-type/idpass/rakutenpay-start

### Description
Initiates the payment procedure interface and receives payment results.

### Method
POST

### Endpoint
/mulpay/apis/protocol-type/idpass/rakutenpay-start

### Parameters
#### Request Body
- **(Required)** - Description of request body parameters would go here if available in source.
```

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

### 支払手続き開始IF呼び出し/登録結果受信 (SB Continuance Start)

Source: https://docs.gmo-pg.com/mulpay/llms-apis.txt

Initiates the payment procedure interface and receives registration results. This is used for starting recurring payment processes.

```APIDOC
## POST /mulpay/apis/protocol-type/idpass/sb-continuance-start

### Description
Initiates the payment procedure interface and receives registration results.

### Method
POST

### Endpoint
/mulpay/apis/protocol-type/idpass/sb-continuance-start

### Parameters
#### Request Body
- **(Required)** - Description of request body parameters would go here if available in source.
```

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

### Docomo Continuance Start Request Body

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/json/docomo-continuance-start

The request body for starting a Docomo Continuance payment must be URL-encoded and include an AccessID and Token. These parameters are essential for authenticating and identifying the transaction.

```http
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL
```

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

### DocomoStart (JSON)

Source: https://docs.gmo-pg.com/mulpay/docs/payment-method/wallet/dbarai/onetime/api-list

Initiates the payment procedure and receives payment results via callback for d払い using the JSON protocol.

```APIDOC
## DocomoStart (JSON)

### Description
Initiates the payment procedure for d払い and receives payment results via callback, using the JSON protocol.

### Method
POST (Assumed, as it's an initiation and callback process)

### Endpoint
/apis/protocol-type/json/docomo-start

### Parameters
#### Request Body
- **transaction_id** (string) - Required - The unique identifier for the transaction.
- **callback_url** (string) - Required - The URL to receive payment status notifications.

### Request Example
```json
{
  "transaction_id": "order_987654321",
  "callback_url": "https://your-merchant.com/callback"
}
```

### Response
#### Success Response (200)
- **redirect_url** (string) - The URL to redirect the user to complete the payment.

#### Response Example
```json
{
  "redirect_url": "https://d払い.com/payment?id=xyz789"
}
```

### Callback Notification
#### Payment Result Notification
- **transaction_id** (string) - The ID of the transaction.
- **status** (string) - The final status of the payment (e.g., PAID, FAILED).
- **result_code** (string) - A code indicating the result of the payment.

#### Callback Example
```json
{
  "transaction_id": "order_987654321",
  "status": "PAID",
  "result_code": "000"
}
```
```

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

### PayPay Accept Callback Request Body Example

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/json/paypay-accept-start

Example of the form data received by the callback URL after a PayPay acceptance operation. This includes transaction status, dates, and a security check string.

```urlencoded
ShopID=tshop11223344&OrderID=ORDER0000001&Status=REGISTER&TranDate=20220722112429&PaypayAcceptCode=51111118068276&CheckString=1e8b27418fcdc9c0214a035cd81c1749
```

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

### Rakuten Pay Transaction Start

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/json/rakutenpay-start

This section details how to initiate a Rakuten Pay transaction. It involves submitting a form with AccessID and Token to start the payment process. The user is then redirected to Rakuten Pay for payment.

```APIDOC
## POST /rakutenpay/start

### Description
Initiates a Rakuten Pay transaction by submitting payment details.

### Method
POST

### Endpoint
/rakutenpay/start

### Request Body
- **AccessID** (string) - Required - Transaction ID (32 alphanumeric characters).
- **Token** (string) - Required - Token generated by ExecTranRakutenpay (up to 256 alphanumeric characters).

### Request Example
```json
{
  "AccessID": "a6a6b0061347e90cdef806b39bd28705",
  "Token": "rT735NHvr5rGDDFsG/iMIoKv5SEiiINgsNuAZ4G2s+ewBS7yYvxSiC0zeMVH+O5A"
}
```

### Response
#### Success Response (200)
- Description: Redirects the user to the payment provider.

#### Response Example
(Redirection to Rakuten Pay)
```

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

### Initiate PayPay Accept Start

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/json/paypay-accept-start

This JavaScript code snippet is used to submit the PayPay Accept Start form, initiating the payment acceptance process. Ensure this script is called appropriately within your web page's lifecycle.

```javascript
function OnLoadEvent() {
  document.PaypayAcceptStartCall.submit();
  }
  //-->
    </script>
    </body>
  </html>
```

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

### Docomo Payment Execution Response

Source: https://docs.gmo-pg.com/mulpay/apis/protocol-type/idpass/exec-tran-docomo

This section details the response structure for the Docomo payment execution. It includes examples for successful one-time payments, successful recurring payments, and error responses. Note that the 'Example (auto)' format is only available for JSON responses and not for text/plain responses.

```APIDOC
## Docomo Payment Execution Response

### Description
This API endpoint handles the response from the Docomo payment execution. It provides different structures for success (both one-time and recurring payments) and error scenarios.

### Success Response (200)

**For One-Time Payments:**
- **AccessID** (string) - Transaction ID (32 alphanumeric characters).
- **Token** (string) - Token for the transaction (up to 256 alphanumeric and symbol characters). This is a hash of the Transaction ID.
- **StartURL** (string) - URL to start the payment procedure (up to 256 alphanumeric and symbol characters).
- **StartLimitDate** (string) - Payment deadline in `yyyyMMddHHmmss` format (14 digits). The customer must complete the payment operation within this time.

**For Recurring Payments:**
- **OrderID** (string) - Order ID (up to 27 alphanumeric and symbol characters). This ID is used by the merchant to identify the transaction and cannot be reused.
- **Status** (string) - Current transaction status. Possible values are `AUTH` (pre-authorization) and `CAPTURE` (immediate sale).
- **TranDate** (string) - Processing date and time in `yyyyMMddHHmmss` format (14 digits).
- **DocomoSettlementCode** (string) - Docomo settlement code (12 digits).
- **CheckString** (string) - Tamper-check string (32 alphanumeric and symbol characters). This is an MD5 hash of concatenated `OrderID`, `AccessID`, `ShopID`, and `ShopPass`.

### Error Response
- **ErrCode** (string) - Error code (3 alphanumeric characters).
- **ErrInfo** (string) - Error detail code (9 alphanumeric characters).

### Response Examples

**Example (One-Time Payment Success):**
```
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://example.com/start&StartLimitDate=20190225162711
```

**Example (Recurring Payment Success):**
```
OrderID=ORDER0000001&Status=AUTH&TranDate=20220722112429&DocomoSettlementCode=202207221124&CheckString=207c44550ac7f47cbc6dbef22c4c27fd
```

**Example (Error):**
```
ErrCode=E01&ErrInfo=E01040001
```
```
Tokens:
Raw