Billing 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 an API to expand/collapse it.

DELETECancel Transaction By Mobile Client OrderId (CancelTransactionByOrderId)

Description
A server can invoke this action to reject a transaction.
Endpoint url
/billing/{uuid}/orders/{orderId}
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 36 M User’s unique identification
orderId String 36 M Unique OrderId for a transaction by the client side.
Note: Should be the same as the Check Billing Transaction's orderId.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
orderId String 36 The unique OrderId for a transaction which is used in a reference deposit.
HTTPS Request example: CancelTransaction [DELETE method]
billing/32303136313030363139353331353063636462326536313062331addcf82a6c8c8ed14c61aaa402555576c6
73188b933bcc163dfc028be4556519d629cfaee9b78c6e5c3140252a782b29ce3abe0/transactions?data=32303136
31303036313935333135626134633630653537333335394a56918a7af6f732864da9ea7d18a37d5ea4b440e95ef4e
541d9ce99edb4980396370adb09673c756ecf0ab3dedad3d156dfdfa9d072f8df9a219e93a011472a7632dc0ff3344
e92155aace8e5ff4c164f2feae28acc6fec00099214aadf2be3f68b8f487a8a9f3b4e106eb3f93f44c3a653db22166679
5a5dd07d13a830
Encrypting Data and HTTPS Request [POST method]
DELETE
http(s)://{host}/billing/32303136313030363139353331353063636462326536313062331addcf82a6c8c8ed14c61a
aa402555576c673188b933bcc163dfc028be4556519d629cfaee9b78c6e5c3140252a782b29ce3abe0/transactions?
data=3230313631303036313935333135626134633630653537333335394a56918a7af6f732864da9ea7d18a37d5e
a4b440e95ef4e541d9ce99edb4980396370adb09673c756ecf0ab3dedad3d156dfdfa9d072f8df9a219e93a011472a
7632dc0ff3344e92155aace8e5ff4c164f2feae28acc6fec00099214aadf2be3f68b8f487a8a9f3b4e106eb3f93f44c3a6
53db221666795a5dd07d13a830
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "orderId": "139f0344-0641-4d9f-a47f-e695d05842a9"
  }
}
Failed Response [HTTPS + JSON]
HTTPS STATUS CODE : 500 Internal Server Error 
{
  "error": {
    "code": 947,
    "message": "Failed to reject payment.",
    "detail": Not existing payment request detail."
  }
}

Return to top

POSTCheck Billing Transaction (CheckTransaction)

Description
A server can invoke this action to check transaction information before creating a new billing transaction.
  • Important note: In the case of a card payment, if the card is enrolled 3DSecure it should proceed to the 3DSecure process.
  • Please refer to the 3DSecure topic, section "Integration 3D Secure".
Endpoint url
/billing/{uuid}/transactions/check
HTTPS Method
POST
HTTPS Request data: Parameters
Note: M/O/C = Mandatory, Optional, or Conditional; Size = number of characters
Parameter Type Size M/O Description
uuid String 36 M User’s unique identification.
udid String 50 M User’s unique device identification.
orderId String 36 M Unique OrderId for a transaction by the client side.
transaction Object N/A M Transaction Object.
    applicationId String 36 M Unique ID for a casino (application).
    applicationVersion String 10 M Casino (application) version.
    amount Double 8 M The requested amount.
    currencyCode String 3 M The currency code. See: ISO 4217 external link icon
    extCasinoUserId String N/A O Corresponds to a casino's user id.
    extCasinoTransId String N/A O Corresponds to a casino's transaction id.
    extCasinoPaymentGatewayId String N/A O Corresponds to a casino's wallet id.
    categoryNames Array of strings N/A M Category names of a casino, for example "Poker", "Bet"
    casinoId String 50 M UUID of a casino.
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.
existingFlag String 1 M Existing Payment Info ID or New Payment information.
"Y" = Existing
"N" = New payment information.
gps Object N/A O Client's GPS information.
    latitude String 10 O Latitude of the GPS. Example: "37.554738"
    longitude String 10 O Longitude of the GPS. Example: "126.970680"
existingFlag is "Y"
paymentInfoId String 1 C User's payment information.
paymentInfo Object N/A M Payment information object.
    paymentType String 50 M Payment type ("CreditCard").
    card Object N/A M Card Information Object.
        cardCVVToken String 20 M SAKA token for the decryption Card Verification Value.
existingFlag is "N"
saveFlag String 1 C Save user's payment information.
"Y" = Save.
"N" = Not save.
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 is "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 external link icon
ISO 3166-2:CA external link icon
        postalCode String 20 M Postal code.
        countryCode String 2 M Country code ("GB"). See ISO 3166-2 external link icon
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 / false | This attribute will only accept saveFlag=Y.
    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.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
refPLOrderId String 15 The unique Example OrderId reference for this transaction.
For example: "201606020000013".
threeDSecureFlag String 1 Determines if the 3DSecure process is required.
"Y" = Required.
"N" = Not required.
pspCode String 10 Payment Service Provider Codes:
  • "SCTD" : SecureTrading
  • "ECP" : E-Com Processing
threeDSecureFlag is "Y"
threeDSecure Object N/A 3DSecure information object.
    xid String 255 The unique identifier for the transaction, assigned by PSP.
    enrolled String 1 3DSecure enrolled Flag "Y" = Card is enrolled.
    acsUrl String 1024 The URL to be used in authenticating the card holder.
    md String 1024 The unique 3DSecure reference for this transaction.
Note: This will not return when the pspCode is "ECP".
    paReq String 2048 The 3D authentication request.
Note: This will not return when the pspCode is "ECP".
    termURL String 1024 The Example URL to be used for receiving 3DSecure result.
