Example Secure Payment APIs

Account APIs

Example Secure Payment APIs Security: Encrypted Data

The Example Secure Payment APIs protect all HTTPS Request and Response data according to PCI and PII standards with the AES-GCM encryption external link icon (Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM) as a Transport Layer Security (TLS) authenticated encryption operation). Please see the Protocol Rules "AES-GCM encrypted request and response data" section for these and other Example Secure Payment API security-related details.

The APIs are listed with their Common Names followed by their (CodeNames).

Click a topic to expand/collapse it.

DELETECancel User's Payment Information `(CancelPaymentInfoByOrderId)`

Description

A server can invoke this action to delete a user's payment information.

Endpoint url

DELETE /account/{uuid}/orders/{orderId}

HTTPS Request data: Parameters

Note: M/O = Mandatory or Optional; Size = number of characters

Parameter Type Size M/O Description

uuid String 36 M User’s unique identification

orderId String 36 M A unique order ID for payment info used in a reference request.

HTTPS Response data: JSON Properties

JSON Property Type Size Description

orderId String 36 Unique OrderId for payment info used in a reference request.

HTTPS Request example: CancelPaymentInfoByOrderId [DELETE method]
account/2303135303932343135303
63231336263383630333332313836e14946e58b0485ae4ab000557942caa75e8
4708a6123/orders/23031353039323431353036323133626338363033333231
3836e14946e58b0485ae4ab000557942caa75e84708a6123
Encrypting Data and HTTPS Request [DELETE method]
DELETE
http(s)://{host}/account/230313530393234313530363231336263383630
333332313836e14946e58b0485ae4ab000557942caa75e84708a6123/orders/
230313530393234313530363231336263383630333332313836e14946e58b048
5ae4ab000557942caa75e84708a6123
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634636132313438818b824cf62
c2d63feba0314c8b6cd3b328c2f02380787406779be1607fa68363bf1fbac60
a1b691de2f283ee2370f04f479287589b712576357c3256a2ba87f9c24d5948
bb91dd13211ed9e452247603a75b5f5672f6718242e78baf48524182e5f35ff
a58874f3692f9ca9011d84d70e8f74dad430bf8a58c8330fb0927e6048db45e
3b18544a2d780e005903a668bbfba9fa7f0b5522ba0719c4e643c9fea11563f
bd62d594c459d825f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e30684fa98c2b6ddf3
e06392bcbe41b80d107790ea58cc5b521156264ac9051b1b4aed931f9ba5b2b
be7e12b62de036f7cd1fb328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK
{
  “data”: {
    “orderId”: “272d11bc-72d2-4ec2-99f8-1374daec3535”
  }
}
Failed Response
HTTPS STATUS CODE : 400 Not Found
{
  "error": {
    "code": 903,
    "message": "This account payment information does not exist",
    "detail": null
  }
}
Return to top

Parameter	Type	Size	M/O	Description
uuid	String	36	M	User’s unique identification
orderId	String	36	M	A unique order ID for payment info used in a reference request.

JSON Property	Type	Size	Description
orderId	String	36	Unique OrderId for payment info used in a reference request.

POSTCreate User's Payment Information `(CreatePaymentInfo)`

Description

A server can invoke this action to create a user's payment information.

Endpoint url

POST /account/{uuid}/paymentinfo

HTTPS Request data: Parameters

Note: M/O = Mandatory or Optional; Size = number of characters

Parameter Type Size M/O Description

uuid String 36 M User’s unique identification

udid String 50 M User’s device identification.

orderId String 36 M A unique order ID.

billingInfo Object N/A M Billing Information Object

firstName String 50 M User’s First Name

lastName String 50 M User’s Last Name

middleInitial String 50 O User’s Middle Name

dateOfBirth String 8 M User's date of birth. Format = "YYYYMMDD"
Example: "19870704"

phoneNumber String 20 M User's phone number.

emailAddress String 200 M User’s Email Address

addressInfo Object N/A M Address Information Object

street String 256 M Street address

street2 String 50 O Detailed Street address

city String 50 M City

state String 50 O For United States and Canada, 2-Characters state code should be sent.
Other countries have no restrictions.
ISO 3166-2:US
ISO 3166-2:CA

postalCode String 20 M Postal code

countryCode String 2 M Country code ("GB"): ISO 3166-2

paymentInfo Object N/A M Payment Information Object

paymentType String 50 M Payment Type: "CreditCard"

isDefault Boolean 1 O Indicates if a user has made this the default payment method: true or false.

card Object N/A M Card Information Object

cardNum String 16 M Card Number

cardExpYear String 4 M Card Expiry Year

cardExpMonth String 2 M Card Expiry Month

cardCVVToken String 20 M SAKA Token for decryption
Card Verification Value

cardHolder String 50 M Card Holder

cardNickName String 20 O Card Nick Name

accessCountryCode String 2 M User's access country code based on GEO IP: ISO 3166-2

ipAddress String 50 M User's IP Address

HTTPS Response data: JSON Properties

JSON Property Type Size Description

uuid String 36 User’s Unique ID

paymentInfoID String 36 Payment Information ID

registeredDate String 20 Registration Date based on UTC "MM/dd/yyyy HH:mm:ss" format.
Example: "12/11/2015 10:01:01"

