About the EMV 3-D Secure Authentication System
EMV 3-D Secure for Online Payment ASP authenticates credit card user information and other payment information for most transactions without additional authentication through risk-based authentication and requires additional authentication, such as a one-time password, for high-risk transactions only.
Merchants can link card user payment information to a certificate authority by incorporating the EMV 3-D Secure authentication JavaScript provided by SBPS into its website.
Usage Overview

Available Payment Methods
Credit Card Payment (ID verification service (EMV 3-D Secure)) |
Sequence
The flow from acquiring the credit card user payment information token to the purchase request is as follows. For details on the payment flow after obtaining the credit card user payment information token, refer to the Link Type Purchase Request / Link Type Customer Payment Information Registration Request.

Interface
The interface for the EMV 3-D Secure Authentication System is shown below. The format to be used should be the XML format.
For details, see API Type (Basic Specifications).
File | com_sbps_system_tds2infotoken.js |
---|---|
Function name | com_sbps_system_tds2.generateToken |
Destination | To be informed when the service starts |
---|
Requesting the Token of Payment Information for Credit Card User
Object/function name | Field name | Description | Remarks |
---|---|---|---|
tokenRequest | Token request | An object that specifies properties that are required to generate token of payment information for credit card user. | Set customer information obtained from merchant website. |
callback | Callback | A function that calls back after the token of payment information for credit card user is obtained. |
Credit Card User Payment Information Token Request
≪About Formats≫ 9: Numeric Type (1 Byte 0 to 9), X: Half-width Character String, M: Multi-byte Character String (No need for BASE64 encoding)
SEQ | Tag element name | Field name | Chars | Format | Req'd | Type | Description | Remarks |
---|---|---|---|---|---|---|---|---|
1 | merchantId | Merchant ID | 5 | 9 | ○ | Fixed | ID for identifying the merchant | Specified by SBPS |
2 | serviceId | Service ID | 3 | 9 | ○ | Fixed | ID for identifying the merchant's service | Specified by SBPS |
3 | billingLastName | Last name of billing destination | 22 | X | △ | Var. | English (surname) Required if using redirection type or API type | The credit card company decides whether or not additional information is necessary on the basis of the credit card user payment information given by the Merchant. Therefore, the more information with more accuracy the Merchant gives, the more possibility the credit card company does not require additional authentication. |
4 | billingFirstName | First name of billing destination | 22 | X | △ | Var. | Roman characters (first name) Required if using redirection type or API type | |
5 | billingPostalCode | Billing postal code | 7 | X | Var. | |||
6 | billingCity | Billing prefecture | 50 | M | Var. | Please enter up to 50 bytes in total (up to 25 characters if entering full-width Japanese). | ||
7 | billingAddress1 | Billing city/town | 50 | M | Var. | Please enter up to 50 bytes in total (up to 25 characters if entering full-width Japanese). | ||
8 | billingAddress2 | Billing street/number | 50 | M | Var. | Please enter up to 50 bytes in total (up to 25 characters if entering full-width Japanese). | ||
9 | billingAddress3 | Billing building name | 50 | M | Var. | Please enter up to 50 bytes in total (up to 25 characters if entering full-width Japanese). | ||
10 | billingPhone | Billing phone number | 20 | X | △ | Var. | Required if you do not link Email address. | |
11 | workPhone | Work phone number | 25 | X | Var. | |||
12 | shippingPostalCode | Delivery postal code | 7 | X | Var. | |||
13 | shippingCity | Delivery prefecture | 50 | M | Var. | Please enter up to 50 bytes in total (up to 25 characters if entering full-width Japanese). | ||
14 | shippingAddress1 | Delivery city/town | 50 | M | Var. | Please enter up to 50 bytes in total (up to 25 characters if entering full-width Japanese). | ||
15 | shippingAddress2 | Delivery street/number | 50 | M | Var. | Please enter up to 50 bytes in total (up to 25 characters if entering full-width Japanese). | ||
16 | shippingAddress3 | Delivery building name | 50 | M | Var. | Please enter up to 50 bytes in total (up to 25 characters if entering full-width Japanese). | ||
17 | Email address | 254 | X | △ | Var. | Required if you do not link Billing phone number. |
Result of Obtaining the Token of Payment Information for Credit Card User
Object/function name | Field name | Description | Remarks |
---|---|---|---|
response | Response result | Credit card user payment information token result object | Returns the token of payment information for credit card user generated by SBPS. |
Response Result (Success)
≪About Formats≫ 9: Numeric Type (1 Byte 0 to 9), X: Half-width Character String, M: Multi-byte Character String (No need for BASE64 encoding)
SEQ | Tag element name | Field name | Chars | Format | Req'd | Type | Description | Remarks |
---|---|---|---|---|---|---|---|---|
1 | result | Result status | 2 | X | ○ | Fixed | OK: Request processing OK | |
2 | tokenResponse | Credit card user payment information token response | ○ | Var. | Credit card user payment information token result object | |||
3 | tds2infoToken | Credit card user payment information token | X | ○ | Var. | |||
4 | tds2infoTokenKey | Credit card user payment information token key | X | ○ | Var. | |||
5 | billingLastName | Last name of billing destination | 22 | X | Var. | Roman characters (last name) | ||
6 | billingFirstName | First name of billing destination | 22 | X | Var. | Roman characters (first name) | ||
7 | billingPostalCode | Billing postal code | 7 | X | Var. | |||
8 | billingCity | Billing prefecture | 50 | M | Var. | |||
9 | billingAddress1 | Billing city/town | 50 | M | Var. | |||
10 | billingAddress2 | Billing street/number | 50 | M | Var. | |||
11 | billingAddress3 | Billing building name | 50 | M | Var. | |||
12 | billingPhone | Billing phone number | 20 | X | Var. | |||
13 | workPhone | Work phone number | 25 | X | Var. | |||
14 | shippingPostalCode | Delivery postal code | 7 | X | Var. | |||
15 | shippingCity | Delivery prefecture | 50 | M | Var. | |||
16 | shippingAddress1 | Delivery city/town | 50 | M | Var. | |||
17 | shippingAddress2 | Delivery street/number | 50 | M | Var. | |||
18 | shippingAddress3 | Delivery building name | 50 | M | Var. | |||
19 | Email address | 254 | X | Var. |
Response Result (Error)
≪About Formats≫ 9: Numeric Type (1 Byte 0 to 9), X: Half-width Character String, M: Multi-byte Character String (No need for BASE64 encoding)
SEQ | Tag element name | Field name | Chars | Format | Req'd | Type | Description | Remarks |
---|---|---|---|---|---|---|---|---|
1 | result | Result status | 2 | X | ○ | Fixed | NG: Request processing NG | |
2 | errorCode | Error code | 5 | X | ○ | Fixed | See list of error codes |
List of Error Codes
The error code system to be returned is shown below.
Digits 1-2: Represent a type. (2-digit fixed length alphanumeric characters)
Digits 3-5: Represent a field. (3-digit fixed length alphanumeric characters)
The error code system to be returned is shown below.
Type of Codes
Code | Type | Description |
---|---|---|
Errors related to request information | ||
03 | Required field error | No value is specified in a required field. |
04 | Attribute error | Allowed character attribute error |
05 | Number of digits error | Outside of the allowable number of digits (bytes) |
07 | Defined value error | A value other than the defined values is specified. |
Error which occurs on the server | ||
99 | System error | An internal processing error occurred. |
Field Codes
Code | Type | Description |
---|---|---|
Generation of a one-time ID token | ||
001 | Merchant ID | |
002 | Service ID | |
003 | Last name of billing destination | |
004 | First name of billing destination | |
005 | Billing postal code | |
006 | Billing prefecture | |
007 | Billing city/town | |
008 | Billing street/number | |
009 | Billing building name | |
010 | Billing phone number | |
011 | Contact phone number | |
012 | Delivery postal code | |
013 | Delivery prefecture | |
014 | Delivery city/town | |
015 | Delivery street/number | |
016 | Delivery building name | |
017 | Email address | |
999 | (N/A) |
Sample Codes
An example of obtaining the token of the payment information for the credit card user is shown below.
Note that the sample code is still under development and is subject to change.
Special notes
Validity Period for the Credit Card User Payment Information Token
It is recommended that the credit card user payment information token be acquired immediately prior to the time of payment request as it is unavailable after a certain period of time has elapsed from the time that the credit card user payment information token is issued. If it is no longer available, please acquire it again.
About Browser Settings
This document assumes that you are using a JavaScript-enabled browser. Operation is not guaranteed for environments in which JavaScript does not function.
Available Encryption Protocols
Due to the regulations of PCI DSS (which SBPS complies with), SSL 3.0 and TLS 1.0 cannot be used.
In addition, there is a high possibility that the use of TLS 1.1 will be prohibited in the future because its vulnerabilities as an encryption method have been disclosed. Therefore, Merchants shall use TLS 1.2.