Link Type Customer Payment Information Registration Request

Interface Specifications

The following shows the interface field definitions for the provided functions.

Request Field Definitions

(Legend of Type X: Single-byte character type M: Mixed double-byte character type 9: Numeric type)
*For the characters available for use, please refer to the Definition of Available Data Types (Basic Specifications).​

SEQ	Tag element name	Field name	Chars	Format	Req'd	Type	Description	Remarks
1	pay_method	Payment method	1000	X		Var.	credit: Credit Card Payment credit3d2: Credit Card Payment (ID verification service (EMV 3-D Secure)) tpoint: T-Point Program (Online Payment) accttransfer: (Account transfer service)	Specifies the payment method. (one or more can be specified) * When omitted or specifying two or more methods, the payment selection screen is displayed by SBPS. * When specifying two or more methods, separate them with commas.
2	merchant_id	Merchant ID	5	9	○	Fixed	ID for identifying the merchant	Assigned by SBPS
3	service_id	Service ID	3	9	○	Fixed	ID for identifying the merchant's service	Assigned by SBPS
4	cust_code	Customer ID	64	X	○	Var.	A customer ID managed by the merchant	This must be unique with respect to the combination of merchant ID and service ID. This ID must be assigned for each customer since it will be used as the association key for storing payment information.
5	sps_cust_no	SBPS Customer ID	12	9	△	Fixed	Customer ID managed by SBPS	Required to specify when the SBPS payment method management number is set.
6	sps_payment_no	SBPS payment method management number	3	9	△	Fixed	Payment method management number controlled by SBPS	Required to specify when the SBPS customer ID is set
7	terminal_type	Type of terminal used by customer	1	9		Fixed	0: PC 1: Cellphone	When omitted, "0" is applied. (PC and mobile device identification)
8	success_url	URL when payment is completed	500	X	○	Var.	URL to which the screen returns
9	cancel_url	URL to go to when the payment is canceled	500	X	○	Var.	URL to which the screen returns
10	error_url	URL to go to when an error occurs	500	X	○	Var.	URL to which the screen returns
11	pagecon_url	Registration notification CGI	500	X	○	Var.	URL to which the result is notified	SSL communication is required.
12	free1	Free field 1	20	M		Var.		Japanese characters and halfwidth alphanumeric characters may be used together. This string is cut off if it exceeds the character limit. Any garbled characters will be replaced by "?".
13	free2	Free field 2	20	M		Var.		Japanese characters and halfwidth alphanumeric characters may be used together. This string is cut off if it exceeds the character limit. Any garbled characters will be replaced by "?".
14	free3	Free field 3	20	M		Var.		Japanese characters and halfwidth alphanumeric characters may be used together. This string is cut off if it exceeds the character limit. Any garbled characters will be replaced by "?".
15	free_csv	Free item	4000	M		Var.		Please refer to the payment-specific tag "free_csv."​
16	request_date	Date and time of request	14	9	○	Fixed	YYYYMMDDHHMISS	Date and time when this function is requested by the merchant.
17	limit_second	Request timeout	4	9		Var.	Difference in allowed length of time between the time stamp on SBPS server and the date of request	The default value of 600 is applied if this item is omitted.
18	sps_hashcode	Checksum	40	X	○	Fixed	The checksum for the message represented as a value	Please refer to the Method for Generating Checksums (Basic Specifications).

Result CGI Field Definitions

(Legend of Type X: Single-byte character type M: Mixed double-byte character type 9: Numeric type)
*For the characters available for use, please refer to the Definition of Available Data Types (Basic Specifications).​