Note: This will not return when the pspCode is "ECP".
Example: Case 1. Request with an existing PaymentInfoID
CheckTransaction HTTPS POST Request (JSON) 
{
  "orderId": "3a400f7c-42b2-43e3-ab81-b925dd3daf8e",
  "existingFlag": "Y",
  "paymentInfoId": "7eb5db22-c716-46f6-95d1-f54dc63fa3e1",
  "paymentInfo": {
    "paymentType": "CreditCard",
    "card": {
      "cardCvvToken": "1000000000002735"
    }
  },
  "transaction": {
    "applicationId": "cf9e3205-6cb3-42be-9df4-c2f418b74f2e",
    "applicationVersion": "0.4",
    "amount": 10,
    "currencyCode": "GBP",
    "extCasinoUserId": "281e77d9-48b4-4e59-a346-b64b3e5fa186",
    "extCasinoTransId": "1033a712-ff5b-4c8e-bb14-7d37552ef3dd",
    "extCasinoPaymentGatewayId": "5c8fac58-2c9f-4a44-87cd-6841648f48dc",
    "casinoId": "af1a90c6-f7ff-47bf-af01-86e077c1d85b",
    "categortNames": [
      "Poker",
      "Casino"
    ]
  },
  "gps": {
    "latitude": "37.554738",
    "longitude": "126.970680"
  },
  "accessCountryCode": "KR",
  "ipAddress": "112.223.50.121"
}
Encrypting Data and HTTPS Request [POST method]
POST
http(s)://{host}/billing/323031363034323831363432
34356330633438353933386466644aa448bc71a97b5267514
c0b4c0ad7d54463f3a44f913391af5320bb01f188a11b501c
f5ffd075ffb1278f1c3a3d8ccc9b934b1b/transactions/
check
 
"Content-Type: application/x-www-form-urlencoded"
"Authorization: PLTOKEN {TOKEN}"
 
data=
3230313630343238313634323435323639313839656262323
1325be9680a1f756a284c8899774b1fb34ea880558f34f7f0
1b65ebb14cd1a48a958c23a823ba826ebff80ef83fd832879
114fa6101e8cb2001f51ed56574836927de54aced12591c95
ff9c8eb11aca4478f0d4bd7534549e2c580136014e3c92e3f
e12deaa7a7344449e065dcd52eb413b369c12db2e419c6de0
d08b43ace48b95e85fa73f2fbca061e33842d6593697c8546
0b7ba0cfaf04dee3efcc77468461ccd4d03435236f5753ee3
e4d5725ae73bdb96f0e1057534549e2c580136014e3c92e3f
e12deaa7a7344449e065dcd52eb413b369c12db2e419c6de0
d08b43ace48b95e85fa73f2fbca061e33842d6593697c8546
0b7ba0cfaf04dee3efcc77468461ccd4d03435236f5753ee3
e4d5725ae73bdb96f0e105
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
Note: In this case, the 3DSecure process is required (threeDSecureFlag="Y" && enrolled="Y"). 
HTTPS STATUS CODE : 200 OK
{
  "data": {
    "refPLOrderId": "201606020000013",
    "threeDSecureFlag": "Y",
    "threeDSecure": {
      "xid": "K0w1N3gvMGZiSk9wVmNkc3JEVUg=",
      "enrolled": "Y",
      "acsUrl": "https://webapp.securetrading.net/acs/visa.cgi",
      "MD":
"UEZOVVBqeE5SRDQ4VFVSSVBtRnBURk00WkVaTFZHRm5jMGxP
U1ZacVJuUTBOMUU5UFR3dlRVUklQanhoWTNOVmNtdythSFIwY
0hNNkx5OTNaV0poY0hBdWMyVmpkWEpsZEhKaFpHbHVaeTV1Wl
hRdllXTnpMM1pwYzJFdVkyZHBQQzloWTNOVmNtdytQSEJoYmt
4bGJtZDBhRDR4Tmp3dmNHRnVUR1Z1WjNSb1BqeHRaWE56WVdk
bFNXUStVRUZTWlhFdE1UUTJORGcwTlRZeE9UY3hNeTB4TWpBN
U9USTBNVFEzUEM5dFpYTnpZV2RsU1dRK1BDOU5SRDQ4TDFOVV
BnPT06bWRXUW5CVFd3bEhEZC9xbXNBOFFmaDlSWUk5RjJ4clo
rZmt2Z2VKMmNqVHN3PQ==",
      "paReq":
"eJxVUttuwjAM/RXEOzhpCrTIRIIxbWwCobHxsLeSWlDRFkhT
YH+/pJRbnnx8O/Zx8HujicYLUqUmiVMqimhNjSQeNOfDLzq0u
N/1A7/T5WGPixb3WBh6Pvd7TYlVgsQj6SLZ5ZK3WdtDuELbS6
tNlBuJkTqMJjPJPWEbIdQQM9KTsWTPD+HixjzKSI7IqCgmhAq
h2pW50X8y8GybK8BSp3JjzL4PsErStDiq9upS11a7DE60Ak1F
mRowbtm4QHAlCPcJ56WzCktxTmL5yU58JtbH6dtvstiGp2U22
yrx8br8WQ8QXAbGkSHpMd5lXeY1WKcvRF+ECJUfo8zNJnm1Tw
1w7ziGj5FHD9oDaMrVdbkrQjrvdznZDKvtzcaYCnXjr4TjwrI
7L8J9m5d3p74yVlBf9O4qc87dHaqAY0isjjxgQUXhAIIrhfrE
UP8Laz39l39VT7et",
      "termURL": "https://billsvc.Example.com/web/result/threeds"
    }
  }
}
Note: In this case, the 3DSecure process is not required (threeDSecureFlag="Y" && enrolled="N").
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "refPLOrderId": "201606020000015",
    "threeDSecureFlag": "Y",
    "threeDSecure": {
      "xid": "TXU5Z3c2TTFKa2EzejJwc2hiSVI=",
      "enrolled": "N"
    }
  }
}
Note: In this case, the 3DSecure process is not required (threeDSecureFlag="N").
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "refPLOrderId": "201606020000019",
    "threeDSecureFlag": "N"
  }
}
Failed Response [HTTPS + JSON]
HTTPS STATUS CODE : 404 Not Found 
{
  "error": {
    "code": 906,
    "message": "cvv information does not exist.",
    "detail": null
  }
}
Example: Case 2. Request with New Payment Information
CheckTransaction HTTPS POST Request (JSON)
{
  "orderId": "9e796f71-7752-44fe-ae2d-55e82f12c168",
  "existingFlag": "N",
  "saveFlag": "N",
  "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": "4370000000000111",
      "cardExpYear": "2018",
      "cardExpMonth": "08",
      "cardHolder": "John Doe",
      "cardNickName": "Card1",
      "cardCvvToken": "1000000000002741"
    }
  },
  "transaction": {
    "applicationId": "cf9e3205-6cb3-42be-9df4-c2f418b74f2e",
    "applicationVersion": "v0.1",
    "amount": 10,
    "currencyCode": "GBP",
    "extCasinoUserId": "45a06451-2d72-4228-8411-ef6997f8c4a7",
    "extCasinoTransId": "9399ab70-aee7-4ba3-bdbc-4e532f14b217",
    "extCasinoPaymentGatewayId": "8b056e5c-15c0-47e6-a25b-9cfb099e45f2",
    "casinoId": "af1a90c6-f7ff-47bf-af01-86e077c1d85b",
    "categortNames": [
      "Poker",
      "Casino"
    ],
  },
  "accessCountryCode": "KR",
  "ipAddress": "112.223.50.121"
}
Encrypting Data and HTTPS Request [POST method]
POST
http(s)://{host}/billing/32303136303432383136343
234356330633438353933386466644aa448bc71a97b52675
14c0b4c0ad7d54463f3a44f913391af5320bb01f188a11b5
01cf5ffd075ffb1278f1c3a3d8ccc9b934b1b/transactions/
check
 
