Pay Order

service: payOrder

Request an Order payment for a given client.

bizContent Request Parameters

Field
Type
Required
Description
Remark

order_sn

String

Y

linkID

String

Y

Payment Order ID

Examples: FCA35CEB-E03C-4E36-8EA7-009FF613B1B1

transactionReference

String

Y

Transaction Reference obtained by Payment Order Checkout.

Example: 8e9dfeb7-7aa2-4da2-88d8-5e30ad4ef056

sessionId

String

Y

The session id obtained from Device Data Collection.

Example: 0_797c4992-0793-4034-846e-e63cb50a84fa

userAgent

String

Y

The user agent for the client browser.

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36

bizContent Request Sample

{
  "order_sn": "ABC123456789",
  "linkID": "FCA35CEB-E03C-4E36-8EA7-009FF613B1B1",
  "transactionReference": "8e9dfeb7-7aa2-4da2-88d8-5e30ad4ef056",
  "sessionId": "0_797c4992-0793-4034-846e-e63cb50a84fa",
  "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36"
}

bizContent Response Parameters

Field
Type
Required
Description
Remark

status

Integer

Y

Status of the response: 0 indicates success, -1 indicates failure.

errorCode

String

N

Application specific error code about any error that occurred during processing.

errorMessage

String

N

Error Description

data

Object

N

The actual data payload of the response, which can be of any JSON-compatible type

See Data Payload

Data Payload

Field
Type
Required
Description

outcome

String

Y

Payment Order Status

transactionReference

String

Y

Identifier for the payment

Example: 21F8E74C-64ED-4B0F-B403-27E1762F82C4

authentication

Object

N

See Authentication Data

challenge

Object

N

See Challenge Data

Authentication Data

Field
Type
Required
Description

version

String

Y

The version of 3DS used to process the transaction.

authenticationValue

String

Y

A cryptographic value that provides evidence of the outcome of a 3DS verification.

  • Visa - Cardholder Authentication Verification Value (CAVV)

  • Mastercard - Universal Cardholder Authentication Field (UCAF)

Used when authorizing a payment.

eci

String

Y

Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS authentication.

  • 02 or 05 - Fully Authenticated Transaction

  • 01 or 06 - Attempted Authentication Transaction

  • 00 or 07 - Non 3-D Secure Transaction

  • Mastercard - 02, 01, 00

  • Visa - 05, 06, 07

  • Amex - 05, 06, 07

  • JCB - 05, 06, 07

  • Diners - 05, 06, 07

You will need to use this when you are authorizing a payment.

transactionId

String

Y

A transaction identifier. If provided, you should use it as part of your payment authorization. If the authentication.version has a major version of:

  • 1 - value returned known as xid

  • 2 - value returned known as dsTransactionId

Challenge Data

Field
Type
Required
Description

reference

String

Y

url

String

Y

jwt

String

Y

payload

String

Y

Last updated