HTTPS Request example: CreatePaymentInfo [POST method]
{
  "orderId": "251153cb-de49-4afb-9fb5-acb33e332b26",
  "udid": "2083718938012321038243",
  "billingInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth":"19870704",
    "phoneNumber":"1234567890",
    "emailAddress": "abc@xyz.com",
    "addressInfo": {
      "street": "18th Floore Prtlan House",
	    "street2": "Bressenden Place",
      "city": "Victoria",
      "state": "London",
      "postalCode": "SW1E 5RS",
      "countryCode": "GB"
    }
  },
  "paymentInfo": {
    "paymentType": "CreditCard",
    "isDefault": true,
    "card": {
      "cardNum": "4111111111111111",
      "cardExpYear": "2018",
      "cardExpMonth": "08",
      "cardHolder": "John Doe",
      "cardNickName": "Card1",
      "cardCvvToken": "1000000000000016"
    }
  },
  "accessCountryCode": "GB",
  "ipAddress": "127.0.0.1"
}
Encrypting Data and HTTPS Request [POST method]
POST
http(s)://{host}/account/323031363034323831363432343563306334383
53933386466644aa448bc71a97b5267514c0b4c0ad7d54463f3a44f913391af5
320bb01f188a11b501cf5ffd075ffb1278f1c3a3d8ccc9b934b1b/paymentinfo
 
"Content-Type: application/x-www-form-urlencoded"
"Authorization: PLTOKEN {TOKEN}"
 
data=
3230313530393234313530363231336263383630333332313836e14946e58b04
85ae4ab000557942caa75e84708a6123ac21a9945845a07d557a6bee23a9b01d
b139e3d5895bae320476cc665ac7b5864baeab3a806570b5e4f9b2ba8a408576
43913f93e6534753ab08be5815a0d170d0f679a3c3d838ae885e80f01f40bd45
a0d506858e6c97ca0e55d0aa565c79b3a5e34ab81c4e7c9b754557231be0760e
8041eb7cbba8a0e9db51a93c99917e39cf1cda93412b1c20795ce171e9b9e316
006cb7830085b0434eb2c90a12d749f975c09f3fe7ccc11242c7452edb5325ba
a9a852298ab059d40e09a3b653e64c953adddf04f6761747d66827820035c584
52c2fa9c72af00a7caa79a1d39ca467acc7dd05b58ed2f36ca02f20fd4523fcc
84361ff7f7cd81985ff283f71cbd4cae958e6055a127cba408b23d3bee884e04
a986eb94a943442f428e4daa207af947d3a03faa77f47b2ca7f06382af36567e
3cb6ead4f19ffdfc850111971e78b68453abea1aa650a2eacf00505dbc84c1b6
aa2b2c1f9814bb34997e8e13906810ea92533c823df4a2ebfd4fcf7683328b45
2a360736fd65d5d1ddad22466078bd74aa9705e7b58e58a846ccb46b9fa9ea81
06a6b520f596bc44407541d8bfbc54f95797895e758076864502aef033b7223d
b03ad35d0d1934d67e18dd58a0fba2da2a323bae7fc971829eb68edfc69e0ae8
73cd1df8099509
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634636132313438818b824cf62
c2d63feba0314c8b6cd3b328c2f02380787406779be1607fa68363bf1fbac60
a1b691de2f283ee2370f04f479287589b712576357c3256a2ba87f9c24d5948
bb91dd13211ed9e452247603a75b5f5672f6718242e78baf48524182e5f35ff
a58874f3692f9ca9011d84d70e8f74dad430bf8a58c8330fb0927e6048db45e
3b18544a2d780e005903a668bbfba9fa7f0b5522ba0719c4e643c9fea11563f
bd62d594c459d825f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e30684fa98c2b6ddf3
e06392bcbe41b80d107790ea58cc5b521156264ac9051b1b4aed931f9ba5b2b
be7e12b62de036f7cd1fb328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK
{
  "data": {
    "uuid": "2a50a2e4-a93a-4823-9674-c63aba792325",
    "paymentInfoId": "91534985-ff82-42dc-aebe-72484455f47e",
    "registeredDate": "04/25/2016 04:25:28"
  }
}
Failed Response
HTTPS STATUS CODE : 500 Internal Server Error
{
  "error": {
    "code": 933,
    "message": "Failed to create payment information.",
    "detail": "[23] Invalid credit card information. Please re-enter. (Invalid account number)"
  }
}
Return to top

Parameter	Type	Size	M/O	Description
uuid	String	36	M	User’s unique identification
udid	String	50	M	User’s device identification.
orderId	String	36	M	A unique order ID.
billingInfo	Object	N/A	M	Billing Information Object
firstName	String	50	M	User’s First Name
lastName	String	50	M	User’s Last Name
middleInitial	String	50	O	User’s Middle Name
dateOfBirth	String	8	M	User's date of birth. Format = "YYYYMMDD" Example: "19870704"
phoneNumber	String	20	M	User's phone number.
emailAddress	String	200	M	User’s Email Address
addressInfo	Object	N/A	M	Address Information Object
street	String	256	M	Street address
street2	String	50	O	Detailed Street address
city	String	50	M	City
state	String	50	O	For United States and Canada, 2-Characters state code should be sent. Other countries have no restrictions. ISO 3166-2:US ISO 3166-2:CA
postalCode	String	20	M	Postal code
countryCode	String	2	M	Country code ("GB"): ISO 3166-2
paymentInfo	Object	N/A	M	Payment Information Object
paymentType	String	50	M	Payment Type: "CreditCard"
isDefault	Boolean	1	O	Indicates if a user has made this the default payment method: true or false.
card	Object	N/A	M	Card Information Object
cardNum	String	16	M	Card Number
cardExpYear	String	4	M	Card Expiry Year
cardExpMonth	String	2	M	Card Expiry Month
cardCVVToken	String	20	M	SAKA Token for decryption Card Verification Value
cardHolder	String	50	M	Card Holder
cardNickName	String	20	O	Card Nick Name
accessCountryCode	String	2	M	User's access country code based on GEO IP: ISO 3166-2
ipAddress	String	50	M	User's IP Address