"Content-Type: application/x-www-form-urlencoded"
"Authorization: PLTOKEN {TOKEN}"
 
data=
323031363034323831363432343532363931383965626232
31325be9680a1f756a284c8899774b1fb34ea880558f34f7
f01b65ebb14cd1a48a958c23a823ba826ebff80ef83fd832
879114fa6101e8cb2001f51ed56574836927de54aced1259
1c95ff9c8eb11aca4478f0d4bd7534549e2c580136014e3c
92e3fe12deaa7a7344449e065dcd52eb413b369c12db2e41
9c6de0d08b43ace48b95e85fa73f2fbca061e33842d65936
97c85460b7ba0cfaf04dee3efcc77468461ccd4d03435236
f5753ee3e4d5725ae73bdb96f0e1057534549e2c58013601
4e3c92e3fe12deaa7a7344449e065dcd52eb413b369c12db
2e419c6de0d08b43ace48b95e85fa73f2fbca061e33842d6
593697c85460b7ba0cfaf04dee3efcc77468461ccd4d0343
5236f5753ee3e4d5725ae73bdb96f0e105
Successful Encrypted Response [HTTPS]
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response [HTTPS + JSON]
Note: In this case, the 3DSecure process is required (threeDSecureFlag="Y" && enrolled="Y").
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "refPLOrderId": "201606020000018",
    "threeDSecureFlag": "Y",
    "threeDSecure": {
      "xid": "TXU5Z3c2TTFKa2EzejJwc2hiSVI=",
      "enrolled": "Y",
      "acsUrl": "https://webapp.securetrading.net/acs/visa.cgi",
      "md":
"UEZOVVBqeE5SRDQ4VFVSSVBqWnZNRUZSZEhsTVpIZHViMVZa
ZGsxdFQwOVpNVkU5UFR3dlRVUklQanhoWTNOVmNtdythSFIwY
0hNNkx5OTNaV0poY0hBdWMyVmpkWEpsZEhKaFpHbHVaeTV1Wl
hRdllXTnpMM1pwYzJFdVkyZHBQQzloWTNOVmNtdytQSEJoYmt
4bGJtZDBhRDR4Tmp3dmNHRnVUR1Z1WjNSb1BqeHRaWE56WVdk
bFNXUStVRUZTWlhFdE1UUTJORGcwT0RnNU9EVTRNaTAzTVRNN
E16UXhNRGM4TDIxbGMzTmhaMlZKWkQ0OEwwMUVQand2VTFRKz
ptZFdRbkJUV3dsSERkL3Ftc0E4UWZoOWRqY3BER1cwWERzZGR
oRVVoak5rRVU9",
      "paReq":
"eJxVUm1PwjAQ/iuG7+zWboxKjiYgGtFoiExj/Da6i5sZA7oO
0F9vO8ZbP91zb8/dc8U400STOalak8QXqqrkm27ydNiZjd5o0
2VhFIpQiFvRE7zbZ4EIQub3OxKbuMQt6SpflZJ5vscRjtC20i
pLSiMxUZvx9FUyHoS9CKGFuCQ9nUj/+iEc3FgmS5JjMipJCaF
BqFZ1afSvFNy2OQKsdSEzY9YDgEVeFNVWeYtDnadWS9jRAjRV
dWHAuF3TCsGVIJwnnNXOqizFPk9l/Pne+woUj+OH54Tf/9HP0
07xLJ9/TIcILgPTxJDkPov8yOc3fjTgYsAEQuPHZOlmk6zZpw
W4dhyjy8ilB63+mkp1XO6IkPbrVUk2w2p7sjGlSp34G+Eadud
FOG9z9+jUV8YKGgb9s8qMMXeHJuAYcqsjE75oKBxAcKXQnhja
b2Gtq+/yD8r8t2E=",
      "termURL": "https://billsvc.Example.com/web/result/threeds"
    }
  }
}
Note: In this case, the 3DSecure process is not required (threeDSecureFlag="Y" && enrolled="N").
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "refPLOrderId": "201606020000019",
    "threeDSecureFlag": "Y",
    "threeDSecure": {
      "xid": "TXU5Z3c2TTFKa2EzejJwc2hiSVI=",
      "enrolled": "N"
    }
  }
}
Note: In this case, the 3DSecure process is not required (threeDSecureFlag="N").
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "refPLOrderId": "201606020000019",
		"threeDSecureFlag": "N"
	}
}
Failed Response [HTTPS + JSON]
HTTPS STATUS CODE : 404 Not Found 
{
  "error": {
    "code": 906,
    "message": "cvv information does not exist.",
    "detail": null
  }
}

Return to top

POSTCreate Billing Transaction with New Payment Information (CreateTransactionWithNewPaymentInfo)

Description
A server can invoke this action to request a billing transaction with new payment information.
Endpoint url
/billing/{uuid}/transactions
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 36 M User’s unique identification
orderId String 36 M Unique OrderId for a transaction by the client side.
refPLOrderId String 15 M Must be the value returned in the refPLOrderId field of the "Check Billing Transaction" API Response.
ipAddress String 50 M User's IP Address
coreData Object N/A M Core Object
    additionalIdentifier String N/A M Can be "CUSTOM" or "PRESET"
    promoCodes Array (Object) N/A O Array of the Promotion Object.
Is set by MC as part of pre-check.
        promoCode String N/A M A promotion code.
        bonusAmount Double 8 M A bonus amount.
    promotionalBonus Array (Object) N/A O An array of the Promotion Object.
Is set by MC as part of pre-check.
        promotionalAppId String N/A M An Application ID as per the core database.
Should typically come from core database.
        bonusAmount Double 8 M A bonus amount.
ipAddress String 50 M User's IP Address.
threeDSecureFlag String 1 M Determines if this is a 3DSecure transaction.
"Y" = A 3DSecure transaction.
"N" = Not a 3DSecure transaction.
threeDSecureFlag = "Y"
threeDSecure Object N/A O 3DSecure information object.
    md String 1024 O Must be the value returned in the md field returned from Example in the 3DScecure Process.
    paRes String 65536 O Must be the value returned in the md field returned from Example in the 3DScecure Process.
    xid String 255 M Must be the value returned in the md field returned from Example in the 3DScecure Process.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
