Link Type Recurring Billing (Fixed Term/Pay as You Go) 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.	docomo: d Payment(Carrier/Wallet) auone：au PAY（au Kantan Kessai (Easy Payment)） softbank2: SoftBank Matomete Shiharai (B) rakuten: Rakuten Pay (Online Payment) rakutenv2: Rakuten Pay (Online Payment) V2 recruit: Recruit Kantan Shiharai PayPay: PayPay (Online Payment) If omitted, select on the ASP screen. When specifying more than one, specify them separated by commas.	Specifies the payment method. (one or more can be specified) Required if the service type is 1: Cancellation, 2: Reapplication, or 3: Special Linkage. Special Linkage *When specifying two or more methods, delimit them with commas.
2	merchant_id	Merchant ID	5	9	○	Fixed	ID for identifying the merchant	Specified by SBPS
3	service_id	Service ID	3	9	○	Fixed	ID for identifying the merchant's service	Specified 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	order_id	Purchase ID	38	X	○	Var.	A purchase ID managed by the merchant	Should be unique value for a combination of a Merchant ID and Service ID
6	item_id	Product ID	32	X	○	Var.	A product ID managed by the merchant
7	item_name	Product name	40	M		Var.	A product name of your choice	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 "?". *When specifying two or more methods, separate them with commas.
8	service_type	Service type	1	9	○	Fixed	*If not set, the item name item itself will not be displayed on the confirmation screen. Application 1: Cancellation 2: Re-request 3: Special Linkage 4: 4:	"2: Reapply" can only be specified for au PAY (au Kantan Kessai (Easy Payment)). Re-application" can be specified only for au Kantan Kessai Service. ”3: Special Linkage" and "4: User account linkage" can only be specified for PayPay (online payment). "4: User account linkage" is set, the PayPay app will be automatically launched when you apply for recurring billing (recurring and pay-as-you-go) from a smartphone with the PayPay app installed, and the application will be made via the app. "3:
9	tracking_id	Tracking ID	14	X	△	Var.	ID paid out by SBPS at the time of application	Can only be specified and is required when the service type is "1: Cancellation" or "2: Re-request" and is required. Unique value for each payment method
10	terminal_type	Type of terminal used by customer	1	9		Fixed	0: PC 1: Cellphone	When omitted, "0" is applied. *For details, please refer to the Setting the Terminal Type for Requests (Basic Specifications).​
11	success_url	URL when payment is completed	500	X	○	Var.	URL to which the screen returns
12	cancel_url	URL to go to when the payment is canceled	500	X	○	Var.	URL to which the screen returns
13	error_url	URL to go to when an error occurs	500	X	○	Var.	URL to which the screen returns
14	pagecon_url	Registration notification CGI	500	X	○	Var.	URL to which the result is notified	SSL communication is required.
15	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 "?".
16	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 "?".
17	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 "?".
18	request_date	Date and time of request	14	9	○	Fixed	YYYYMMDDHHMISS	Date and time when this function is requested by the merchant.
19	limit_second	Request timeout	4	9		Var.	Sets the expiration time of request in seconds	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	Method for Generating Checksums (Basic Specifications) Please refer to it.

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	order_id	Purchase ID	38	X	○	Var.	〃
6	item_id	Product ID	32	X	○	Var.	〃
7	item_name	Product name	40	M		Var.	〃
8	service_type	Service type	1	9	○	Fixed	〃
9	tracking_id	Tracking ID	14	X		Fixed	〃	Unique value for each payment method
10	terminal_type	Type of terminal used by customer	1	9		Fixed	〃
11	free1	Free field 1	20	M		Var.	〃
12	free2	Free field 2	20	M		Var.	〃
13	free3	Free field 3	20	M		Var.	〃
14	request_date	Date and time of request	14	9	○	Fixed	〃
Fields to be set when the result is returned
15	res_pay_method	Processed result Payment method	20	X	○	Var.		Payment method selected at time of request
16	res_result	Status of processing result	2	X	○	Fixed	OK: Request processing OK NG: Request NG
17	res_tracking_id	Tracking ID for processing	14	X	○	Fixed	ID assigned by SBPS at time of request	Unique value for each payment method
18	res_payinfo_key	Customer payment information	32	X		Var.	Customer payment information	To be returned only if the processed result is OK. au PAY(au Kantan Kessai (Easy Payment)): MD5 value of OpenID d-Barai (Carrier/Wallet): OpenID MD5 Value SoftBank Matomete Shiharai: Intermediate ID MD5 Value Rakuten Pay (Online Payment) Intermediate ID MD5 Value Rakuten Pay (Online Payment) V2: OpenID MD5 Value Recruit Kantan Shiharai: Authentication Number MD5 Value PayPay (Online Payment): userAuthorizationId MD5 Value
19	res_payment_date	Handle completion date/time	14	9		Var.	YYYYMMDDHHMISS	If the processed result status is OK, the processed date of the financial institution. If the processing result status is NG, there may be no processing date and time.
20	res_err_code	Error code	4	X		Var.	See list of error codes
21	res_date	Date and time of response	14	9	○	Var.	YYYYMMDDHHMISS	Date and time responded by SBPS
22	limit_second	Response limit time	4	9	○	Var.	Timeout when a request is issued	The default value of 600 is applied if this item is omitted.
23	sps_hashcode	Checksum	40	X	○	Fixed	For the message represented as a value Checksum	Method for Generating Checksums (Basic Specifications) Please refer to it.

