VeriTrans4G

https://www.veritrans.co.jp/docs/
Admin
VeriTrans4G is a payment gateway service provided by DG Financial Technology for e-commerce sites,...
Tokens:161,700
Snippets:298
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Check LINE App and Launch Payment (Android)

Source: https://www.veritrans.co.jp/docs/id_pay/linepay

This Android code snippet checks if the LINE app is installed and if the installed version supports LINE Pay. If supported, it launches the payment URL; otherwise, it prompts the user to install the LINE app. Dependencies include Android SDK for PackageManager and UI elements.

```java
int linePaySupportedVersion = 230;
String paymentUrl = "..."; // ここに redirectAppURL を設定してください。
Context context = getActivity();
try {
	PackageManager pm = context.getPackageManager();
	PackageInfo packageInfo = pm.getPackageManager().getPackageInfo("jp.naver.line.android", 0);
	int versionCode = packageInfo.versionCode;
	if (linePaySupportedVersion <= versionCode) {
		launchUri(paymentUrl);
	} else {
		confirmLineInstall(context);
	}
} catch (NameNotFoundException e) {
	confirmLineInstall(context);
}

private void confirmLineInstall(Context context) {
	new AlertDialog.Builder(context)
	.setTitle("LINE Pay")
	.setMessage(getString(R.String.linepay_confirm))
	.setCancelable(false)
	.setPositiveButton(getString(R.String.linepay_install), new
 	DialogInterface.OnClickListener() {
		@Override
		public void onClick(DialogInterface dialog, int which) {
			launchUri("market://details?id=jp.naver.line.android");
		}
	})
	.setNegativeButton(getString(R.String.linepay_cancel), new
 	DialogInterface.OnClickListener() {
		@Override
		public void onClick(DialogInterface dialog, int which) {
		}
	})
	.show();
}

private void launchUri(String uriString) {

```

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

### MDK Processing - Account Registration Sequence

Source: https://www.veritrans.co.jp/docs/bankpay

Provides a step-by-step guide for the account registration process, including user interaction and server communication.

```APIDOC
#### Account Registration Processing
1.  **Bank Selection Screen Display:** The merchant creates a screen for the user to select their bank for account registration.
2.  **Account Input Information Acquisition Request:** Information required to obtain account input is formatted and sent to the payment server.
3.  **Result Response:** Based on the response from the payment server, confirm the necessary items for the account input screen and create it.
4.  **Account Information Input Screen Display:** Display the screen for entering account registration details.
5.  **Redirect Parameter Request:** After the user enters account information, retrieve the necessary information for the account registration process. This is typically done via asynchronous communication (e.g., Ajax). Ensure parameters like account number are not sent to the merchant's site. The parameters obtained here have an expiration period; perform this step after account information input to prevent expiration.
6.  **Account Registration Request:** Format and send the information required for account registration to the payment server.
7.  **Result Response:** Receive necessary information for account registration, excluding account details.
8.  **Redirect Parameter Response:** Proceed to the next step using the redirect parameters received from the merchant server and the account information entered on the screen.
9.  **Account Registration Processing Result Notification:** Request the payment server to start the account registration processing. Refer to "6.1.3 BankPay Transition Process" for details.
10. **Account Registration Processing Result Notification:** Receive the account registration result and reflect it in the merchant system. It's crucial to receive this notification as the completion screen request might fail due to network issues or user actions (e.g., closing the browser). The order of arrival of the result notification and the completion screen request redirect is not guaranteed; ensure your system can handle either arriving first.
11. **Completion Screen Request:** Display the BankPay account registration result, provided by the payment server, on the merchant's screen or equivalent to inform the customer of the outcome.
```

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

### Check LINE App and Launch Payment (iOS)

Source: https://www.veritrans.co.jp/docs/id_pay/linepay

This Objective-C code snippet checks if the LINE app is installed on the device. If installed, it displays a confirmation alert before launching the payment URL; otherwise, it prompts the user to install the LINE app from the App Store. Dependencies include UIKit for alerts and URL handling.