JSON Property	Type	Size	Description
uuid	String	36	User’s Unique ID
paymentInfoID	String	36	Payment Information ID
registeredDate	String	20	Registration Date based on UTC "MM/dd/yyyy HH:mm:ss" format. Example: "12/11/2015 10:01:01"

PUTUpdate User's Payment Information `(UpdatePaymentInfo)`

Description

A server can invoke this action to update a user's payment information.

Endpoint url

/account/{uuid}/paymentinfo/{paymentInfoId}

HTTPS Method

PUT

HTTPS Request data: Parameters

Note: M/O = Mandatory or Optional; Size = number of characters

Parameter Type Size M/O Description

uuid String 36 M Encrypted user's unique ID.

udid String 50 M User’s device identification.

paymentInfoId String N/A M Encrypted user's unique payment information ID.

orderId String 36 M A unique order ID.

billingInfo Object N/A M Billing Information Object

firstName String 50 M User’s First Name

lastName String 50 M User’s Last Name

middleInitial String 50 O User’s Middle Name

dateOfBirth String 8 M User's date of birth. Format = "YYYYMMDD"
Example: "19870704"

phoneNumber String 20 M User's phone number.

emailAddress String 200 M User’s Email Address.

addressInfo Object N/A M Address Information Object.

street String 256 M Street address.

street2 String 50 O Detailed Street address

city String 50 M City

state String 50 O For United States and Canada, 2-Characters state code should be sent.
Other countries have no restrictions.
ISO 3166-2:US
ISO 3166-2:CA

postalCode String 20 M Postal code

countryCode String 2 M Country code ("GB"): ISO 3166-2

paymentInfo Object N/A M Payment Information Object

paymentType String 50 M Payment Type: "CreditCard"

isDefault Boolean 1 O Indicates if a user has made this the default payment method: true or false.

card Object N/A M Card Information Object.

cardExpYear String 4 M Card Expiry Year.

cardExpMonth String 2 M Card Expiry Month.

cardCVVToken String 20 M SAKA Token for decryption of the Card Verification Value.

cardHolder String 50 M Card Holder

cardNickName String 20 O Card Nick Name

accessCountryCode String 2 M User's access country code based on GEO IP. See ISO 3166-2

ipAddress String 50 M User's IP Address

HTTPS Response data: JSON Properties

JSON Property Type Size Description

uuid String 200 User’s Unique ID

paymentInfoID String 36 Payment Information ID

status String 20 Status of payment information: "ACTIVE", "INACTIVE", "FRAUD"

updatedDate String 20 Updated Date based on UTC "MM/dd/yyyy HH:mm:ss" format.
For example: "12/11/2015 10:01:01"

HTTPS Request example: UpdatePaymentInfo [PUT method]
{
  "orderId": "4e260748-60d6-4985-80da-bfdf481bffdf",
  "udid": "2083718938012321038243",
  "billingInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth":"19870704",
    "phoneNumber":"1234567890",
    "emailAddress": "abc@xyz.com",
    "addressInfo": {
      "street": "18th Floore Prtlan House",
      "street2": "Bressenden Place",
      "city": "Victoria",
      "state": "London",
      "postalCode": "SW1E 5RS",
      "countryCode": "GB"
    }
  },
  "paymentInfo": {
    "paymentType": "CreditCard",
    "isDefault": false,
    "card": {
      "cardExpYear": "2018",
      "cardExpMonth": "08",
      "cardHolder": "John Doe",
      "cardNickName": "Card1",
      "cardCvvToken": "1000000000000016"
    }
  },
  "accessCountryCode": "GB",
  "ipAddress": "127.0.0.1"
}
Encrypting Data and HTTPS Request [PUT method]
PUT
http(s)://{host}/account/230313530393234
313530363231336263383630333332313836e149
46e58b0485ae4ab000557942caa75e84708a6123
/paymentinfo/230313530393234313530363231
336263383630333332313836e14946e58b0485ae
4ab000557942caa75e84708a6123
 
"Content-Type: application/x-www-form-urlencoded"
"Authorization: PLTOKEN {TOKEN}"
 