uuid String 50 User’s Unique ID.
paymentInfoId String 36 Payment Information ID.
If saveflag = "Y",
paymentInfoId will be returned.
transaction Object N/A Transaction object.
    applicationId String 36 Unique ID for a game.
    amount Double 8 Payment amount.
    currencyCode String 3 Payment currency code: ISO 4217 external link icon
    transactionOrderId String 36 Corresponds to a Deposit Transaction OrderID.
    transactionId String 36 Unique ID of Example.
    status String 10 Status of transaction SUCCESS.
    transactionDate String 20 Date and time of transaction.
    extCasinoUserId String N/A Corresponds to a casino's user ID.
    extCasinoTransId String N/A Corresponds to a casino's transaction ID.
    extCasinoPaymentGatewayId String N/A Corresponds to a casino's wallet ID.
HTTPS Request example: CreateTransaction [POST method]
{
  "orderId": "bebd843d-1add-443d-8586-b066f081d757",
  "refPLOrderId": "201606020000023",
  "threeDSecureFlag": "Y",
  "threeDSecure": {
    "md": "UEZOVVBqeE5SRDQ4VF…ZoOWIyMGhPTldHT1ZlRnFLUkZRS0FwZ009",
    "paRes": "eJztWMmyq7iynfMVFVVDxyl6DBU+…2meb0lv566n29n3z6B/wsHIW/A",
    "xid" : "TXU5Z3c2TTFKa2EzejJwc2hiSVI=",
  },
  "coreData": {
    "additionalIdentifier": "CUSTOM",
    "applicationId": "cf9e3205-6cb3-42be-9df4-c2f418b74f2e"
  },
  "ipAddress": "112.223.50.121"
}
/*  Please note that the "md" and "paRes" fields typically contain values
    far longer than displayed in the example above and therefore have been
    abbreviated using "…", for your convenience.
*/
Encrypting Data and HTTPS Request [POST method]
POST
http(s)://{host}/billing/32303135303932343135303
63231336263383630333332313836e14946e58b0485ae4ab
000/transactions
 
"Content-Type: application/x-www-form-urlencoded"
"Authorization: PLTOKEN {TOKEN}"
 
data=
3230313530393234313530363231336263383630333332313
836e14946e58b0485ae4ab000557942caa75e84708a6123ac
21a9945845a07d557a6bee23a9b01db139e3d5895bae32047
6cc665ac7b5864baeab3a806570b5e4f9b2ba8a4085764391
3f93e6534753ab08be5815a0d170d0f679a3c3d838ae885e8
0f01f40bd45a0d506858e6c97ca0e55d0aa565c79b3a5e34a
b81c4e7c9b754557231be0760e8041eb7cbba8a0e9db51a93
c99917e39cf1cda93412b1c20795ce171e9b9e316006cb783
0085b0434eb2c90a12d749f975c09f3fe7ccc11242c7452ed
b5325baa9a852298ab059d40e09a3b653e64c953adddf04f6
761747d66827820035c58452c2fa9c72af00a7caa79a1d39c
a467acc7dd05b58ed2f36ca02f20fd4523fcc84361ff7f7cd
81985ff283f71cbd4cae958e6055a127cba408b23d3bee884
e04a986eb94a943442f428e4daa207af947d3a03faa77f47b
2ca7f06382af36567e3cb6ead4f19ffdfc850111971e78b68
453abea1aa650a2eacf00505dbc84c1b6aa2b2c1f9814bb34
997e8e13906810ea92533c823df4a2ebfd4fcf7683328b452
a360736fd65d5d1ddad22466078bd74aa9705e7b58e58a846
ccb46b9fa9ea8106a6b520f596bc44407541d8bfbc54f9579
7895e758076864502aef033b7223db03ad35d0d1934d67e18
dd58a0fba2da2a323bae7fc971829eb68edfc69e0ae873cd1
df8099509
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "uuid": "dc79042f-321e-42df-9e12-25fc2a4a8f1a",
    "transaction": {
      "applicationId": "cf9e3205-6cb3-42be-9df4-c2f418b74f2e",
      "amount": 10,
      "currencyCode": "GBP",
      "transactionOrderId": "cf9e3205-6cb3-42be-9df4-c2f418b74f2e",
      "transactionId": "201606020000024",
      "status": "SUCCESS",
      "transactionDate": "02/06/2016 06:48:10",
      "extCasinoUserId": "319ddbd2-1a6b-4064-a5a5-e6ef920be2cf",
      "extCasinoTransId": "9cdfb42a-ba6f-4242-9e0d-f295c99003b7",
      "extCasinoPaymentGatewayId": "c02b1adf-4efd-4eff-963e-3a025a4a5231"
    }
  }
}
Failed Response [HTTPS + JSON]
HTTPS STATUS CODE : 500 Internal Server Error 
{
  "error": {
    "code": 981,
    "message": "PSP processing failed",
    "detail" : "Invalid Card Number"
  }
}

Return to top

POSTCreate Billing Transaction with PaymentInfoID (CreateTransactionWithPaymentInfoID)

Description
Create a billing transaction with a PaymentInfoID. A server can invoke this action to request a billing transaction with saved payment information.
Endpoint url
/billing/{uuid}/paymentinfo/{paymentinfoid}/transactions
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 36 M Encrypted user’s unique identification.
paymentInfoId String 36 M User’s unique payment information ID.
orderId String 36 M Unique OrderId for a client-side transaction.
refPLOrderId String 15 M Must be the value returned in the refPLOrderId field of the "Check Billing Transaction" API Response.
ipAddress String 50 M User's IP Address
coreData Object N/A M Core object.
    additionalIdentifier String N/A M Can be "CUSTOM" or "PRESET".
    promoCodes Array (Object) N/A O Array of the Promotion Object.
Is set by MC as part of pre-check.
        promoCode String N/A M A promotion code.
        bonusAmount Double 8 M A bonus amount.
    promotionalBonus Array (Object) N/A O An array of the Promotion Object.
Is set by MC as part of pre-check.
        promotionalAppId String N/A M An Application ID as per the core database.
Should typically come from core database.
        bonusAmount Double 8 M A bonus amount.