```objective-c
NSString* lineScheme = @"line://";
BOOL installed = [[UIApplication sharedApplication]
				canOpenURL:[NSURL URLWithString:lineScheme]];
if (installed) {
	UIAlertView *alert = 
	[[UIAlertView alloc] initWithTitle:@"LINE Pay"
	message:NSLocalizedString(@"linepay.confirm", nil)
				delegate:self cancelButtonTitle:NSLocalizedString(@"linepay.ok", 
				nil) otherButtonTitles:nil];
	alert.tag = 1;
	[alert show];
} else {
	UIAlertView *alert = 
	[[UIAlertView alloc] initWithTitle:@"LINE Pay"
	message:NSLocalizedString(@"linepay.confirm", nil)
				delegate:self
				cancelButtonTitle:NSLocalizedString(@"linepay.cancel", nil)
				otherButtonTitles:NSLocalizedString(@"linepay.install", nil),
				nil];
	alert.tag = 2;
	[alert show];
}

- (void)alertView:(UIAlertView*)alertView clickedButtonAtIndex:(NSInteger)buttonIndex {
	if (alertView.tag == 1 && buttonIndex == 0) {
		NSString *paymentUrl = ...; // ここに redirectAppURL を設定してください。
		[self launchUrl:paymentUrl];
	} else if (alertView.tag == 2 && buttonIndex == 1) {
		[self launchUrl:@"itms-
		apps://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=443904275&mt=8"];
	}
}

```

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

### Redirect Query Parameters (GET)

Source: https://www.veritrans.co.jp/docs/id_pay/rakutenpay

This section details the query parameters that are sent via redirect (GET) from the payment server to the merchant's system through the consumer's browser.

```APIDOC
## GET /websites/veritrans_co_jp/redirect

### Description
This endpoint receives query parameters via a GET request when redirecting from the consumer browser to the merchant's completion screen after a transaction.

### Method
GET

### Endpoint
/websites/veritrans_co_jp/redirect

### Parameters
#### Query Parameters
- **mstatus** (string) - Required - Processing result code. Can be 'success', 'failure', or 'pending'. Max 32 characters.
- **vResultCode** (string) - Required - Detailed result code. 4-digit alphanumeric. Refer to 'Result Code List' for details.
- **orderId** (string) - Required - Transaction ID. Alphanumeric, max 100 characters. Assigned by the merchant.
- **command** (string) - Required - Command string. Indicates the payment application result. Expected value: 'Authorize'.
- **rakutenOrderId** (string) - Optional - Rakuten Transaction ID. String, 14 digits. Issued by Rakuten Pay (Online Payment) V2.
- **gatewayOrderId** (string) - Optional - Payment Transaction ID. String, 20 digits. Issued by the payment server for each transaction.
- **rakutenConsentOrderId** (string) - Optional - Rakuten Consent Transaction ID. String, 15 digits. Issued by the payment center upon consent for deferred payment.
- **customerId** (string) - Optional - Customer ID. String, 14 digits. Unique ID assigned by Rakuten Pay.
- **usedPoint** (string) - Optional - Points used. Numeric, max 7 digits.
- **cardBrand** (string) - Optional - Credit card brand. String, max 16 characters.
- **cardLast4** (string) - Optional - Last 4 digits of the credit card number. Numeric, 4 digits.
- **cardInstallments** (string) - Optional - Installment count. Numeric, max 2 digits.
- **cardCvc** (string) - Optional - Indicates if CVC authentication was used. 'true' or 'false'.
- **card3ds** (string) - Optional - Indicates if 3D Secure authentication was used. 'true' or 'false'.
- **transactionDatetime** (string) - Optional - Transaction completion datetime. String, 14 digits in YYYYMMDDhhmmss format.
- **cancelExpirationTime** (string) - Optional - Cancellation acceptance deadline. String, 14 digits in YYYYMMDDhhmmss format.
- **captureExpirationTime** (string) - Optional - Sales capture deadline. String, 14 digits in YYYYMMDDhhmmss format.
- **updateExpirationTime** (string) - Optional - Amount change acceptance deadline. String, 14 digits in YYYYMMDDhhmmss format. Applies to amount changes, partial captures, and partial cancellations.
- **extendAuthExpirationTime** (string) - Optional - Authorization extension acceptance deadline. String, 14 digits in YYYYMMDDhhmmss format.
- **vAuthInfo** (string) - Required - Tamper check hash value. SHA-256 hash of concatenated Merchant CCID, parameter values (in order specified by authParams), and password. UTF-8 encoding used for binary conversion.
- **authParams** (string) - Required - Hash calculation parameter order. Base64 encoded comma-separated string indicating the order of parameters used for vAuthInfo calculation. Decode to restore the original string (e.g., 'orderId,vResultCode,mstatus').

### Request Example
```
GET /websites/veritrans_co_jp/redirect?mstatus=success&vResultCode=0000&orderId=MERCHANT123&command=Authorize&rakutenOrderId=R12345678901234&vAuthInfo=a1b2c3d4e5f6...&authParams=b64encodedstring
```

### Response
#### Success Response (200)
- **(No specific response body defined for redirect success, typically handled by merchant's completion page)**

#### Response Example
(N/A)

### Tamper Check Explanation
The `vAuthInfo` and `authParams` are used to verify that the query parameters received by the merchant's system have not been tampered with during the redirect from the payment server. If the hash value calculated by the merchant's system matches the `vAuthInfo` obtained from the query parameters, the parameters are considered untampered. While not mandatory, implementing this check is highly recommended to prevent the reception of fraudulent redirect messages.
```

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