data=
3230313530393234313530363231336263383630
333332313836e14946e58b0485ae4ab000557942
caa75e84708a6123ac21a9945845a07d557a6bee
23a9b01db139e3d5895bae320476cc665ac7b586
4baeab3a806570b5e4f9b2ba8a40857643913f93
e6534753ab08be5815a0d170d0f679a3c3d838ae
885e80f01f40bd45a0d506858e6c97ca0e55d0aa
565c79b3a5e34ab81c4e7c9b754557231be0760e
8041eb7cbba8a0e9db51a93c99917e39cf1cda93
412b1c20795ce171e9b9e316006cb7830085b043
4eb2c90a12d749f975c09f3fe7ccc11242c7452e
db5325baa9a852298ab059d40e09a3b653e64c95
3adddf04f6761747d66827820035c58452c2fa9c
72af00a7caa79a1d39ca467acc7dd05b58ed2f36
ca02f20fd4523fcc84361ff7f7cd81985ff283f7
1cbd4cae958e6055a127cba408b23d3bee884e04
a986eb94a943442f428e4daa207af947d3a03faa
77f47b2ca7f06382af36567e3cb6ead4f19ffdfc
850111971e78b68453abea1aa650a2eacf00505d
bc84c1b6aa2b2c1f9814bb34997e8e13906810ea
92533c823df4a2ebfd4fcf7683328b452a360736
fd65d5d1ddad22466078bd74aa9705e7b58e58a8
46ccb46b9fa9ea8106a6b520f596bc44407541d8
bfbc54f95797895e758076864502aef033b7223d
b03ad35d0d1934d67e18dd58a0fba2da2a323bae
7fc971829eb68edfc69e0ae873cd1df8099509
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634
636132313438818b824cf62c2d63feba0314c8b6
cd3b328c2f02380787406779be1607fa68363bf1
fbac60a1b691de2f283ee2370f04f479287589b7
12576357c3256a2ba87f9c24d5948bb91dd13211
ed9e452247603a75b5f5672f6718242e78baf485
24182e5f35ffa58874f3692f9ca9011d84d70e8f
74dad430bf8a58c8330fb0927e6048db45e3b185
44a2d780e005903a668bbfba9fa7f0b5522ba071
9c4e643c9fea11563fbd62d594c459d825f96ef5
3ed81aab2ec6a0657288c799e418e7e2d0451ca5
235a0d7dde3fe13f31cd6e7bd46470a58c2cb737
2587b8e30684fa98c2b6ddf3e06392bcbe41b80d
107790ea58cc5b521156264ac9051b1b4aed931f
9ba5b2bbe7e12b62de036f7cd1fb328bfe80c878
1a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK
{
  "data": {
    "uuid": "89396B99-5A57-4ECA-96C9-60ED109F8C8A",
    "paymentInfoId": "49660FF3-8D52-4641-9770-FDD199E1CD18",
    "status": "ACTIVE",
    "updatedDate": "12/11/2015 10:01:01"
  }
}
Failed Response
HTTPS STATUS CODE : 500 Internal Server Error
{
  "error": {
    "code": 975,
    "message": "An unexpected error occurred during update payment information. Please try again.",
    "detail": "Cannot authorize this card information."
  }
}
Return to top

Parameter	Type	Size	M/O	Description
uuid	String	36	M	Encrypted user's unique ID.
udid	String	50	M	User’s device identification.
paymentInfoId	String	N/A	M	Encrypted user's unique payment information ID.
orderId	String	36	M	A unique order ID.
billingInfo	Object	N/A	M	Billing Information Object
firstName	String	50	M	User’s First Name
lastName	String	50	M	User’s Last Name
middleInitial	String	50	O	User’s Middle Name
dateOfBirth	String	8	M	User's date of birth. Format = "YYYYMMDD" Example: "19870704"
phoneNumber	String	20	M	User's phone number.
emailAddress	String	200	M	User’s Email Address.
addressInfo	Object	N/A	M	Address Information Object.
street	String	256	M	Street address.
street2	String	50	O	Detailed Street address
city	String	50	M	City
state	String	50	O	For United States and Canada, 2-Characters state code should be sent. Other countries have no restrictions. ISO 3166-2:US ISO 3166-2:CA
postalCode	String	20	M	Postal code
countryCode	String	2	M	Country code ("GB"): ISO 3166-2
paymentInfo	Object	N/A	M	Payment Information Object
paymentType	String	50	M	Payment Type: "CreditCard"
isDefault	Boolean	1	O	Indicates if a user has made this the default payment method: true or false.
card	Object	N/A	M	Card Information Object.
cardExpYear	String	4	M	Card Expiry Year.
cardExpMonth	String	2	M	Card Expiry Month.
cardCVVToken	String	20	M	SAKA Token for decryption of the Card Verification Value.
cardHolder	String	50	M	Card Holder
cardNickName	String	20	O	Card Nick Name
accessCountryCode	String	2	M	User's access country code based on GEO IP. See ISO 3166-2
ipAddress	String	50	M	User's IP Address

JSON Property	Type	Size	Description
uuid	String	200	User’s Unique ID
paymentInfoID	String	36	Payment Information ID
status	String	20	Status of payment information: "ACTIVE", "INACTIVE", "FRAUD"
updatedDate	String	20	Updated Date based on UTC "MM/dd/yyyy HH:mm:ss" format. For example: "12/11/2015 10:01:01"

DELETEDelete User's Payment Information `(DeletePaymentInfo)`

Description

A server can invoke this action to delete a user's payment information.

Endpoint url

/account/{uuid}/paymentinfo/{paymentInfoId}

HTTPS Method

DELETE

HTTPS Request data: Parameters

Note: M/O = Mandatory or Optional; Size = number of characters

Parameter Type Size M/O Description

uuid String N/A M Encrypted user's unique ID