ipAddress String 50 M User's IP Address.
threeDSecureFlag String 1 M Determines if the transaction is 3DSecure.
"Y" = A 3DSecure transaction.
"N" = Not a 3DSecure transaction.
threeDSecureFlag = "Y"
threeDSecure Object N/A O 3DSecure information object.
    md String 1024 O Must be the value returned in the md field returned from Example in the 3DScecure Process.
    paRes String 65536 O Must be the value returned in the md field returned from Example in the 3DScecure Process.
    xid String 255 M Must be the value returned in the md field returned from Example in the 3DScecure Process.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
uuid String 50 User’s Unique ID.
paymentInfoId String 36 Payment Information ID.
If saveflag = "Y",
paymentInfoId will be returned.
transaction Object N/A Transaction object.
    applicationId String 36 Unique ID for a game.
    amount Double 8 Payment amount.
    currencyCode String 3 Payment currency code: ISO 4217 external link icon
    transactionOrderId String 36 Corresponds to a Deposit Transaction OrderId.
    transactionId String 36 Unique ID of Example.
    status String 10 Status of transaction, for example: SUCCESS.
    transactionDate String 20 Date and time of transaction.
    extCasinoUserId String N/A Corresponds to a casino's user ID.
    extCasinoTransId String N/A Corresponds to a casino's transaction ID.
    extCasinoPaymentGatewayId String N/A Corresponds to a casino's wallet ID.
HTTPS Request example: CreateTransactionByPMID [POST method]
{
  "orderId": "d4127f51-3078-4d78-ba24-bb0c9d3c16c2",
  "refOrderId": "201606020000027",
  "threeDSecureFlag": "N",
  "coreData": {
    "additionalIdentifier": "CUSTOM",
    "applicationId": "cf9e3205-6cb3-42be-9df4-c2f418b74f2e",
    "promoCodes": [
      {
        "promoCode": "cb108584-333c-4db9-abb8-7726554fce13",
        "bonusAmount": 10
      },
      {
        "promoCode": "e7c58cc2-0579-44ca-8e3f-d391ff8b43cf",
        "bonusAmount": 10
      },
      {
        "promoCode": "5d1ab6be-8e99-49d0-a15d-c863f59a065f",
        "bonusAmount": 10
      }
    ]
  },
  "ipAddress": "112.223.50.121"
}
Encrypting Data and HTTPS Request [POST method]
POST
http(s)://{host}/billing/32303135303932343135303
63231336263383630333332313836e14946e58b0485ae4ab
000/paymentinfo/32303135303932343135303632313362
63383630333332313836e14946e58b0485ae4ab000/transactions
 
"Content-Type: application/x-www-form-urlencoded"
"Authorization: PLTOKEN {TOKEN}"
 
data=
323031353039323431353036323133626338363033333231
3836e14946e58b0485ae4ab000557942caa75e84708a6123
ac21a9945845a07d557a6bee23a9b01db139e3d5895bae32
0476cc665ac7b5864baeab3a806570b5e4f9b2ba8a408576
43913f93e6534753ab08be5815a0d170d0f679a3c3d838ae
885e80f01f40bd45a0d506858e6c97ca0e55d0aa565c79b3
a5e34ab81c4e7c9b754557231be0760e8041eb7cbba8a0e9
db51a93c99917e39cf1cda93412b1c20795ce171e9b9e316
006cb7830085b0434eb2c90a12d749f975c09f3fe7ccc112
42c7452edb5325baa9a852298ab059d40e09a3b653e64c95
3adddf04f6761747d66827820035c58452c2fa9c72af00a7
caa79a1d39ca467acc7dd05b58ed2f36ca02f20fd4523fcc
84361ff7f7cd81985ff283f71cbd4cae958e6055a127cba4
08b23d3bee884e04a986eb94a943442f428e4daa207af947
d3a03faa77f47b2ca7f06382af36567e3cb6ead4f19ffdfc
850111971e78b68453abea1aa650a2eacf00505dbc84c1b6
aa2b2c1f9814bb34997e8e13906810ea92533c823df4a2eb
fd4fcf7683328b452a360736fd65d5d1ddad22466078bd74
aa9705e7b58e58a846ccb46b9fa9ea8106a6b520f596bc44
407541d8bfbc54f95797895e758076864502aef033b7223d
b03ad35d0d1934d67e18dd58a0fba2da2a323bae7fc97182
9eb68edfc69e0ae873cd1df8099509
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "uuid": "dc79042f-321e-42df-9e12-25fc2a4a8f1a",
    "paymentInfoId": "8bae8471-0785-4c39-b016-086f8d54d58a",
    "transaction": {
      "applicationId": "cf9e3205-6cb3-42be-9df4-c2f418b74f2e",
      "amount": 10,
      "currencyCode": "GBP",
      "transactionOrderId": "cf9e3205-6cb3-42be-9df4-c2f418b74f2e",
      "transactionId": "201606020000028",
      "status": "SUCCESS",
      "transactionDate": "02/06/2016 07:04:20",
      "extCasinoUserId": "18477d20-8737-470d-af99-038236c87487",
      "extCasinoTransId": "5d6acd38-72b2-4348-adbb-d6561aaa4d4f",
      "extCasinoPaymentGatewayId": "9bcdac44-7a4d-4f03-8fbc-7520aca91a02"
    }
  }
}
Failed Response
HTTPS STATUS CODE : 500 Internal Server Error 
{
  "error": {
    "code": 981,
    "message": "PSP processing failed",
    "detail" : "Invalid Card Number"
  }
}

Return to top

GETGet Billing Transaction (GetTransactions)

Description
A server can invoke this action to get a billing transaction list.
Endpoint url
/billing/{uuid}/transactions
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.
pageNo Integer 4 M Start number of page.
pageSize Integer 4 M Row number per page.
fromDate String 8 M Start date of transaction. Example:
(YYYYMMDD) as in "20151231".
toDate String 8 M End date of transaction. Example:
(YYYYMMDD) as in "20151231".
HTTPS Response data: JSON Properties
JSON Property Type Size Description
uuid String 200 User's unique ID.
totalCount Integer 4 Total count of a transaction.
transactions Array (Object) N/A Array of the transaction object.
    transactionId String 36 Unique transaction ID.
    paymentDate String 20 Date and time of payment.
    applicationId String 15 Related game code of payment.
    amount Double 8 Payment amount.
    currencyCode String 3 Payment currency code. ISO 4217 external link icon
    paymentType String 50 Payment Type: "CreditCard".