### サービスタイプ "account"（会員情報）のコマンド詳細

Source: https://www.veritrans.co.jp/docs/subscription/interface_detail

サービスタイプ 'account' における、各会員管理コマンド（Add, Update, Delete, Restore, Get, Link, Copy）の具体的な処理内容について説明します。

```APIDOC
## サービスタイプ "account"（会員情報）のコマンド詳細

### Description
サービスタイプ"account"（会員情報）では、各コマンドによって以下の処理を行うことができます。

### Command Details
#### Add
- 会員IDを登録します。
- 会員IDの登録と同時に、カード情報を紐付けることが可能です。
- カード情報を指定した場合、カードの有効性確認が行われます。
- カード情報と併せて継続課金情報を設定することが可能です。
**Notes:**
- このコマンドでは3Dセキュアを実行できないため、カード情報の登録については「2-2 3Dセキュアを伴わない会員・カード登録」に記載の方法をお勧めします。
- 継続課金情報を設定する場合は、課金グループIDが登録されている必要があります。

#### Update
- 会員IDの「入会年月日」を更新します。

#### Delete
- 会員IDを削除します。（論理削除）
- 「退会年月日」を指定した場合は、指定した日に削除されます。
- 論理削除状態では、"Restore"コマンドによって復元が可能です。
- 論理削除状態の会員IDは、再度"Add"コマンドで登録できません。

#### Restore
- 当該会員IDの復元を行います。「入会年月日」を設定できます。

**Important:**
- 退会した会員IDに「別の消費者」を紐付けた場合、既に紐付けられているカード情報が利用できてしまいますので、会員IDを別の消費者のために再利用することは、絶対に行わないでください。

#### Get
- 使用できません。

#### Link
- 事前の取引（元取引IDで指定）で利用したカード情報を、会員IDと紐付けることが可能です。
- 新規の会員IDにカード情報を紐付けることも、既存の会員IDにカード情報を追加することも可能です。
- 紐付けられたカード情報は、デフォルトでは標準カードとして登録されます。
- 紐付けの際に、カードの有効性確認は行いません。
- 元取引IDに指定できる取引は、カード決済の与信まで実行された取引です。（3Dセキュア認証後の与信まで進んでいない取引は指定不可）
**Notes:**
- 既に会員IDと紐付けられているカードの場合、デフォルトではエラーとなりますが、「カード情報追加フラグ」により挙動の変更が可能です。

#### Copy
- 新しい会員IDに、複製元の会員ID（元会員ID）のカード情報を紐付けることができます。
- 既存の会員IDに、元会員IDのカード情報を追加する形で紐付けることも可能です。
- コピー先のカードには、新規にカードIDが採番されます。
- 応答電文には、会員IDに紐付けられた全てのカード情報を返戻します。複製されたカードの場合、新規カードIDと元カードIDが返戻されます。
- 元会員IDの標準カードのみを紐付けるか、全てのカードを紐付けるかを選択できます。
- 元会員IDの標準カードが紐付けられたときは、そのカードが複製先の会員の標準カードになります。
- 元会員IDを退会することが可能です。退会と同時に紐付いているカード情報を削除することも可能です。
**Notes:**
- 元会員IDにカード情報が存在しない場合や、複製先の会員IDに紐付けられているカード情報しか存在しない場合はエラーとなります。
- 複製先の会員IDに既に存在するカードについては複製処理が行われません。
```

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

### GET /websites/veritrans_co_jp - Redirect Parameters

Source: https://www.veritrans.co.jp/docs/id_pay/paypay

This endpoint details the query parameters returned to the merchant's completion screen via a GET request from the payment server. These parameters provide information about the transaction status and allow for security verification.

