Payment Order Checkout

service: checkoutOrder

Request a Payment Order Device Data for a given client.

bizContent Request Parameters

Field
Type
Required
Description
Remark

order_sn

String

Y

Merchant Order Number

linkID

String

Y

Payment Order ID

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

cardHolderName

String

Y

Card Holder Name.

Example:

Peter Pan

sessionCard

String

Y

SessionCard generated using Worldpay Checkout SDK.

Example: https://try.access.worldpay.com/verifiedTokens/sessions/eyJrIjoxLCJkIjoiVzJGUmIyeVdmRk1iOFp3ekdLRU5ZekxPQllYNXNpMGo3WjN3UGs1NmFneVpSWm1lbGR1bVBPYlM3ZGxycHFoSSJ9

sessionCvc

String

Y

sessionCvc generated using Worldpay Checkout SDK.

Example: https://try.access.worldpay.com/sessions/eyJrIjoxLCJkIjoiT2s3WVI3V29PZFB5K0tZdDFtVm41ZGRFb3ZYcnBQRk1DRkZRWkdVQmlDTGorYkt5djlweEdZWkNRSHBNRDVZemtBWFY3dmhSUStIdXkzdUpPajZKT1E9PSJ9

relationship

String

Y

Payer Relationship with the Recipient

Allowed values: BUSINESS_OWNER_SHAREHOLDER DIRECTOR_SENIOR_MANAGEMENT EMPLOYEE RELATIVE CUSTOMER FRIEND

bizContent Request Sample

{
  "order_sn": "ABC123456789",
  "linkID": "FCA35CEB-E03C-4E36-8EA7-009FF613B1B1",
  "cardHolderName": "Peter Pan",
  "sessionCard": "https://try.access.suncorptech.cn/verifiedTokens/sessions/eyJrIjoxLCJkIjoiVzJGUmIyeVdmRk1iOFp3ekdLRU5ZekxPQllYNXNpMGo3WjN3UGs1NmFneVpSWm1lbGR1bVBPYlM3ZGxycHFoSSJ9",
  "sessionCvc": "https://try.access.suncorptech.cn/sessions/eyJrIjoxLCJkIjoiT2s3WVI3V29PZFB5K0tZdDFtVm41ZGRFb3ZYcnBQRk1DRkZRWkdVQmlDTGorYkt5djlweEdZWkNRSHBNRDVZemtBWFY3dmhSUStIdXkzdUpPajZKT1E9PSJ9",
  "relationship": "CUSTOMER"
}

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 link

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

jwt

String

Y

A digitally signed token that contains additional details required for DDC. Expires in 10 minutes for both Try and Production.

url

String

Y

A POST action on the DDC form. Used to redirect to the issuers DDC page.

bin

String

Y

First six digits of the card number (Bank Identification Number), used as part of DDC. Returned if a token resource or card number is included in the request.

Last updated