HTTPS Request example: GetTransactions [GET method]
/billing/89396B99-5A57-4ECA-96C9-60ED109F8C8A/transactions?
pageNo=1&
pageSize=10&
fromDate=20150101&
toDate=20150831
Encrypting Data and HTTPS Request [GET method]
GET
https://{host}/billing/323031353039323431353039343
2623466336434363931636134991a219bba46116e3deecfe4
85f650a558f861cafb503295930eccc7ce11b99f57524ef67
713f45582a5eb07e9fe8f1d9e19c933/transactions?
 
data=
3230313530393232313631373330633062613738323263303
839e61251256b1bd3583b2f02642a2e678debda2f67a685d3
e56e034f8
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "uuid": "2a50a2e4-a93a-4823-9674-c63aba792325",
    "totalCount": 3,
    "transactions": [
      {
        "applicationId": "00f378f3-f467-4a39-81ea-ac8b0d073eea",
        "amount": 10,
        "currencyCode": "GBP",
        "transactionId": "201604280000070",
        "paymentType": "CREDITCARD",
        "transactionDate": "28/04/2016 16:52:00"
      },
      {
        "applicationId": "00f378f3-f467-4a39-81ea-ac8b0d073eea",
        "amount": 10,
        "currencyCode": "GBP",
        "transactionId": "201604280000066",
        "paymentType": "CREDITCARD",
        "transactionDate": "28/04/2016 16:51:55"
      },
      {
        "applicationId": "00f378f3-f467-4a39-81ea-ac8b0d073eea",
        "amount": 10,
        "currencyCode": "GBP",
        "transactionId": "201604280000062",
        "paymentType": "CREDITCARD",
        "transactionDate": "28/04/2016 16:51:29"
      }
    ]
  }
}
Failed Response
HTTPS STATUS CODE : 404 Not Found 
{
  "error": {
    "code": 911,
    "message": "This account (89396B99-5A57-4ECA-96C9-60ED109F8C8A) does not have transactions.",
    "detail": null
  }
}

Return to top

GETGet Transaction Count (GetTransactionCount)

Description
A server can invoke this action to get a transaction count.
Endpoint url
/billing/transactions/{transactionDate}/count
HTTPS Method
GET
HTTPS Request data: Parameters
Note: M/O = Mandatory or Optional; Size = number of characters
Parameter Type Size M/O Description
transactionDate String N/A M Encrypted transaction date (YYYYMMDD), as in "20160106".
countryCode String 2 M Country code ("GB"): ISO 3166-2 external link icon
status String 10 M Status of transaction: SUCCESS, FAILED, REFUNDED, REVERSED.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
totalCount Integer 4 Count of matched transactions.
HTTPS Request example: GetTransactionCount [GET method]
/billing/transactions/20160106/count?
countryCode=GB&
status=SUCCESS
Encrypting Data and HTTPS Request [GET method]
GET
https://{host}/billing/transactions/32303135303932
34313530393432623466336434363931636134991a219bba4
6116e3deecfe485f650a558f861cafb503295930eccc7ce11
b99f57524ef67713f45582a5eb07e9fe8f1d9e19c933?
 
data=
3230313530393234313530393432623466336434363931636
134991a219bba46116e3deecfe485f650a558f861cafb5032
95930eccc7ce11b99f57524ef67713f45582a5eb07e9fe8f1
d9e19c93
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response [HTTPS]
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "totalCount": 10
  }
}
Failed Response
HTTPS STATUS CODE : 500 Internal Server Error 
{
  "error": {
    "code": 999,
    "message": "Internal Error.",
    "detail": null
  }
}

Return to top

GETGet Transaction History List (GetTransactionHistory)

Description
A server can invoke this action to get a transaction history list.
Endpoint url
/billing/transactions/{transactionDate}/history
HTTPS Method
GET
HTTPS Request data: Parameters
Note: M/O = Mandatory or Optional; Size = number of characters
Parameter Type Size M/O Description
transactionDate String N/A M Encrypted transaction date (YYYYMMDD), as in "20160106".
countryCode String 2 M Country code ("GB"): ISO 3166-2 external link icon
status String 10 M Status of transaction: SUCCESS, FAILED, REFUNDED, REVERSED.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
totalCount Integer 4 Total count of a transaction.
transactions Array N/A Array of the transaction object.
    transactionID String 50 Unique ID of Example.
    orderID String 50 Unique ID for a client-side transaction.
    uuid String 50 User's unique ID.
    paymentInfoId String 50 Payment Information ID.
    applicationId String 15 Related game code of a transaction.
    amount Double 8 Payment amount.
    currencyCode String 3 Payment currency code: ISO 4217 external link icon
    status String 10 Status of transaction: SUCCESS, FAILED, REFUNDED, REVERSED.
    comment String 200 Note of a transaction.
    ipAddress String 50 IP Address.
    transactionDate String 20 Date and time of transaction.
HTTPS Request example: GetTransactionHistory [GET method]
/billing/transactions/20160106/history?
countryCode=GB&
status=SUCCESS
Encrypting Data and HTTPS Request [GET method]
GET
https://{host}/billing/transactions/3230313530393
234313530393432623466336434363931636134991a219bb
a46116e3deecfe485f650a558f861cafb503295930eccc7c
e11b99f57524ef67713f45582a5eb07e9fe8f1d9e19c933/
history?
 
data=
323031353039323431353039343262346633643436393163
6134991a219bba46116e3deecfe485f650a558f861cafb50
3295930eccc7ce11b99f57524ef67713f45582a5eb07e9fe
8f1d9e19c93
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "totalCount": 3,
    "transactions": [
      {
        "transactionID": "201508280404206",
        "orderID": "cedad85e-fdea-40e1-baeb-2384786aaeb0",
        "uuid": "79d97b31-f48a-4dd4-a9be-1ea9cd4998d4",
        "paymentInfoId": "995d9b68-3eae-4fd9-b166-1b5df602b640",
        "applicationId": "ABC",
        "amount": 10,
        "currencyCode": "GBP",
        "status": "SUCCESS",
        "comment": "Your transaction was approved by Paypal",
        "ipAddress": "127.0.0.1",
        "transactionDate": "20/12/2015 15:10:10"
      },
      {
        "transactionID": "201508280404207",
        "orderID": "d3b173a4-afc5-4209-8424-fd8c237c7f7c",
        "uuid": "79d97b31-f48a-4dd4-a9be-1ea9cd4998d4",
        "paymentInfoId": "c9455a07-59a6-418c-90f8-a98398379d84",
        "applicationId": "ABC",
        "amount": 30,
        "currencyCode": "GBP",
        "status": "FAIL",
        "comment": "Invalid credit card information. Please re-enter. (Invalid account number)",
        "ipAddress": "127.0.0.1",
        "transactionDate": "20/12/2015 08:10:10"
      },
      {
        "transactionID": "201508280404208",
        "orderID": "745125db-5bf6-457c-a59e-b8968abf3ea8",
        "uuid": "6633d40c-b253-482f-99b3-41385f80fefb",
        "paymentInfoId": "22a1787f-d492-4369-8e08-aaa3e8dd8478",
        "applicationId": "ABC",
        "amount": 50,
        "currencyCode": "GBP",
        "status": "SUCCESS",
        "comment": "Your transaction was approved by Paypal",
        "ipAddress": "127.0.0.1",
        "transactionDate": "20/12/2015 18:10:10"
      }
    ]
  }
}
Failed Response [HTTPS + JSON]
HTTPS STATUS CODE : 500 Internal Server Error 
{
  "error": {
    "code": 999,
    "message": "Internal Error.",
    "detail": null
  }
}