```APIDOC
## GET /websites/veritrans_co_jp

### Description
This endpoint documents the query parameters used when redirecting from the consumer browser to the merchant's completion screen. These parameters are passed via a GET request from the payment server.

### Method
GET

### Endpoint
/websites/veritrans_co_jp

### Query Parameters
- **mstatus** (string) - Required - Processing result code. "success" for normal completion, "failure" for abnormal completion. Max 32 alphanumeric characters.
- **vResultCode** (string) - Required - Detailed result code. A 4-digit alphanumeric code. Refer to 'Result Code List' for details.
- **orderId** (string) - Required - Transaction ID assigned by the merchant during the payment request. Max 100 alphanumeric characters.
- **command** (string) - Required - Transaction type (command). E.g., "Authorize", "Terminate".
- **paypayOrderId** (string) - Optional - Transaction ID with the payment center. Max 14 alphanumeric characters and symbols. Currently only digits, but may include "*", "-", "_", "@", ".", and space.
- **vAuthInfo** (string) - Required - Hash value for tampering check. Calculated using SHA-256 on concatenated Merchant CCID, parameter values (in order specified by authParams), and password. UTF-8 encoding is used for binary conversion.
- **authParams** (string) - Required - Parameter order used for hash calculation. Base64 encoded string indicating the order of parameters concatenated for vAuthInfo calculation. Example: "orderId,vResultCode,mstatus".
- **centerOrderId** (string) - Optional - Management number from the payment center. Max 64 alphanumeric characters and symbols. Provided only if extendParameterType is "1" or "Enable" is set in the management screen.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
(Response is typically reflected in the redirect URL's query parameters)

#### Response Example
(Example query parameters in redirect URL)
`?mstatus=success&vResultCode=0000&orderId=YOUR_ORDER_ID&command=Authorize&vAuthInfo=a1b2c3d4e5f6...&authParams=b64encoded_params`

### Security
**Tampering Check using vAuthInfo and authParams**
To verify that the query parameters received by the merchant's system are not tampered with during the redirect, the merchant system should calculate a hash value using the received parameters (in the order specified by `authParams`) and compare it with the `vAuthInfo` parameter. If the calculated hash matches `vAuthInfo`, the parameters are considered authentic. This implementation is strongly recommended to prevent receiving fraudulent redirect messages.
```

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

### MDK Token API - Get Token

Source: https://www.veritrans.co.jp/docs/credit/token_guide

This section details the request and response formats for obtaining an MDK token. The token is used to process payments without directly handling sensitive cardholder data.

```APIDOC
## POST /4gtoken

### Description
This endpoint is used to obtain a payment token by sending card information to the MDK Token server. The token can then be used for subsequent payment processing.

### Method
POST

### Endpoint
`https://api3.veritrans.co.jp/4gtoken`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **card_number** (string) - Required - The card number, up to 19 digits.
- **card_expire** (string) - Required - The card expiration date in MM/YY format (e.g., "01/20").
- **security_code** (string) - Optional - The security code (3 or 4 digits).
- **cardholder_name** (string) - Optional - The cardholder's name (2-45 characters). Required when using 3-D Secure 2.0.
- **token_api_key** (string) - Required - The token API key issued for the merchant.
- **lang** (string) - Optional - Specifies the language for the response message ('en' for English, 'ja' for Japanese). Defaults to Accept-Language header.

### Request Example
```json
{
    "card_number":"4111111111111111",
    "card_expire":"01/20",
    "security_code":"123",
    "cardholder_name":"TARO YAMADA",
    "token_api_key":"test-token-api-key",
    "lang":"en"
}
```

### Response
#### Success Response (200)
- **token** (string) - The payment token (36 characters, alphanumeric and symbols). This is a one-time use token.
- **token_expire_date** (string) - The expiration date and time of the token in YYYYMMDDhhmmss format. Valid for 15 minutes after issuance.
- **req_card_number** (string) - The masked card number from the request (first 6 and last 2 digits shown).
- **status** (string) - The processing status. "success" or "failure".
- **code** (string) - A detailed result code.
- **message** (string) - A message describing the processing result.

#### Response Example
```json
{
    "token":"a1b2c3d4e5f678901234567890abcdef36",
    "token_expire_date":"20231027103000",
    "req_card_number":"411111********11",
    "status":"success",
    "code":"xxxxxx",
    "message":"Success"
}
```