paymentInfoId String N/A M Encrypted user's unique payment information ID

HTTPS Response data: JSON Properties

JSON Property Type Size Description

uuid String 36 User's unique ID.

HTTPS Request example: DeletePaymentInfo [DELETE method]
account/
230313530393234313530363231336263383630333
332313836e14946e58b0485ae4ab000557942caa75
e84708a6123/paymentinfo/230313530393234313
530363231336263383630333332313836e14946e58
b0485ae4ab000557942caa75e84708a6123
Encrypting Data and HTTPS Request [DELETE method]
DELETE
https://{host}/account/2303135303932343135303632
31336263383630333332313836e14946e58b0485ae4ab000
557942caa75e84708a6123/paymentinfo/2303135303932
34313530363231336263383630333332313836e14946e58b
0485ae4ab000557942caa75e84708a6123
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634
636132313438818b824cf62c2d63feba0314c8b6
cd3b328c2f02380787406779be1607fa68363bf1
fbac60a1b691de2f283ee2370f04f479287589b7
12576357c3256a2ba87f9c24d5948bb91dd13211
ed9e452247603a75b5f5672f6718242e78baf485
24182e5f35ffa58874f3692f9ca9011d84d70e8f
74dad430bf8a58c8330fb0927e6048db45e3b185
44a2d780e005903a668bbfba9fa7f0b5522ba071
9c4e643c9fea11563fbd62d594c459d825f96ef5
3ed81aab2ec6a0657288c799e418e7e2d0451ca5
235a0d7dde3fe13f31cd6e7bd46470a58c2cb737
2587b8e30684fa98c2b6ddf3e06392bcbe41b80d
107790ea58cc5b521156264ac9051b1b4aed931f
9ba5b2bbe7e12b62de036f7cd1fb328bfe80c878
1a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK
{
  "data": {
    "uuid": "272d11bc-72d2-4ec2-99f8-1374daec3535"
  }
}
Failed Response
HTTPS STATUS CODE : 404 Not Found
{
  "error": {
    "code": 903,
    "message": "This account payment information does not exist",
    "detail": null
  }
}
Return to top

Parameter	Type	Size	M/O	Description
uuid	String	N/A	M	Encrypted user's unique ID
paymentInfoId	String	N/A	M	Encrypted user's unique payment information ID

JSON Property	Type	Size	Description
uuid	String	36	User's unique ID.

GETGet User's Payment Information List `(GetPaymentInfo)`

Description

A server can invoke this action to get the list of a user's payment information.

Endpoint url

/account/{uuid}/paymentinfo

HTTPS Method

GET

HTTPS Request data: Parameters

Note: M/O = Mandatory or Optional; Size = number of characters

Parameter Type Size M/O Description

uuid String 200 M Encrypted user's unique ID

HTTPS Response data: JSON Properties

JSON Property Type Size Description

uuid String 36 User’s Unique ID

totalCount Integer 4 Total Count

paymentInfos Array (Object) N/A Array of Payment Information object

paymentInfoId String 36 Payment Information ID

status String 20 Status of Payment Information: "ACTIVE", "INACTIVE", "FRAUD"

paymentInfo Array (Object) N/A Payment Information Object

paymentType String 50 Payment type: "CreditCard"

HTTPS Request example: GetPaymentInfo [GET method]
/account
/323031353039323431353036323133626338363033
3332313836e14946e58b0485ae4ab000557942caa75
e84708a6123a/paymentinfo
Encrypting Data and HTTPS Request [GET method]
GET
https://{host}/account/230313530393234313530
363231336263383630333332313836e14946e58b048
5ae4ab000557942caa75e84708a6123/paymentinfo
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634
636132313438818b824cf62c2d63feba0314c8b6
cd3b328c2f02380787406779be1607fa68363bf1
fbac60a1b691de2f283ee2370f04f479287589b7
12576357c3256a2ba87f9c24d5948bb91dd13211
ed9e452247603a75b5f5672f6718242e78baf485
24182e5f35ffa58874f3692f9ca9011d84d70e8f
74dad430bf8a58c8330fb0927e6048db45e3b185
44a2d780e005903a668bbfba9fa7f0b5522ba071
9c4e643c9fea11563fbd62d594c459d825f96ef5
3ed81aab2ec6a0657288c799e418e7e2d0451ca5
235a0d7dde3fe13f31cd6e7bd46470a58c2cb737
2587b8e30684fa98c2b6ddf3e06392bcbe41b80d
107790ea58cc5b521156264ac9051b1b4aed931f
9ba5b2bbe7e12b62de036f7cd1fb328bfe80c878
1a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK
{
  "data": {
    "uuid": "dc79042f-321e-42df-9e12-25fc2a4a8f1a",
    "totalCount": 3,
    "paymentInfos": [
    {
      "paymentInfoId": "bca80e4a-737d-48e2-afb0-86031a0af886",
      "status": "ACTIVE",
      "paymentInfo": {
        "paymentType": "CreditCard"
      }
    },
    {
    "paymentInfoId": "8bae8471-0785-4c39-b016-086f8d54d58a",
    "status": "ACTIVE",
    "paymentInfo": {
      "paymentType": "CreditCard"
    }
    },
    {
    "paymentInfoId": "7eb5db22-c716-46f6-95d1-f54dc63fa3e1",
    "status": "ACTIVE",
    "paymentInfo": {
      "paymentType": "CreditCard"
    }
   }
  ]
 }
}
Failed Response
HTTPS STATUS CODE : 404 Not Found
{
  "error": {
    "code": 903,
    "message": "This account's payment information does not exist",
    "detail": null
  }
}
Return to top