Return to top

POSTPayout Transaction (Payout)

Description
A server can invoke this action to create a payout transaction.
Endpoint url
/billing/{uuid}/payout
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 36 M User's unique identification.
orderId String 36 M Unique OrderId for a transaction by the client side.
paymentInfoId String 36 O Payment Information ID.
transaction Object N/A M Transaction Object.
    applicationId String 36 O Unique ID for Casino (application).
    applicationVersion String 10 O Casino (application) Version.
    amount Double 8 M Requested amount.
    currencyCode String 3 M Currency code.
    extCasinoUserId String N/A O Corresponds to a casino's user id.
    extCasinoTransId String N/A O Corresponds to a casino's transaction id.
    extCasinoPaymentGatewayId String N/A O Corresponds to a casino's wallet id.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
uuid String 36 User's unique Identification.
paymentInfoId String 36 Payment Information ID.
transaction Object (Array) N/A Array of the transaction object.
    transactionID String 50 Unique ID of Example.
    transactionOrderId String 36 Unique ID for a Payout Transaction.
    currencyCode String 3 Payment currency code: ISO 4217 external link icon
    amount Double 8 Payment amount.
    pspCode String 10 Payment Service Provider Codes:
  • "SCTD" : SecureTrading
  • "ECP" : E-Com Processing
    pspTid String 50 Unique ID from a Payment Service Provider - "Claim by user".
    region String 40 Region for a user's payment information:
  • "Domestic"
  • "Intra Europe EEA"
  • "Intra Europe (Non-EEA)"
  • "International"
HTTPS Request example: Payout [POST method]
{
  "uuid":"00d8f6a8-edbe-4eee-9881-b347b740c852",
  "orderId":"9ef2eb6a-e265-4903-9f82-81f35ac6bc59",
  "transaction":{
    "applicationId":"0e358e8e-4f2f-4c67-affb-ccbd5847eb14",
    "applicationVersion":"0.1",
    "amount":10.0,
    "currencyCode":"GBP",
    "extCasinoUserId":"34b72420-7ca7-4748-a966-25d058e303c7",
    "extCasinoTransId":"d0cbed47-aa1c-45ce-b313-9eb491345749",
    "extCasinoPaymentGatewayId":"06874048-52c7-400a-9718-d9f7653523a0"
  },
  "ipAddress":"203.170.118.12"
}
Encrypting Data and HTTPS Request [POST method]
POST http(s)://{host}/billing/{uuid}/payout
"Content-Type: application/x-www-form-urlencoded"
"Authorization: PLTOKEN {TOKEN}"
data=
3230313630373038313733383439633238383333663832326632e053ecdf27192b78f1aa4c4e176381395ae5051f12a9d6
c792ed29f7cd81e8682b28f6350650f82906e866f64ea529d44746b78eb57a266a11d70189e49ab645505c266e6db3c530
9f0a8d8d3a0106267c31bd792b18f224b2da5cf95b9d9b5965db91c2959449e5cb21a967ebec0b09704acc8c673fc0c4535
9b769fec78690af0a0398d6e4a53b55f34f87e383778742bb68a7bc149b87d905652305a70dc249b74d33316629d5dc9fce
e98a46e917666ed9787d411e1ab4826e5c273e1b6ce1f0cba86ddb2e007035fe5597bfba7b23885563f628af36b7d2c6703
48717a59bb659285109de37f7f63ed67e9066d7e16ffdf4045acde499968baa2ed25cbd7594c4e98e6aaac384a1b4a7f69b
420a546b708398b145b050b4c2bcd2db4525b70b8b8e807fb266bffbaa9ae66ae293e2245391756b86ff0b0bc0427cbba3
ee29e0d64cdd01d3db243c3802fe00ad8385acdcf16c923a8cdb00c87bb992e6baf46508ce744fd35d1b1f981af29f46734e
c48ed4d1cfea37d272f11a26bc929d993324766945254a880832d33390c74812958bef359d8bbabf734a48bbb63fc1ccdd0
82cd872514cb505e5cb16cbd9c3aba4e21ea8d9475c62a0b1b6a532afdc96db2c0d10c60bb6f0c12b15c8e1475600e013c
a4d0ff80a01a8c8019c38c8d6ecc7b453517e5a4ce5dc4983743859b864822b7a0db79ea248599b6f52c585dd2e31e5caf1
c1b134ed42809eccfceb98031583f7a31cbd52fffd8afc8d
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response [HTTPS + JSON]
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "uuid": " 00d8f6a8-edbe-4eee-9881-b347b740c852",
    "paymentInfoId":"e6dcb582-eec9-49ca-9faf-0e01de779447",
    "transaction": {
      "transactionOrderId":"9ef2eb6a-e265-4903-9f82-81f35ac6bc59",
      "amount": 10,
      "currencyCode": "GBP",
      "transactionId": " 201607080000584",
      "pspCode": "SCTD",
      "pspTid": "4-9-2733014",
      "region": "UK"
    }
  }
}
Failed Response [HTTPS + JSON]
HTTPS STATUS CODE : 500 Internal Server Error 
{
  "error": {
    "code": 941,
    "message": "Failed to payout payments.",
    "detail": "VPay or Maestro Card Type could not pay out"
  }
}

Return to top

DELETERefund Transaction (RefundTransaction)

Description
A server can invoke this action to refund a transaction.
Endpoint url
/billing/{uuid}/transactions?referenceTransactionId={referenceTransactionId}&note={note}
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 36 M User's unique Identification.
orderId String 36 M Unique OrderId for a transaction by the client side.
referenceTransactionId String 36 M Corresponds to a Deposit Transaction ID of Example. For example: "201607070000560".
note String 200 O A note.
amount Double 8 O The specific amount for a partial refund. If the amount is not set, it will perform a full-amount refund.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
    uuid String 36 User's unique ID.
