Payment Request Fields

 

Table 12

Payment Request Fields for the SCMP API

Field Name	Description	Required / Optional	Data Type & Length
bill_address1	Billing street address as it appears in the financial institution’s records.	Optional.	String (60)
bill_address2	Additional address information.	Optional.	String (60)
bill_city	Billing city as it appears in the financial institution’s records.	Optional.	String (50)
bill_country	Billing country as it appears in the financial institution’s records. Use the two-character country codes.	Optional.	String (2)
bill_zip	Postal code for the billing address. If the billing country is not the U.S. or Canada, any string up to 9 characters is accepted. If the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example Example: 12345-6789 If the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example Example: A1B 2C3	Optional.	String (9)
currency	Currency used for the order. Possible values: ■ CNY (RMB) ■ USD: USD can be used only for international cards and only for products and services that are priced in USD. CyberSource verifies that the value is either CNY or USD and that it is active in your CyberSource merchant configuration.	Required by the processor.	String (5)
customer_email	Customer’s email address, including the full domain name. Example: jdoe@example.com	Optional.	String (255)
customer_firstname	Customer’s entire name or first name. This value should be the same as the one that appears in the financial institution’s records. Note A name must be provided. You can do one of the following: ■ Provide the entire name in the first-name field. ■ Provide the entire name in the last-name field. ■ Provide the first name in the first-name field and the last name in the last-name field.	Optional if the customer’s first and last name are combined as a single value in the last-name field; otherwise, required by the processor.	String (60)
customer_lastname	Customer’s entire name or last name. This value should be the same as the one that appears in the financial institution’s records. Note A name must be provided. You can do one of the following: ■ Provide the entire name in the first-name field. ■ Provide the entire name in the last-name field. ■ Provide the first name in the first-name field and the last name in the last-name field.	Optional if the customer’s first and last name are combined as a single value in the first-name field; otherwise, required by the processor.	String (60)
grand_total_amount	Grand total for the order. You must include either this field or offer0 and the offer-level field amount. The maximum amount is 50000.00.	Required by the processor if there are no offer lines in the request.	Decimal (15)
ics_applications	Service to process for the request. For a payment request, this value should be ics_china_payment.	Required for CyberSource front-end processing; not used by the processor.	String (255)
merchant_id	Your CyberSource merchant ID. Use the same merchant_id field for evaluation, testing, and production. Your CyberSource merchant ID must correspond to only one PayEase merchant ID. Likewise, your PayEase merchant ID must correspond to only one CyberSource merchant ID.	Required for CyberSource front-end processing; not used by the processor.	String (30)
merchant_ref_number	Merchant-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction on the Business Center and in CyberSource reports. For more information about order tracking, see Getting Started with CyberSource Advanced for the SCMP API.	Required for CyberSource front-end processing; not used by the processor.	String (50)
offerN: amount	Per-item price of the product. You must include either offer0 and this field, or the request-level field grand_total_amount in your request. The maximum amount is 50000.00. This value cannot be negative. You can include a decimal point (.) in this field, but you cannot include any other special characters. The amount is truncated at the request level to the correct number of decimal places.	Required by the processor if grand_total_amount is not in the request.	Decimal (15)
payment_mode	Payment Mode. Contact PayEase for the mapping of the supported payment system names to the PayEase payment mode values. Ask for the report titled Banks & Payment Channels Supported by PayEase Payment Platform.	Required by the processor.	Integer (3)
return_url	URL that is used to return the customer to your Web site after the transaction. Do not include parameters at the end of the URL. Example of correct URL: http://example.com/checkout.jsp Example of incorrect URL: http://example.com/checkout.jsp?orderID=12345	Required by the processor.	String (512)
ship_to_address1	First line of the shipping address.	If any shipping information is in the request, this field is required for CyberSource front-end processing.*	String (60)
ship_to_address2	Second line of the shipping address.	Optional.	String (60)
ship_to_city	City of the shipping address.	If any shipping information is in the request and if the shipping country is the U.S. or Canada, this field is required for CyberSource front-end processing.*	String (50)
ship_to_country	Country of the shipping address. Use the two-character ISO Standard Country Codes.	If any shipping information is in the request, this field is required for CyberSource front-end processing.*	String (2)
ship_to_firstname	Entire name or first name of the recipient.	If any shipping information is in the request, this field is required for CyberSource front-end processing.*	String (60)
ship_to_lastname	Last name of the recipient.	Optional if the recipient’s first name and last name are combined as a single value in the ship-to first-name field; otherwise, required for CyberSource front-end processing if any shipping information is in the request.*	String (60)
ship_to_phone	Phone number for the shipping address.   Include the country code.	If any shipping information is in the request, this field is required for CyberSource front-end processing.*	String (20)
ship_to_zip	Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the shipping country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the shipping country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 If the shipping country is not the U.S. or Canada, any string up to 9 characters is accepted.	If any shipping information is in the request and if the shipping country is the U.S. or Canada, this field is required for CyberSource front-end processing.*	String (9)
* If one shipping field is included, they all must be included, except ship_to_address2 which is always optional.