Parameter	Type	Size	M/O	Description
uuid	String	200	M	Encrypted user's unique ID

JSON Property	Type	Size	Description
uuid	String	36	User’s Unique ID
totalCount	Integer	4	Total Count
paymentInfos	Array (Object)	N/A	Array of Payment Information object
paymentInfoId	String	36	Payment Information ID
status	String	20	Status of Payment Information: "ACTIVE", "INACTIVE", "FRAUD"
paymentInfo	Array (Object)	N/A	Payment Information Object
paymentType	String	50	Payment type: "CreditCard"

GETGet User's Payment Information by paymentInfoID `(GetPaymentinfoByPaymentInfoID)`

Description

A server can invoke this action to get specific payment information by uuid and paymentInfoID.

Endpoint url

/account/{uuid}/paymentinfo/{paymentinfoId}

HTTPS Method

GET

HTTPS Request data: Parameters

Note: M/O = Mandatory or Optional; Size = number of characters

Parameter Type Size M/O Description

uuid String N/A M Encrypted user's unique ID.

paymentInfoId String N/A M Encrypted user's unique payment information ID.

HTTPS Response data: JSON Properties

JSON Property Type Size Description

uuid String 36 User's unique ID.

paymentInfoID String 36 Payment Information ID

status String 20 Status of Payment Information: "ACTIVE", "INACTIVE", "FRAUD"

billingInfo Object N/A Billing Information Object

firstName String 50 User’s First Name

lastName String 50 User’s Last Name

middleInitial String 50 User’s Middle Name

dateOfBirth String 8 User's date of birth. Format = "YYYYMMDD"
Example: "19870704"

phoneNumber String 20 User's phone number.

emailAddress String 200 User’s Email Address

addressInfo Object N/A Address Information Object

street String 256 Street address

street2 String 50 Detailed Street address

city String 50 City

state String 50 For United States and Canada, 2-Characters state code should be sent.
Other countries have no restrictions.
ISO 3166-2:US
ISO 3166-2:CA

postalCode String 20 Postal code

countryCode String 2 Country code ("GB"): ISO 3166-2

paymentInfo Array (Object) N/A Payment Information object.

paymentType String 50 Payment Type: "CreditCard".

card Object N/A Card Information object.

cardNum String 16 The card number.

cardBrand String 50 The card brand.

cardLastNum String 4 Last 4 digits of the card number.

cardExpYear String 4 Card Expiry Year.

cardExpMonth String 2 Card Expiry Month.

cardHolder String 50 Card Holder.

HTTPS Request example: GetPaymentInfo [GET method]
/account/b7f7ea57-6503-4b5b-9f64-c437f0f78563
/paymentinfo/a55a3851-8a62-48f6-b9bb-91a853ac97b5
Encrypting Data and HTTPS Request [GET method]
GET
https://{host}/account/323031353039323431353039343262346
6336434363931636134991a219bba46116e3deecfe485f650a558f86
1cafb503295930eccc7ce11b99f57524ef67713f45582a5eb07e9fe8
f1d9e19c933/paymentinfo/32303135303932343135303934326234
66336434363931636134991a219bba46116e3deecfe485f650a558f8
61cafb50295930eccc7ce11b99f57524ef67713f45582a
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634
636132313438818b824cf62c2d63feba0314c8b6
cd3b328c2f02380787406779be1607fa68363bf1
fbac60a1b691de2f283ee2370f04f479287589b7
12576357c3256a2ba87f9c24d5948bb91dd13211
ed9e452247603a75b5f5672f6718242e78baf485
24182e5f35ffa58874f3692f9ca9011d84d70e8f
74dad430bf8a58c8330fb0927e6048db45e3b185
44a2d780e005903a668bbfba9fa7f0b5522ba071
9c4e643c9fea11563fbd62d594c459d825f96ef5
3ed81aab2ec6a0657288c799e418e7e2d0451ca5
235a0d7dde3fe13f31cd6e7bd46470a58c2cb737
2587b8e30684fa98c2b6ddf3e06392bcbe41b80d
107790ea58cc5b521156264ac9051b1b4aed931f
9ba5b2bbe7e12b62de036f7cd1fb328bfe80c878
1a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK
{
  "data": {
    "uuid": "2a50a2e4-a93a-4823-9674-c63aba792325",
    "paymentInfoId": "28da53f2-e8d2-49e2-b63c-31e2d21dd343",
    "status": "ACTIVE",
    "billingInfo": {
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth":"19870704",
      "phoneNumber":"1234567890",
      "emailAddress": "abc@xyz.com",
      "addressInfo": {
        "street": "18th Floore Prtlan House",
        "street2": "Bressenden Place",
        "city": "Victoria",
        "state": "London",
        "postalCode": "SW1E 5RS",
        "countryCode": "GB"
      }
    },
    "paymentInfo": {
      "paymentType": "CreditCard",
      "card": {
        "cardNum": "4111111111111111",
        "cardExpYear": "2018",
        "cardExpMonth": "08",
        "cardHolder": "John Doe",
        "cardNickName": "Card1",
        "cardBrand": "VPAY"
      }
    }
  }
}
Failed Response
HTTPS STATUS CODE : 404 Not Found
{
  "error": {
    "code": 903,
    "message": "This account's payment information does not exist.",
    "detail": null
  }
}
Return to top