transaction Array N/A Array of the transaction object.
    transactionID String 50 Unique ID of Example.
    transactionOrderID String 36 Unique orderId for a transaction by the client side.
    referenceTransactionId String 36 Corresponds to a Deposit Transaction ID of Example.
    currencyCode String 3 Payment currency code: ISO 4217 external link icon
    amount Double 8 Payment amount.
    pspCode String 10 Payment Service Provider Code "SCTD" : SecureTrading.
    pspTid String 50 Unique ID from a Payment Service Provider - "Claim by user".
    region String 40 Region for a user's payment information:
  • "Domestic"
  • "Intra Europe EEA"
  • "Intra Europe (Non-EEA)"
  • "International"
HTTPS Request example: RefundTransaction [DELETE method]
billing/323031363037303731383430333930373032
3435656366636234f12bc1f26190f62a6c5565c42700f7a54bd
f3e1320badc6dce16e1d08735a5e1116c0ea02b5d127f9ad34c
88fb2852c598792709/transactions?
data=3230313630373037313834303339383939306431643361
656435ad2e0cfc1be89bb283120eb72acf333c4839576d8e630
57c44b92ab05985e64c329279a6de4cc9f3c61b181b81273cc3
4c93ea2b266659342d026638b4ef077b08578e4468e38a6805
Encrypting Data and HTTPS Request [DELETE method]
DELETE
http(s)://{host}/billing/323031363037303731383430333
9303730323435656366636234f12bc1f26190f62a6c5565c4270
0f7a54bdf3e1320badc6dce16e1d08735a5e1116c0ea02b5d127
f9ad34c88fb2852c598792709/transactions?
data=32303136303730373138343033393839393064316433616
56435ad2e0cfc1be89bb283120eb72acf333c4839576d8e63057
c44b92ab05985e64c329279a6de4cc9f3c61b181b81273cc34c9
3ea2b266659342d026638b4ef077b08578e4468e38a6805
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK 

3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "uuid": "9f3e9c0f-b7fe-4817-8bf9-f6ed55fa35be",
    "transaction": {
      "amount": 10,
      "currencyCode": "GBP",
      "transactionOrderId": "9ef2eb6a-e265-4903-9f82-81f35ac6bc59",
      "transactionId": "201607070000574",
      "referenceTransactionId": "201607070000556",
      "pspCode": "SCTD",
      "pspTid": "5-9-2491291",
      "region": "UK"
    }
  }
}
Failed Response [HTTPS + JSON]
HTTPS STATUS CODE : 400 Bad Request 
{
  "error": {
    "code": 944,
    "message": "PSP refund processing is failed.",
    "detail": "[20007] Refund amount too great"
  }
}

Return to top

PUTReject Transaction (RejectTransaction)

Description
A server can invoke this action to reject a transaction.
Endpoint url
/billing/{uuid}/transactions/{referenceTransactionId}/status
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 User's unique ID.
orderId String 36 M Unique OrderId for a transaction by the CORE admin side.
referenceTransactionId String 36 M Corresponds to a Deposit Transaction ID of Example.
For example: "201607070000560".
cancelReason String 200 M The reason for the cancellation.
HTTPS Response data: JSON Properties
JSON Property Type Size Description
uuid String 36 User's unique ID.
transaction Array N/A Array of the transaction object.
    transactionOrderID String 36 Unique OrderId for a transaction by the CORE admin side.
    referenceTransactionId String 36 Corresponds to a Deposit Transaction ID of Example.
    pspCode String 10 Payment Service Provider Code "SCTD" : SecureTrading.
HTTPS Request example: RejectTransaction [PUT method]
billing/
32303136303832393231333235313261613765356239396438612
934e764f14ab49f2e028d6cbdd5b8daeb2986e28efa834833efd2
34be21e1efdf482168bb580cc3b6c98cfbfdc0b8efa401fd43/
transactions/3230313630383239323133323531316466336536
6339663731626f99bf975a437508fe85af238214fa3768c6a1b64
4dd5092d6687583d184b1/status
Encrypting Data and HTTPS Request [PUT method]
PUT
http(s)://{host}/billing/323031363037303731383430333
9303730323435656366636234f12bc1f26190f62a6c5565c4270
0f7a54bdf3e1320badc6dce16e1d08735a5e1116c0ea02b5d127
f9ad34c88fb2852c598792709/transactions?
data=32303136303730373138343033393839393064316433616
56435ad2e0cfc1be89bb283120eb72acf333c4839576d8e63057
c44b92ab05985e64c329279a6de4cc9f3c61b181b81273cc34c9
3ea2b266659342d026638b4ef077b08578e4468e38a6805
 
"Authorization: PLTOKEN {TOKEN}"
Successful Encrypted Response
HTTPS STATUS CODE : 200 OK 
3230313530393234313530343332356662353634636132313
438818b824cf62c2d63feba0314c8b6cd3b328c2f02380787
406779be1607fa68363bf1fbac60a1b691de2f283ee2370f0
4f479287589b712576357c3256a2ba87f9c24d5948bb91dd1
3211ed9e452247603a75b5f5672f6718242e78baf48524182
e5f35ffa58874f3692f9ca9011d84d70e8f74dad430bf8a58
c8330fb0927e6048db45e3b18544a2d780e005903a668bbfb
a9fa7f0b5522ba0719c4e643c9fea11563fbd62d594c459d8
25f96ef53ed81aab2ec6a0657288c799e418e7e2d0451ca52
35a0d7dde3fe13f31cd6e7bd46470a58c2cb7372587b8e306
84fa98c2b6ddf3e06392bcbe41b80d107790ea58cc5b52115
6264ac9051b1b4aed931f9ba5b2bbe7e12b62de036f7cd1fb
328bfe80c8781a33c3d63c923322a2d55fb5
Successful Decrypted Response [HTTPS + JSON]
HTTPS STATUS CODE : 200 OK 
{
  "data": {
    "uuid": "139f0344-0641-4d9f-a47f-e695d05842a9",
    "transaction": {
      "transactionOrderId":"ed1b1a2d-5a55-48ed-a95e-93ef732193ca",
      "referenceTransactionId": "201608290000122",
      "pspCode": "SCTD",
    }
  }
}
Failed Response [HTTPS + JSON]
HTTPS STATUS CODE : 400 Bad Request 
{
  "error": {
    "code": 947,
    "message": "Failed to reject payment.",
    "detail": Not existing payment request detail."
  }
}

Return to top