SEQ	Tag element name	Field name	Chars	Format	Req'd	Type	Description	Remarks
1	pay_method	Payment method	1000	X		Var.	As per the purchase request
2	merchant_id	Merchant ID	5	9	○	Fixed	〃
3	service_id	Service ID	3	9	○	Fixed	〃
4	cust_code	Customer ID	64	X	○	Var.	〃
5	sps_cust_no	SBPS Customer ID	12	9		Fixed	〃
6	sps_payment_no	SBPS payment method management number	3	9		Fixed	〃
7	terminal_type	Type of terminal used by customer	1	9		Fixed	〃
8	free1	Free field 1	20	M		Var.	〃
9	free2	Free field 2	20	M		Var.	〃
10	free3	Free field 3	20	M		Var.	〃
11	request_date	Date and time of request	14	9	○	Fixed	〃
Fields to be set when the result is returned
12	res_pay_method	Processed result Payment method	20	X	○	Var.		The payment method selected when the customer payment information was registered or requested to be deleted.
13	res_result	Status of processing result	2	X	○	Fixed	OK: Registration process complete CN: Deletion process complete NG: Processing NG	When the deletion process is completed normally in the customer payment information deletion request process, the processed result status, CN (deletion process completed), is returned. In customer payment information registration/deletion requests, the process result status NG (Processing NG) will not be returned.
14	res_sps_cust_no	SBPS Customer ID for processing	12	9	△	Fixed	Customer ID managed by SBPS	Returned only when the process is completed normally.
15	res_sps_payment_no	SBPS payment method management number for processing	3	9	△	Fixed	Payment method management number controlled by SBPS	Returned only when the process is completed normally.
16	res_payinfo_key	Key to identify customer payment information	32	X		Fixed	Key to identify the customer payment information	To be returned only if the processed result is OK. Credit card payment: Hash value calculated from the card number through an SBPS original calculation (Supplementary 0 + 16 digits) T-Point Program (Online Payment): None
17	res_err_code	Error code	4	X		Var.	See list of error codes
18	res_date	Date and time of response	14	9	○	Var.	YYYYMMDDHHMISS	Date and time responded by SBPS
19	limit_second	Response limit time	4	9	○	Var.	Difference in allowed length of time between the time stamp on SBPS server and the date of request	The default value of 600 is applied if this item is omitted.
20	sps_hashcode	Checksum	40	X	○	Fixed	The checksum for the message represented as a value	Please refer to the Method for Generating Checksums (Basic Specifications).

Result CGI Response Field Definitions

When the HTTP status is 200, it is considered OK. When the status is other than 200, it is considered NG. . Even when an error is returned, process for SBPS has been completed. The screen moves to the specified error screen.

Note that even when a response error is returned from the merchant, the HTTP status 200 is given a higher priority and the process will be completed.