Parameter	Type	Size	M/O	Description
uuid	String	N/A	M	Encrypted user's unique ID.
paymentInfoId	String	N/A	M	Encrypted user's unique payment information ID.

JSON Property	Type	Size	Description
uuid	String	36	User's unique ID.
paymentInfoID	String	36	Payment Information ID
status	String	20	Status of Payment Information: "ACTIVE", "INACTIVE", "FRAUD"
billingInfo	Object	N/A	Billing Information Object
firstName	String	50	User’s First Name
lastName	String	50	User’s Last Name
middleInitial	String	50	User’s Middle Name
dateOfBirth	String	8	User's date of birth. Format = "YYYYMMDD" Example: "19870704"
phoneNumber	String	20	User's phone number.
emailAddress	String	200	User’s Email Address
addressInfo	Object	N/A	Address Information Object
street	String	256	Street address
street2	String	50	Detailed Street address
city	String	50	City
state	String	50	For United States and Canada, 2-Characters state code should be sent. Other countries have no restrictions. ISO 3166-2:US ISO 3166-2:CA
postalCode	String	20	Postal code
countryCode	String	2	Country code ("GB"): ISO 3166-2
paymentInfo	Array (Object)	N/A	Payment Information object.
paymentType	String	50	Payment Type: "CreditCard".
card	Object	N/A	Card Information object.
cardNum	String	16	The card number.
cardBrand	String	50	The card brand.
cardLastNum	String	4	Last 4 digits of the card number.
cardExpYear	String	4	Card Expiry Year.
cardExpMonth	String	2	Card Expiry Month.
cardHolder	String	50	Card Holder.

GETGet User's Card Expiries `(GetCardExpiries)`

Description

A server can invoke this action to get a list of a user’s expired credit cards.

Endpoint url

/account/{uuid}/paymentinfo/expiries

HTTPS Method

GET

HTTPS Request data: Parameters

Note: M/O = Mandatory or Optional; Size = number of characters

Parameter Type Size M/O Description

uuid String N/A M Encrypted user's unique ID.

HTTPS Response data: JSON Properties

JSON Property Type Size Description

uuid String 36 User's Unique ID.

totalCount Integer 4 Total Count.

paymentInfos Array N/A Array of the Payment Information Object.

paymentInfoId String 36 Payment Information ID.

paymentInfo Object N/A Payment Information Object.

paymentType String 50 Payment type ("CreditCard")

card Object N/A Payment Information Object

cardExpYear String 4 Expired Date: Year (YYYY) format.
Example: "2020"

cardExpMonth String 2 Expired Date: Month (MM) format.
Example: "04"

HTTPS Request example: GetCardExpiries [GET method]
/account/3230313530393234313530363

231336263383630333332313836e14946e58b0
485ae4ab000557942caa75e84708a6123a/
paymentinfo/expiries
Encrypting Data and HTTPS Request [GET method]
GET
http(s)://{host}/account/32303135303932
343135303934326234663364343639316361349
91a219bba46116e3deecfe485f650a558f861ca
fb503295930eccc7ce11b99f57524ef67713f45
582a5eb07e9fe8f1d9e19c933/paymentinfo/
expiries
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634636132313438818b824cf62
c2d63feba0314c8b6cd3b328c2f02380787406779be1607fa68363bf1fbac60
a1b691de2f283ee2370f04f479287589b712576357c3256a2ba87f9c24d5948
bb91dd13211ed9e452247603a75b5f5672f6718242e78baf48524182e5f35ff
a58874f3692f9ca9011d84d70e8f74dad430bf8a58c8330fb0927e6048db45e
3b18544a2d780e005903a668bbfba9fa7f0b5522ba0719c4e643c9fea11563f
bd62d594c459d825f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e30684fa98c2b6ddf3
e06392bcbe41b80d107790ea58cc5b521156264ac9051b1b4aed931f9ba5b2b
be7e12b62de036f7cd1fb328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK
{
  "data": {
    "uuid": "dc79042f-321e-42df-9e12-25fc2a4a8f1a",
    "totalCount": 3,
    "paymentInfos": [
      {
        "paymentInfoId": "bca80e4a-737d-48e2-afb0-86031a0af886",
        "paymentInfo": {
          "paymentType": "CreditCard",
          "card": {
            "cardExpYear": "2019",
            "cardExpMonth": "08"
          }
        }
      },
      {
        "paymentInfoId": "8bae8471-0785-4c39-b016-086f8d54d58a",
        "paymentInfo": {
          "paymentType": "CreditCard",
          "card": {
            "cardExpYear": "2018",
            "cardExpMonth": "08"
          }
        }
      },
      {
        "paymentInfoId": "7eb5db22-c716-46f6-95d1-f54dc63fa3e1",
        "paymentInfo": {
          "paymentType": "CreditCard",
          "card": {
            "cardExpYear": "2018",
            "cardExpMonth": "08"
          }
        }
      }
    ]
  }
}
Failed Response
HTTPS STATUS CODE : 404Not Found
{
  "error": {
    "code": 903,
    "message": "This account payment information does not exist.",
    "detail": null
  }
}
Return to top

