Request Fields

 

For more information about these data types, see the World Wide Web Consortium (W3C) XML Schema Part 2: Datatypes Second Edition.

 

Table 6

Data Type Definitions

Data Type	Description
Date and time	Format is YYYY-MM-DDThh:mm:ssZ, where: ■ T separates the date and the time ■ Z indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT) Example 2019-08-11T22:47:57Z equals August 11, 2019, at 22:47:57 (10:47:57 p.m.).
Integer	Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}
String	Sequence of letters, numbers, spaces, and special characters

 

Table 7

Request Fields

Field Name	Description	Used By: Required (R) or Optional (O)	Data Type & Length
apCheckStatusService_ apInitiateRequestID	Identifier returned from the initiate payment service request.	Check Status (R)	String (32)
apCheckStatusService_run	The check status service. Possible values: ■ true: Include the service in your request. ■ false (default): Do not include the service in your request.	Check Status (R)	String (5)
apInitiateService_productDescription	Description of the product offered to the customer. Important If you are using Chinese characters, the maximum string length is shorter.	Initiate Payment (O)	String (255)
apInitiateService_productName	Product offered to the customer. Important If you are using Chinese characters, the maximum string length is shorter.	Initiate Payment (R)	String (105)
apInitiateService_returnURL	URL of the web page to which the customer is directed when the transaction is completed. Important This URL overrides the URL that was set up when the merchant account was created.	Initiate Payment (O)	String (200)
apInitiateService_run	The initiate payment service. Possible values: ■ true: Include the service in your request. ■ false (default): Do not include the service in your request.	Initiate Payment (R)	String (5)
apRefundService_run	The refund payment service. Possible values: ■ true: Include the service in your request. ■ false (default): Do not include the service in your request.	Refund (R)	String (5)
apRefundService_apInitiateRequestID	Identifier returned from the initiate payment service request.	Refund (R)	String (26)
apRefundService_reason	Text describing the reason for the refund.	Refund (R)	String (100)
apRefundService_returnRef	Merchant-generated reference for the refund. CyberSource recommends that you send a unique value for each refund so that you can perform meaningful searches for the transaction. CyberSource generates a refund return reference number if this field is not populated.	Refund (R)	String (32)
apPaymentType	Identifier for the payment type. Values: ■ APD: web payment ■ ADM: mobile payment	Initiate Payment (R) Check Status (R) Refund (R)	String (3)
merchantID	Your CyberSource merchant ID.	Initiate Payment (R) Check Status (R) Refund (R)	String (50)
merchantReferenceCode	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. For more information about tracking orders, see Getting Started with CyberSource Advanced for the Simple Order API (PDF | HTML).	Initiate Payment (R) Check Status (R) Refund (R)	String (50)
purchaseTotals_currency	Currency used for the order. Value: CNY	Initiate Payment (R) Refund (R)	String (10)
purchaseTotals_grandTotalAmount	Grand total for the order. For information about items and grand totals, see Getting Started with CyberSource Advanced for the Simple Order API (PDF | HTML).	Initiate Payment (R) Refund (R)	String (10)

Reply Fields

Table 8

Reply Fields

Field Name	Description	Returned By	Data Type & Length
apCheckStatusReply_ reasonCode	Numeric value corresponding to the result of the apCheckStatusService_run request. See Reason Codes.	Check Status	Integer (5)
apCheckStatusReply_ reconciliationID	Reference number that you use to reconcile your CyberSource reports with your AliPay reports. For more information about tracking orders, see Getting Started with CyberSource Advanced for the Simple Order API (PDF | HTML).	Check Status	String (32)
apCheckStatusReply_ paymentStatus	Description of the payment status. Possible values: ■ PENDING: Payment has not been processed. ■ COMPLETED: Payment is complete. ■ ABANDONED: Customer cancelled the payment.	Check Status	String (15)
apCheckStatusReply_processorTransactionID	AliPay unique identification for the check status service request.	Check Status	String (28)
apInitiateReply_ merchantURL	Redirect URL to the AliPay web site to confirm the transaction. See Merchant URL Parameters.	Initiate Payment
apInitiateReply_reasonCode	Numeric value corresponding to the result of the apInitiateService_run request.	Initiate Payment	Integer (5)
apInitiateReply_ reconciliationID	Reference number that you use to reconcile your CyberSource reports with your AliPay reports. For more information about tracking orders, see Getting Started with CyberSource Advanced for the Simple Order API (PDF | HTML).	Initiate Payment	String (32)
decision	One-word description of the request result.	Initiate Payment Check Status Refund	String (50)
merchantReferenceCode	Order reference or tracking number that you provided in the request. For more information about tracking orders, see Getting Started with CyberSource Advanced for the Simple Order API (PDF | HTML).	Initiate Payment Check Status Refund	String (50)
reasonCode	Numeric value corresponding to the result of the request. See Reason Codes.	Initiate Payment Check Status Refund	Integer (5)
request_id	Identifier for the request generated by the client.	Initiate Payment Check Status Refund	String (32)
purchaseTotals_currency	Currency used for the order. See Alipay Supported Browsers.	Initiate Payment Check Status Refund	String (10)
apRefundReply_returnRef	Reference for the refund. CyberSource generates a the reference if this field is not populated.	Refund	String (32)
apRefundReply_reasonCode	Numeric value corresponding to the result of the apRefundService_run request.	Refund	Integer (5)
apRefundReply_reconciliationID	Reference number that you use to reconcile your CyberSource reports with your AliPay reports. For more information about tracking orders, see Getting Started with CyberSource Advanced for the Simple Order API (PDF | HTML).	Refund	String (32)
apRefundReply_dateTime	Date and time of refund. It is Beijing time. Format: YYYYMMDDHHMMSS	Refund	String (14)
apRefundReply_amount	The total refund amount.	Refund	Numeric (15)