### Error Handling
- **400 Bad Request**
  - **code**: `missing_security_code` - Returned if the "security code required check" is enabled and the security code is not provided.
```

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

### JavaScript Sample for VeriTrans Token Acquisition

Source: https://www.veritrans.co.jp/docs/credit/token_guide

This JavaScript function demonstrates how to acquire a token from the VeriTrans token server. It collects card details from form inputs and sends a POST request. Note: This is an example and may require customization and thorough testing.

```javascript
function submitToken(e) {
    var data = {};
    data.token_api_key = document.getElementById('token_api_key').innerText;
    if (document.getElementById('cc-number')) {
        data.card_number = document.getElementById('cc-number').value;
    }
    if (document.getElementById('cc-exp')) {
        data.card_expire = document.getElementById('cc-exp').value;
    }
    if (document.getElementById('cc-csc')) {
        data.security_code = document.getElementById('cc-csc').value;
    }
    if (document.getElementById('cc-name')) {
        data.cardholder_name = document.getElementById('cc-name').value;
    }
    data.lang = "ja";
   
    var url = document.getElementById('token_api_url').innerText;
   
    var xhr = new XMLHttpRequest();
    xhr.open('POST', url, true);
    xhr.setRequestHeader('Accept', 'application/json');
    xhr.setRequestHeader('Content-Type', 'application/json; charset=utf-8');
    xhr.addEventListener('loadend', function () {
        if (xhr.status === 0) {
            alert("トークンサーバーとの接続に失敗しました");
            return;
        }
        var response = JSON.parse(xhr.response);
        if (xhr.status == 200) {
            document.getElementById('cc-number').value = "";
            document.getElementById('cc-exp').value = "";
            document.getElementById('cc-csc').value = "";
            document.getElementById('cc-name').value = "";
            document.getElementById('token').value = response.token;
            document.forms[0].submit();
        }
        else {
            alert(response.message);
        }
    });
    xhr.send(JSON.stringify(data));
}
```

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

### Interface Details - Basic Items

Source: https://www.veritrans.co.jp/docs/credit/secure_3d

Provides details on essential interface items, including the meaning of 'Setting' fields (Required, Optional, etc.) and guidelines for `orderId` and response fields.

```APIDOC
## Interface Details - Basic Items

This section explains fundamental interface elements and conventions used in the API.

### 'Setting' Field Conventions:

*   **Request Body**: 
    *   `○`: Required
    *   `△`: Optional
    *   `×`: Not configurable
    *   `※`, `※n`: Conditional (conditions specified in description or notes)
*   **Response Body**: 
    *   `○`: Always returned
    *   `△`: Returned only upon successful processing
    *   `×`: Not returned
    *   `※`: Conditional

### `orderId` (Transaction ID):

*   Must be assigned arbitrarily by the merchant for each application process.
*   Must not duplicate existing transaction IDs within the merchant's system or with other payment services.
*   Transaction IDs used in test environments cannot be reused in the production environment.
*   Alphanumeric characters, hyphens (`-`), and underscores (`_`) are permitted.

### Response Body Fields:

*   The response body may contain fields not explicitly detailed in this document. Merchants generally do not need to consider fields not mentioned here.
```

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

### 結果通知

Source: https://www.veritrans.co.jp/docs/credit/secure_3d

決済サーバーは、本人認証、およびクレジットカード決済の結果を加盟店サイトへ通知します。

```APIDOC
## 結果通知 (POST /result/notify)

### Description
決済サーバーは、本人認証、およびクレジットカード決済の結果を加盟店サイトへ通知します。決済成否に関わらず通知されます。

### Method
POST

### Endpoint
`/result/notify`

### Parameters
#### Request Body
- **numberOfNotify** (string) - Required - 通知件数 (4桁以内、半角数字)
- **pushTime** (string) - Required - 送信時刻 (14桁、YYYYMMDDhhmmss形式、半角数字)
- **pushId** (string) - Required - 識別ID (8桁、半角数字)
- **orderId** (string) - Required - 取引ID (100桁以内、半角英数字)
- **vResultCode** (string) - Required - 詳細結果コード (16桁、半角英数字)
- **txnType** (string) - Required - トランザクションタイプ (32桁以内、半角英数字)
- **mpiMstatus** (string) - Required - MPI結果コード (8桁以内、半角英数字)
- **cardMstatus** (string) - Required - カード結果コード (8桁以内、半角英数字)
- **dummy** (string) - Required - ダミー決済フラグ (1桁、半角数字)

