API Fields. CyberSource Simple Order API

PDF

Dokument

Reklama

API Fields

Request Fields

For more information about these data types, see the World Wide Web Consortium (W3C)

XML Schema Part 2: Datatypes specification .

Data Type

Integer

String

Description

Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}

Sequence of letters, numbers, spaces, and special characters

Table 6 Request-Level for the Simple Order API

Field Name

apCheckStatusService_ apInitiateRequestID apCheckStatusService_run apInitiateService_ productDescription

Description

Identifier returned from the initiate payment service request.

The check status service.

Possible values:

 true: Include the service in your request.

 false (default): Do not include the service in your request.

Description of the product offered to the customer.

Important

If you are using

Chinese characters, the maximum string length is shorter.

Used By:

Required (R) or

Optional (O)

Check Status (R)

Data Type &

Length

String (32)

String (5)

Initiate Payment (O) String (255)

AliPay Domestic Services Using the Simple Order API

October 2015

Appendix A

API Fields

Table 6 Request-Level for the Simple Order API (Continued)

Field Name Description Used By:

Required (R) or

Optional (O)

Initiate Payment (R) apInitiateService_ productName Product offered to the customer.

Important

If you are using

Chinese characters, the maximum string length is shorter.

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. apInitiateService_run The initiate payment service.

Possible values:

 true: Include the service in your request.

apRefundService_run apRefundService_ apInitiateRequestID apRefundService_reason apRefundService_returnRef

 false (default): Do not include the service in your request.

The refund payment service.

Possible values:

 true: Include the service in your request.

 false (default): Do not include the service in your request.

Identifier returned from the initiate payment service request.

Text describing the reason for the refund.

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.

Data Type &

Length

Initiate Payment (O) String (200)

Initiate Payment (R)

Refund (R)

String (105)

String (5)

String (26)

String (100)

String (32)

AliPay Domestic Services Using the Simple Order API

October 2015

Appendix A

API Fields

Table 6

merchantID

Request-Level for the Simple Order API (Continued)

Field Name

apPaymentType

Description Used By:

Required (R) or

Optional (O)

Initiate Payment (R) Identifier for the payment type.

Values:



APD: web payment



ADM: mobile payment

Check Status (R)

Refund (R)

Your CyberSource merchant ID. Initiate Payment (R)

Check Status (R)

Refund (R) purchaseTotals_currency purchaseTotals_ grandTotalAmount

Data Type &

Length

String (3)

String (50)

String (50) 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 ).

Currency used for the order.

Value: CNY

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 ).

Check Status (R)

Refund (R)

Initiate Payment (R)

Refund (R)

Initiate Payment (R)

Refund (R)

String (10)

AliPay Domestic Services Using the Simple Order API

October 2015

Appendix A

API Fields

Reply Fields

Table 7 Reply Fields for the Simple Order API

Field Name Description Returned By

apCheckStatusReply_ reasonCode apCheckStatusReply_ reconciliationID apCheckStatusReply_ paymentStatus

Numeric value corresponding to the result of the

apCheckStatusService_run

request. See

"Reason Codes," page 27

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 ).

Description of the payment status. Possible values:



PENDING: Payment has not been processed.



COMPLETED: Payment is complete.



ABANDONED: Customer cancelled the payment. apCheckStatusReply_ processorTransactionID

AliPay unique identification for the check status service request. apInitiateReply_ merchantURL Redirect URL to the AliPay web site to confirm the transaction.

See "Merchant URL

Parameters," page 9 .

apInitiateReply_reasonCode Numeric value corresponding to the result of the

apInitiateService_run

request. 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 ).

Check Status

Initiate Payment

Data Type &

Length

Integer (5)

String (32)

String (15)

String (28)

Integer (5)

String (32)

AliPay Domestic Services Using the Simple Order API

October 2015

Appendix A

API Fields

Table 7 Reply Fields for the Simple Order API (Continued)

Field Name Description Returned By

decision merchantReferenceCode reasonCode request_id purchaseTotals_currency apRefundReply_returnRef apRefundReply_reasonCode apRefundReply_ reconciliationID apRefundReply_dateTime

One-word description of the request result.

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 ).

Numeric value corresponding to the result of the request. See

"Reason Codes," page 27

Initiate Payment

Check Status

Refund