Result (Redirect Back to Merchant's Screen) Field Definitions

(Legend of Type X: Single-byte character type M: Mixed double-byte character type 9: Numeric type)
*For the characters available for use, please refer to the Definition of Available Data Types (Basic Specifications).​

SEQ	Tag element name	Field name	Chars	Format	Req'd	Type	Description	Remarks
1	pay_method	Payment method	1000	X		Var.	As per the purchase request
2	merchant_id	Merchant ID	5	9	○	Fixed	〃
3	service_id	Service ID	3	9	○	Fixed	〃
4	cust_code	Customer ID	64	X	○	Var.	〃
5	sps_cust_no	SBPS Customer ID	12	9		Fixed	〃
6	sps_payment_no	SBPS payment method management number	3	9		Fixed	〃
7	terminal_type	Type of terminal used by customer	1	9		Fixed	〃
8	free1	Free field 1	20	M		Var.	〃
9	free2	Free field 2	20	M		Var.	〃
10	free3	Free field 3	20	M		Var.	〃
11	request_date	Date and time of request	14	9	○	Fixed	〃
Fields to be set when the result is returned
12	res_pay_method	Processed result Payment method	20	X	○	Var.		The payment method selected when the payment information was registered
13	res_result	Status of processing result	2	X	○	Fixed	OK: Registration process complete CN: Deletion process complete NG: Processing NG	When the deletion process is completed normally in the customer payment information deletion request process, the processed result status, CN (deletion process completed), is returned. In customer payment information registration/deletion requests, the process result status NG (Processing NG) will not be returned.
14	res_sps_cust_no	SBPS Customer ID for processing	12	9	△	Fixed	Customer ID managed by SBPS	Returned only when the process is completed normally.
15	res_sps_payment_no	SBPS payment method management number for processing	3	9	△	Fixed	Payment method management number controlled by SBPS	Returned only when the process is completed normally.
16	res_payinfo_key	Key to identify customer payment information	32	X		Fixed	Key to identify the customer payment information	To be returned only if the processed result is OK. Credit card payment: Hash value calculated from the card number through an SBPS original calculation (Supplementary 0 + 16 digits) T-Point Program (Online Payment): None
17	res_err_code	Error code	4	X		Var.	See list of error codes
18	res_date	Date and time of response	14	9	○	Var.	YYYYMMDDHHMISS	Date and time responded by SBPS
19	limit_second	Response limit time	4	9	○	Var.	Difference in allowed length of time between the time stamp on SBPS server and the date of request	The default value of 600 is applied if this item is omitted.
20	sps_hashcode	Checksum	40	X	○	Fixed	The checksum for the message represented as a value	Please refer to the Method for Generating Checksums (Basic Specifications).

Individual Specifications

Payment-specific tag "free_csv"

Credit card payment (ID verification service (3D secure))

The settings necessary for the ID verification for the Link Type credit card payment (ID verification service (EMV 3-D Secure)) can be configured.

How to Use

<<API Used>>

Connection method	API Type	Data flow
Link Type	Purchase Request	Merchant→SBPS

<<Elements to be Configured>>

(Legend of Type X: Single-byte character type M: Mixed double-byte character type 9: Numeric type)
*For the characters available for use, please refer to the Definition of Available Data Types (Basic Specifications).​

Tag element name	Field name	Chars	Format	Type	Description	Remarks
free_csv	Free field (CSV format)	4000	M	Var.	Refer to "How to Set Up" below.	base64 encoding is required. When using the API Type service together, an encryption with 3DES may be required.

How to Set Up

Concatenate (1) Field name, (2) Connection character (single-byte equal), (3) Field value, and (4) Delimiter (single-byte comma).

<<Field Definitions>>

Description	Setting Value	Description	Chars	Format	Remarks
Field name	TDS2INFO_TOKEN	Token of payment information of credit card user		X	For details, refer to "E003_EMV 3-D Secure Authentication Specifications."
	TDS2INFO_TOKEN_KEY	Token key of payment information of credit card user		X

<<Setting Examples>>

• Connect the setting value and that value with a connection character (single-byte equal), and concatenate them with a delimiter (single-byte comma). TDS2INFO_TOKEN=123456789abc,TDS2INFO_TOKEN_KEY=asdefg123
• Encrypt the string through the 3DES encryption, and then convert it in the base64 format. 1BNK6NDjiRdhEN0p5rajgyp2tjEC5EEnpvbBGYO+F6fckdWWXllvDYGQ1Jq・・・
• Set it to free_csv with Link Type POST fields, and send.

<<Validation>>

When making a request of purchase request, although validation for the whole field is performed, validation is not performed for each field. (Validation for each field is performed after the screen has moved to the Input screen, and if it results in an error, the screen moves to the error screen.)

The details of validation for free_csv are as follows:

• The sent character string is 4,000 bytes or less.
  • The encoding format is base64.
  • The decoded character string is 2,500 bytes or less.

 Restrictions

<<Restrictions>>

Attention must be paid to free_csv as it has the following restrictions:

• The character encoding must be S-JIS
• Field names must be case sensitive
• Field names must not include connectors or delimiters
• Field values must not include delimiters
• The field order does not matter
• Fields are not mandatory
• Although setting undefined fields will not be a problem, such undefined fields must be ignored. Change of input by end users will not be redirected after the screen has moved to the Input screen.
• On the administration screen, the free_csv data itself is not displayed.

<<Characters that cannot be Used in free_csv Fields>>

The following characters cannot be used in any of the fields:

Character	Name	S-JIS Code
,	Single-byte comma	0x2C
‘	Single-byte single quotation	0x27
“	Single-byte double quotation	0x22
%	Single-byte percent	0x25
|	Single-byte pipe	0x7C
&	Single-byte ampersand	0x26
<	Single-byte smaller-than sign	0x3C
>	Single-byte greater-than sign	0x3E
｡ ｢｣､･ｦｧｨｩｪｫｬｭｮｯｰｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜﾝﾞﾟ	Single-byte katakana	0xA1–0xDF