### Request Example
```json
{
  "numberOfNotify": "1",
  "pushTime": "20231027103500",
  "pushId": "push_1234",
  "orderId": "test12345",
  "vResultCode": "G021000000000000",
  "txnType": "AuthorizeConfirm",
  "mpiMstatus": "success",
  "cardMstatus": "success",
  "dummy": "0"
}
```

### Response
#### Success Response (200)
(通常、結果通知に対する応答は不要ですが、必要に応じて設定可能です。)

#### Response Example
```json
{
  "message": "Notification received successfully"
}
```
```

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

### HTML Landing Page for App Launch

Source: https://www.veritrans.co.jp/docs/id_pay/merpay

This HTML snippet demonstrates how to create a landing page that initiates the launch of a merchant's application using a custom URL scheme. This is useful when the payment success or cancel URLs do not start with 'http(s)'. The page redirects the user's browser to the specified deep link.

```html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>アプリ起動</TITLE>
</HEAD>
<SCRIPT language="javascript" type="text/javascript">
    window.location.href = "merpaysample://www.example.com/result";
</SCRIPT>
<BODY>
○○アプリを起動します。
</BODY>
</HTML>
```

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

### POST /api/accounts/prepare

Source: https://www.veritrans.co.jp/docs/bankpay

Retrieves account input information required for adding a bank account. This endpoint prepares the system for account addition by validating provided details.

```APIDOC
## POST /api/accounts/prepare

### Description
Retrieves account input information required for adding a bank account.

### Method
POST

### Endpoint
/api/accounts/prepare

### Parameters
#### Request Body
- **memberId** (string) - Required - The member ID specified during member registration.
- **accountId** (string) - Required - The account ID uniquely identifying the account for the member ID. Hyphens and underscores are allowed.
- **bankCode** (string) - Required - The bank code of the registered account.
- **successUrl** (string) - Optional - The URL to redirect to after successful account registration. If not specified, the value from MAP will be used.
- **errorUrl** (string) - Optional - The URL to redirect to in case of an account registration error. If not specified, the value from MAP will be used.
- **pushUrl** (string) - Optional - The push URL to be used. If not specified, the value from MAP will be used.

### Request Example
```json
{
  "memberId": "MEMBER123",
  "accountId": "ACC456",
  "bankCode": "0001",
  "successUrl": "https://example.com/success",
  "errorUrl": "https://example.com/error"
}
```

### Response
#### Success Response (200)
- **serviceType** (string) - The payment service type.
- **mstatus** (string) - The processing result code ('success' or 'failure').
- **vResultCode** (string) - The detailed result code.
- **merrMsg** (string) - The error message if the operation failed.
- **txnVersion** (string) - The MDK version.
- **processId** (string) - The transaction number assigned by the payment server.
- **memberId** (string) - The member ID that was requested.
- **accountId** (string) - The account ID that was requested.
- **branchCodeFlag** (string) - Indicates if branch code input is required ('true' or 'false').
- **depositTypeFlag** (string) - Indicates if deposit type input is required ('true' or 'false').
- **accountNumFlag** (string) - Indicates if account number input is required ('true' or 'false').
- **accountNameFlag** (string) - Indicates if account name input is required ('true' or 'false').
- **centerTransactionId** (string) - The transaction number assigned by the payment center.
- **centerProcessingDatetime** (string) - The date and time of processing by the payment center (YYYYMMDDhhmmss format).

#### Response Example
```json
{
  "serviceType": "BANKPAY",
  "mstatus": "success",
  "vResultCode": "00000000",
  "merrMsg": "",
  "txnVersion": "1.0",
  "processId": "PROC1234567890",
  "memberId": "MEMBER123",
  "accountId": "ACC456",
  "branchCodeFlag": "false",
  "depositTypeFlag": "true",
  "accountNumFlag": "true",
  "accountNameFlag": "true",
  "centerTransactionId": "CENTER12345",
  "centerProcessingDatetime": "20231027103000"
}
```
```

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

### Interface Details - Common Parameters

Source: https://www.veritrans.co.jp/docs/id_pay/rakutenpay

Explains common MDK interface items for Rakuten Pay (Online Payment) V2, including parameter settings for request and response messages, and rules for order IDs.

```APIDOC
## Interface Details - Common Parameters

### Description
This section details the MDK interface items used in the Rakuten Pay (Online Payment) V2 service. It covers the meaning of setting fields for request and response messages, and provides important information regarding `orderId` (transaction ID) and response message fields.