Parameter	Type	Size	M/O	Description
uuid	String	N/A	M	Encrypted user's unique ID.

JSON Property	Type	Size	Description
uuid	String	36	User's Unique ID.
totalCount	Integer	4	Total Count.
paymentInfos	Array	N/A	Array of the Payment Information Object.
paymentInfoId	String	36	Payment Information ID.
paymentInfo	Object	N/A	Payment Information Object.
paymentType	String	50	Payment type ("CreditCard")
card	Object	N/A	Payment Information Object
cardExpYear	String	4	Expired Date: Year (YYYY) format. Example: "2020"
cardExpMonth	String	2	Expired Date: Month (MM) format. Example: "04"

POSTReverify User's Payment Information `(ReVerifyPaymentInfo)`

Description

A server can invoke this action to re-verify payment information by uuid and paymentInfoID.

Endpoint url

/account/{uuid}/paymentinfo/{paymentinfoId}/verification

HTTPS Method

POST

HTTPS Request data: Parameters

Note: M/O = Mandatory or Optional; Size = number of characters

Parameter Type Size M/O Description

uuid String N/A M Encrypted user's unique ID

paymentInfoId String N/A M Encrypted user's unique payment information ID

orderId String 36 M A unique order ID.

udid String 50 M User's device identification.

paymentInfo Object N/A M Payment Information Object

paymentType String 50 M Payment Type: "Credit Card"

card Object N/A M Credit Information Object

cardCVVToken String 20 M SAKA Token for decryption
Card Verification Value

accessCountryCode String 2 M User's access country code based on GEO IP. See ISO 3166-2

ipAddress String 50 M IP Address

HTTPS Response data: JSON Properties

JSON Property Type Size Description

uuid String 200 User's Unique ID

paymentInfoId String 36 Payment Information ID

status String 20 Status of Payment Information: "ACTIVE", "INACTIVE", "FRAUD"

HTTPS Request example: ReVerifyPaymentInfo [POST method]
{
  "orderId": "f98a9325-89fb-4aa0-8ac9-30869b5f1a79",
  "udid": "2083718938012321038243",
  "paymentInfo": {
    "paymentType": "CreditCard",
    "card": {
      "cardCvvToken": "1000000000000183"
    }
  },
  "accessCountryCode": "KR",
  "ipAddress": "127.0.0.1"
}
Encrypting Data and HTTPS Request [POST method]
POST
http(s)://{host}/account/323031363034323
83136343234356330633438353933386466644aa
448bc71a97b5267514c0b4c0ad7d54463f3a44f9
13391af5320bb01f188a11b501cf5ffd075ffb12
78f1c3a3d8ccc9b934b1b/paymentinfo/323031
3630343238313634323435303438326131646634
363561d29d6dc31636226e97c39d92fb80621a63
8e39756a223b2f750216b05cf6eb5c9dde6b7611
b48cf47725b16e25a06041aed292c1/verification
 
"Content-Type: application/x-www-form-urlencoded"
"Authorization: PLTOKEN {TOKEN}"
 
data=
3230313630343238313634323435323639313839
6562623231325be9680a1f756a284c8899774b1f
b34ea880558f34f7f01b65ebb14cd1a48a958c23
a823ba826ebff80ef83fd832879114fa6101e8cb
2001f51ed56574836927de54aced12591c95ff9c
8eb11aca4478f0d4bd7534549e2c580136014e3c
92e3fe12deaa7a7344449e065dcd52eb413b369c
12db2e419c6de0d08b43ace48b95e85fa73f2fbc
a061e33842d6593697c85460b7ba0cfaf04dee3e
fcc77468461ccd4d03435236f5753ee3e4d5725a
e73bdb96f0e105
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634
636132313438818b824cf62c2d63feba0314c8b6
cd3b328c2f02380787406779be1607fa68363bf1
fbac60a1b691de2f283ee2370f04f479287589b7
12576357c3256a2ba87f9c24d5948bb91dd13211
ed9e452247603a75b5f5672f6718242e78baf485
24182e5f35ffa58874f3692f9ca9011d84d70e8f
74dad430bf8a58c8330fb0927e6048db45e3b185
44a2d780e005903a668bbfba9fa7f0b5522ba071
9c4e643c9fea11563fbd62d594c459d825f96ef5
3ed81aab2ec6a0657288c799e418e7e2d0451ca5
235a0d7dde3fe13f31cd6e7bd46470a58c2cb737
2587b8e30684fa98c2b6ddf3e06392bcbe41b80d
107790ea58cc5b521156264ac9051b1b4aed931f
9ba5b2bbe7e12b62de036f7cd1fb328bfe80c878
1a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK
{
  "data": {
    "uuid": "c3f7a09e-0ff8-4012-877f-8614fc570d42",
    "paymentInfoId": "f4fa63c9-473c-4d96-b173-b304c656b287",
    "status": "ACTIVE"
  }
}
Failed Response
HTTPS STATUS CODE : 404 Not Found
{
  "error": {
    "code": 906,
    "message": "cvv information does not exist.",
    "detail": null
  }
}
Return to top

JSON Property	Type	Size	Description
uuid	String	200	User's Unique ID
paymentInfoId	String	36	Payment Information ID
status	String	20	Status of Payment Information: "ACTIVE", "INACTIVE", "FRAUD"