Result CGI Response 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	Field name	Chars	Format	Req'd	Description	Remarks
1	Processed result	2	X	○	OK/NG	Processed result at merchant *Be sure to return OK if "res_result" of the result CGI is NG.
2	Error message	100	M		When an error occurs on the merchant side Message to be displayed	Not required when the process is "OK"

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	order_id	Purchase ID	38	X	○	Var.	〃
6	item_id	Product ID	32	X	○	Var.	〃
7	item_name	Product name	40	M		Var.	〃
8	service_type	Service type	1	9	○	Fixed	〃
9	tracking_id	Tracking ID	14	X		Fixed	〃	Unique value for each payment method
10	terminal_type	Type of terminal used by customer	1	9		Fixed	〃
11	free1	Free field 1	20	M		Var.	〃
12	free2	Free field 2	20	M		Var.	〃
13	free3	Free field 3	20	M		Var.	〃
14	request_date	Date and time of request	14	9	○	Fixed	〃
Fields to be set when the result is returned
15	res_pay_method	Processed result Payment method	20	X	○	Var.		Payment method selected at time of request
16	res_result	Status of processing result	2	X	○	Fixed	OK: Request processing OK NG: Request NG
17	res_tracking_id	Tracking ID for processing	14	X	○	Fixed	ID assigned by SBPS at time of request	Unique value for each payment method
18	res_payinfo_key	Customer payment information	32	X		Var.	Customer payment information	To be returned only if the processed result is OK. au PAY(au Kantan Kessai (Easy Payment)): MD5 value of OpenID d-Barai (Carrier/Wallet): OpenID MD5 Value SoftBank Matomete Shiharai: Intermediate ID MD5 Value Rakuten Pay (Online Payment) Intermediate ID MD5 Value Rakuten Pay (Online Payment) V2: OpenID MD5 Value Recruit Kantan Shiharai: Authentication Number MD5 Value PayPay (Online Payment): userAuthorizationId MD5 Value
19	res_payment_date	Handle completion date/time	14	9		Var.	YYYYMMDDHHMISS	If the processed result status is OK, the processed date of the financial institution. If the processing result status is NG, there may be no processing date and time.
20	res_err_code	Error code	4	X		Var.	See list of error codes
21	res_date	Date and time of response	14	9	○	Var.	YYYYMMDDHHMISS	Date and time responded by SBPS
22	limit_second	Response limit time	4	9	○	Var.	Timeout when a request is issued	The default value of 600 is applied if this item is omitted.
23	sps_hashcode	Checksum	40	X	○	Fixed	For the message represented as a value Checksum	Method for Generating Checksums (Basic Specifications) Please refer to it.