### Parameter Settings

*   **Setting Field:**
    *   `○`: Required item (必須項目)
    *   `△`: Optional item (任意項目)
    *   `×`: Cannot be set (設定不可)
    *   `※`: Conditional (Other conditions are described in the explanation or outside the field) (その他条件付)

### Order ID (Transaction ID)

*   **Generation:** Merchants should assign `orderId` arbitrarily. It must be assigned for each application process.
*   **Uniqueness:** Ensure `orderId` does not overlap with other transaction IDs. It cannot overlap with transaction IDs from other payment services either.
*   **Test vs. Production:** Test transaction IDs cannot be reused in production transactions.
*   **Allowed Characters:** In addition to alphanumeric characters, hyphens (`-`) and underscores (`_`) are permitted.

### Response Messages

*   Response messages may contain fields (parameters) not documented in this guide. However, merchants generally do not need to be concerned with fields other than those explicitly described.

```

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

### Execute Result Notification Test Tool - Example Log (Shell)

Source: https://www.veritrans.co.jp/docs/carrier/tips

This example log shows the output of running the result notification test tool, including prompts for confirmation and success messages.

```shell
C:\path\to\pushTool>java -jar pushSendTool-1.0.0-exe.jar -c push_data.properties -i sample.csv
PUSH_URL:http://your.domain.com/push/receive.php
本当にこのURLに送信してもよろしいですか？（Y/N）：Y 	 ※Yを入力し、Enterキー押下
 
結果通知電文の送信が正常に終了しました。
C:\path\to\pushTool>
```

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

### MDK Processing - Account Inquiry Sequence

Source: https://www.veritrans.co.jp/docs/bankpay

Explains the steps for inquiring about registered account information, covering the request and response.

```APIDOC
#### Account Inquiry Processing
1.  **Account Inquiry Request:** Information required for account inquiry is formatted and sent to the payment server.
2.  **Account Inquiry Response:** The result response is received from the payment server.
```

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

### VeriTrans Transaction Type Examples

Source: https://www.veritrans.co.jp/docs/credit/secure_3d

Provides examples of transaction types used to represent the status of transactions within the VeriTrans payment server. These types include those for 3D Secure and card payment operations.

```json
{
  "successDetailTxnType": "a" /* Indicates successful authorization. */
}

{
  "successDetailTxnType": "vpa" /* Indicates successful reversal of sale. */
}
```

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

### MDK Processing - Refund Sequence

Source: https://www.veritrans.co.jp/docs/bankpay

Outlines the steps involved in processing a refund request, from initiation to confirmation.

```APIDOC
#### Refund Processing
1.  **Refund Request:** Transaction details for the refund are formatted and sent to the payment server.
2.  **Refund Response:** The result response is received from the payment server.
```

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

### Example CSV for Result Notification Test Tool

Source: https://www.veritrans.co.jp/docs/carrier/tips

This is an example of a CSV file used as input for the result notification test tool. It includes headers and sample data for various transaction types and results.

```csv
orderId,txnType,txnTime,vResultCode,mstatus,crOrderId,openId,month
dummy1371701111111,Authorize,20130708121314,W001,success,dumCrOrId1111,https://3gs.veritrans.co.jp/dummyOpenId/idpage?id=OpenID-5i7pj8391lp,
dummy1371702222222,Terminate,20130708121314,W001,success,,,
dummy1371703333333,Terminate,20130708121314,W001,success,,https://3gs.veritrans.co.jp/dummyOpenId/idpage?id=OpenID-5i7pcs41fyw,
dummy1371704444444,Authorize,20130708121314,WGU3,failure,dumCrOrId4444,,
dummy1371705555555,MCapture,20130708121314,W001,success,,,201306
dummy1371706666666,MCapture,20130708121314,W001,success,,https://3gs.veritrans.co.jp/dummyOpenId/idpage?id=OpenID-5i7pcs41fyw,201306
dummy1371707777777,Deregistration,20130708121314,W002,success,,,
```

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

### Search API Request Examples

Source: https://www.veritrans.co.jp/docs/bankpay

Examples demonstrating how to construct search requests for the Veritrans API. This includes specifying multiple values for a parameter using array indexing and using wildcards for partial matching.

```url
exparam.serviceTypeCd[0]=card&exparam.serviceTypeCd[1]=BankPay
exparam.searchParameters.common.orderId=123*
```

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

### Continuous Payment Service (One-Click)

Source: https://www.veritrans.co.jp/docs/credit/secure_3d

Information on integrating the one-click continuous payment service, including interface requirements and specific considerations for 3D Secure usage.

```APIDOC
## Continuous Payment Service (One-Click)

This section provides details on using the one-click continuous payment service.

### Interface Documentation:
*   The interface details for the one-click continuous payment service are available at: "Interface Details - One-Click Continuous Payment Service".

### 3D Secure Usage Note:
*   If you wish to register cards that have successfully completed 3D Secure authentication (and authorization) for continuous payments, carefully review the "◆ Important Notes Regarding 3D Secure Usage" section within "2.2.2 Member ID Management and Payment Function during Credit Card Payment Execution".

### Request and Response Fields:
*   When performing payments using the one-click continuous payment service, ensure you configure the fields specified on this page along with the dedicated fields for the one-click service in your request.
*   Be aware that the response body will also include additional fields specific to the one-click continuous payment service.
```

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

### Java Example: Handling Transaction Information with X.Search

Source: https://www.veritrans.co.jp/docs/credit/secure_3d_tips

This Java code snippet demonstrates how to process transaction information when using X.Search. It iterates through transaction details obtained via search, distinguishing between 'mpi' (3D Secure authentication) and 'card' (credit card settlement) transaction types. The logic prioritizes the latest transaction based on 'txnId' for both MPI and card settlement results, ensuring accurate data is used for subsequent processing. This approach helps prevent misjudgments when multiple transactions of the same type exist.

```java
long txnIdMPI = 0;
long txnIdCard = 0;
for (int i = 0; i < index; i++) {
    bufTxnId = Long.valueOf(transactionInfo[i].getTxnId()).longValue();
    bufMStatus = transactionInfo[i].getMstatus();
    bufVResultCode = transactionInfo[i].getVResultCode();
   
    // MPI～カード決済までが実行された場合
    // このタイミングでリクエストIDによる検索を実行すると
    // txnKindが"mpi"と"card"のレコードがそれぞれ１件取得できる
   
    // MPI認証結果(複数件ある場合は最新の一件を取得)
    if (bufTxnKind != null && bufTxnKind.equals("mpi")) {
        if (bufTxnId > txnIdMPI) {
            mStatusMPI = bufMStatus;
            vResultCodeMPI = bufVResultCode;
            txnIdMPI = bufTxnId;
        }
    }
   
    // カード決済結果(最新の一件を取得)
    if (bufTxnKind != null && bufTxnKind.equals("card")) {
        if (bufTxnId > txnIdCard) {
            mStatusCard = bufMStatus;
            vResultCodeCard = bufVResultCode;
            txnIdCard = bufTxnId;
        }
    }
}

```

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

### Common Request Parameters

Source: https://www.veritrans.co.jp/docs/mdk_guide/search

These parameters are generally applicable across different payment methods for initiating transactions.

```APIDOC
## Common Request Parameters

### Description
These parameters are generally applicable across different payment methods for initiating transactions.

### Parameters
#### Request Body
- **reqAuthFlag** (string) - Optional - Requires authentication number (7 digits max). Currently unavailable.
- **reqBirthday** (string) - Optional - Requires birthday (4 digits max). Currently unavailable.
- **reqTel** (string) - Optional - Requires telephone number (4 digits max). Currently unavailable.
- **reqFirstKanaName** (string) - Optional - Requires first name in Kana (15 characters max).
- **reqLastKanaName** (string) - Optional - Requires last name in Kana (15 characters max).
- **reqWithNew** (string) - Optional - New refund flag ('true' for new refund, 'false' for cancellation/refund). Currently unavailable.
- **amount** (string) - Required - Payment amount (6 digits max).
- **name1** (string) - Optional - First name of customer (20 bytes max). Special characters may cause issues.
- **name2** (string) - Optional - Last name of customer (20 bytes max). Special characters may cause issues.
- **telNo** (string) - Optional - Customer telephone number (13 digits max, including hyphens).
- **free1** (string) - Optional - Memo field 1 (50 bytes max).
- **free2** (string) - Optional - Memo field 2 (50 bytes max).
- **payLimit** (string) - Optional - Payment deadline (YYYY/MM/DD format for convenience stores, YYYYMMDD for bank transfers).
- **orderKind** (string) - Required - Order type ('authorize' for payment, 'refund' for refund, 'present' for gift billing).
```
Tokens:
Raw