Deposit

Deposit Endpoints

This section will display all available endpoints to get Deposit data.

Logic For All provider is as following:

  1. Get Payment Methods for the player.
  2. Begin Deposit process.
  3. Response will contain uri for provider, and all the data needed to send to provider, should transfer to provider page.

However, we have couple of providers which will be explained in the following sections.

  1. Praxis HPF: Praxis supports HPF(hosted payment fields) for some of its payment methods, if mode will be returned as ‘hpf’ we should do the following:
    1. Get Payment Methods for the player.
    2. Begin Deposit process.
    3. Use praxis script to open iframe with the payment fields.
    4. Send Direct Deposit
    5. Response will contain if request was successful or not.
    6. Following fields should be sent in this case: hpf_auth_token, device_data, ref_id.
  2. Praxis HPF Async: Praxis supports HPF(hosted payment fields) for some of its payment methods, if mode will be returned as ‘hpf’ we should do the following:
    1. Get Payment Methods for the player.
    2. Begin Deposit process.
    3. Use praxis script to open iframe with the payment fields.
    4. Send Direct Deposit, version should be 3.0 and above.
    5. Response will contain if request was successful or not.
    6. Following fields should be sent in this case: hpf_auth_token, device_data, ref_id.
    7. Every few seconds call should be sent to Deposit State to check if the deposit was successful.
  3. Direct Deposit: We have some providers which expect direct call from us, on this case mode will be ‘direct’ and we should do the following::
    1. Get Payment Methods for the player.
    2. Begin Deposit process.
    3. Send Direct Deposit, Following fields should be sent in this case: request_token, params, payment_data.
    4. Response will contain if request was successful or not.
    5. Every few seconds call should be sent to Deposit State to check if the deposit was successful.
    6. 3Ds cascading happens when Deposit State return status_name = ‘Initialized’ is_completed = true and redirect_url is not empty. Redirect player to redirect_url.
    7. Operator should provide platform with path to page where PSP provider will redirect player in case 3Ds deposit declined/canceled.
    8. When player arrives this page, Site need to call Has_Cascading to check if cascading exists. On False redirect player to decline deposit page. On True display player friendly message ‘Do you want to make an additional deposit?’.
    9. When player agree to make additional deposit, Site need to call Do Cascading and continue to ask for Deposit State

The following scenarios will require additional calls to Status API:

  1. if mode = status_request
  2. if mode = hpf and version > 3.0
  3. if mode = direct
  4. if additional_instructions.status_request = true
  5. if player choose to make additional deposit after 3ds deposit decline

Subsections of Deposit

Begin Deposit

This method begins a deposit transaction. use gateway.[msdomain]

Request (POST)

/gateway/financials/{brand_id}/{version}/player/deposit

{
  "amount": 10.5,
  "bonusCode": "",
  "country": "IL",
  "paymentProviderId": 1,
  "paymentMethodId": 1,
  "currency": "EUR",
  "lang": "en"
}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string true Player login session.
amount body string true Request amount in major currency (i.e 10.50 and not in cents 1050).
bonusCode body string false Bonus code for the request, if applicable.
country body string true Player country.
paymentProviderId body int true Request provider id.
paymentMethodId body int true Requested method id for chosen provider.
currency body string true Player requested currency (does not have to match his currency).
Referer header string true Some payment providers restrict transactions for specific domains, domain should be verified.
X-Forwarded-For header string true Player IP.

Response

Status 200

{
  "url": "urlparams",
  "params": {
    "amount": 10.5,
    "bonusCode": "",
    "country": "IL",
    "paymentProviderId": 1,
    "paymentMethodId": 1,
    "currency": "EUR",
    "lang": "en"
  },
  "mode": "embedded/window/hpf/status_request/direct",
  "refNum": "",
  "request_token": "aaaaa",
  "safecharge": true,
  "additional_instructions": {
    "status_request": true,
    "add_iframe_code": "allow=\"clipboard-read; clipboard-write\""
  }
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

401 Response, in case of some addition requirement needed before proceeding

Error Code Description
INCOMPLETE_REGISTRATION The player did not complete his registration process, need to complete Registration Step Two.
TNC_APPROVAL_REQUIRED Player need to approve TnC.
PRIVACY_APPROVAL_REQUIRED Player need to approve Privacy Policy.
PASSWORD_CHANGE_REQUIRED Player has temp password and need to Change Password.
EMAIL_NOT_VERIFIED Player email is not verified and cannot continue any process till he verifies his mail. 
{
  "result": "INCOMPLETE_REGISTRATION"
}

Status 403

{
  "result": "deposit_limit"
}

Status 412. Redirect player to Personal Details page for updating data missing to perform deposit

{
  "status": "Error",
  "data": [
    "zipPostalCode",
    "birthdate",
    "city",
    "address"
  ],
  "message": "missing fields",
  "userFriendlyMessage": "missing fields"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Type Description
mode = embedded string Indication to open the deposit form in embedded window (iframe).
mode = window string Indication to open the deposit form in seperate window.
mode = hpf string Mode which is relevant only for Praxis(and specific payment methods), for additional documentation please contact us.
mode = direct string Indication that this call won’t work like other, deposit request should be direct call.
mode = status_request string Indication that need to do calls for Status API.
refNum int If deposit transaction started, it will contain the reference id to proceed with.
url string provider url to open window.
request_token string Unique identifier for the request, will be used in direct mode.
safecharge bool indication if provider is safecharge.
params object object which will contain additional details required for deposit.
additional_instructions (Optional) object object which will contain additional details required for deposit request.
additional_instructions.status_request bool Indication that need to do calls for Status API.
additional_instructions.add_iframe_code string Iframe code

Direct Deposit

2nd step uses for Praxis HPF integration.

Call this API from Casino Front-end page that contains direct providers for example: Praxis hosted fields: Card number. Card Exp. Cvv. Amount. Submit button

Request (PUT)

/gateway/financials/deposit/{brand_id}/{version}/direct

{
  "hpf_auth_token": "938c2cc0dcc05f2b68c4287040cfcf71",
  "request_token": "938c2cc0dcc05f2b68c4287040cfcf71",
  "ref_id": 100,
  "params": {
    "amount": 1.1,
    "currency": "EUR",
    "paymentProviderId": 1,
    "paymentMethodId": 1,
    "bonusCode": "somecode",
    "country": "IL"
  },
  "device_data": {
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/605.1.15 (KHTML,like Gecko) Version/13.1.1 Safari/605.1.15",
    "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
    "language": "en-us",
    "timezone_offset": -180,
    "color_depth": "24",
    "pixel_depth": "24",
    "pixel_ratio": "2",
    "screen_height": 900,
    "screen_width": 1440,
    "viewport_height": 400,
    "viewport_width": 1440,
    "java_enabled": 0,
    "javascript_enabled": 1
  },
  "payment_data": {
    "cc_number": "1234123412341234",
    "CVV": "111",
    "cc_expiration": "12-12",
    "cc_holder_name": "John Doe"
  }
}

Parameters:

Name In Type Required Description
version path string true The API version to use, for any version higher than 3.0, response will be async, and should be fetched from Deposit State.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string true Player login session.
hpf_auth_token body string false Relevant for Praxis HPF only.
request_token body string false Relevant for Direct call providers.
ref_id body string false should be sent for praxis, not for other.
params body int true additional parameters to send, not relevant for praxis, should send the exact content as you get from Deposit Request .
device_data body int true Relevant only for praxis HPF.
payment_data body string true additional parameters to send, not relevant for praxis.
payment_data.cc_number body string true credit card number without ‘-’.
payment_data.CVV body string true CVV for credit card.
payment_data.cc_expiration body string true expiration date for card, format: MM-YY.
payment_data.cc_holder_name body string true forst name + last name of player.
X-Forwarded-For header string true Player IP.
Referer header string true Site domain.

Response

Status 200

{
  "redirect_url": "https://merchant.com/payment_result/tx-1560610955",
  "status": "OK",
  "ref_id": 12
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

401 Response, in case of some addition requirement needed before proceeding

Error Code Description
INCOMPLETE_REGISTRATION The player did not complete his registration process, need to complete Registration Step Two.
TNC_APPROVAL_REQUIRED Player need to approve TnC.
PRIVACY_APPROVAL_REQUIRED Player need to approve Privacy Policy.
PASSWORD_CHANGE_REQUIRED Player has temp password and need to Change Password.
EMAIL_NOT_VERIFIED Player email is not verified and cannot continue any process till he verifies his mail. 
{
  "result": "INCOMPLETE_REGISTRATION"
}

Status 403

{
  "result": "deposit_limit"
}

Status 412. Redirect player to Personal Details page for updating data missing to perform deposit

{
  "status": "Error",
  "data": [
    "zipPostalCode",
    "birthdate",
    "city",
    "address"
  ],
  "message": "missing fields",
  "userFriendlyMessage": "missing fields"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Type Description
status string status of request.
ref_id string reference number to run checks on (Async).

Deposit Status

This API returns deposit status and redirect url (3DS). Use it for Getting current deposit status in case when deposit begin transaction return mode ‘hpf, status_request ,direct’

Request (GET)

/gateway/financials/{brand_id}/{version}/deposit/state/{ref_id}

Parameters:

Name In Type Required Description
version path string true The API version to use, for any version higher than 3.0, response will be async, and should be fetched from Status API.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
ref_id path int true Deposit reference number.
x-auth-token header string true Player login session.

Response

Status 200

{
  "status_id": 1,
  "status_name": "Approved,Declined,Pending",
  "redirect_url": "https://3dsuri.com/redirect",
  "is_completed": true
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

Status 403

{
  "result": "deposit_limit"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Type Description
status_name string status of request.
redirect_url string link for 3ds.
is_completed string indication if response is final.

Actions (By response fields):

Is Completed Field Status Name Field Description
true ALL finite status of request, stop sending request.
false Initialized and redirect_url is empty close window and call for status behind the scenes.
false ALL continue sending status requests.

Deposit Payment Methods

This method retrieves all the payment methods that are available for making deposits for a specific country. use gateway.[msdomain]

Request (GET)

/gateway/financials/{version}/{brand_id}/payment/methods/2.0/{country}

Parameters:

Name In Type Required Description
version path string true The API version to use, for any version higher than 3.0, response will be async, and should be fetched from Status API.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
country path string true Player requested country, each country might contain different list of methods.
x-auth-token header string true Player login session.

Response

Status 200

{
  "payment_methods": "[{\"id\":1,\"name\":\"Visa\",\"provider_id\":35,\"description\":\"\",\"logo_url\":\"https://promo.testcasino.com/static-resources/payment_methods/my_account/visa-165x50.png\",\"order\":3,\"min_approved_deposits\":0,\"max_approved_deposits\":10000,\"active\":true,\"country\":[\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AN\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"],\"currency\":[{\"name\":\"CAD\",\"min\":20,\"max\":5000,\"rate_to_euro\":0.689829976032,\"fee\":4,\"active\":true},{\"name\":\"EUR\",\"min\":20,\"max\":5000,\"rate_to_euro\":1,\"fee\":0,\"active\":true},{\"name\":\"GBP\",\"min\":20,\"max\":5000,\"rate_to_euro\":1.1667130837039998,\"fee\":2,\"active\":true},{\"name\":\"INR\",\"min\":1,\"max\":10000000,\"rate_to_euro\":0.013474511615999999,\"fee\":4,\"active\":true},{\"name\":\"USD\",\"min\":20,\"max\":5000,\"rate_to_euro\":0.92608904680444,\"fee\":2.22,\"active\":true}]},{\"id\":442,\"name\":\"CryptoDL\",\"provider_id\":36,\"description\":\"\",\"logo_url\":\"https://promo.testcasino.com/static-resources/\",\"order\":2,\"min_approved_deposits\":0,\"max_approved_deposits\":1000000,\"active\":true,\"country\":[\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AN\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"],\"currency\":[{\"name\":\"CAD\",\"min\":20,\"max\":5000,\"rate_to_euro\":0.689829976032,\"fee\":4,\"active\":false},{\"name\":\"EUR\",\"min\":20,\"max\":5000,\"rate_to_euro\":1,\"fee\":0,\"active\":false},{\"name\":\"GBP\",\"min\":20,\"max\":5000,\"rate_to_euro\":1.1667130837039998,\"fee\":2,\"active\":false},{\"name\":\"USD\",\"min\":20,\"max\":5000,\"rate_to_euro\":0.92608904680444,\"fee\":2.22,\"active\":false},{\"name\":\"USDT\",\"min\":0,\"max\":5000,\"rate_to_euro\":0.909230399808,\"fee\":4,\"active\":true}]}]",
  "min_deposit": "-1",
  "deposit_state": false
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

401 Response, in case of some addition requirement needed before proceeding

Error Code Description
INCOMPLETE_REGISTRATION The player did not complete his registration process, need to complete Registration Step Two.
TNC_APPROVAL_REQUIRED Player need to approve TnC.
PRIVACY_APPROVAL_REQUIRED Player need to approve Privacy Policy.
PASSWORD_CHANGE_REQUIRED Player has temp password and need to Change Password.
EMAIL_NOT_VERIFIED Player email is not verified and cannot continue any process till he verifies his mail. 
{
  "result": "INCOMPLETE_REGISTRATION"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Type Description
payment_methods array array of object which will contain payment methods data: 1. Method ID. 2. Provider ID. 3. Min/Max values. 4. Logo…

Deposit Cascading Available

Request (GET)

/gateway/financials/{brand_id}/{version}/deposit/has-cascading/{ref_id}

Parameters:

Name In Type Required Description
version path string true The API version to use, for any version higher than 3.0, response will be async, and should be fetched from Status API.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
ref_id path int true Deposit reference number.
x-auth-token header string true Player login session.

Response

Status 200

{
  true/false
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Player Last Deposit

This API returns information about the player’s last deposit.

You can use this method to set the default values in the deposit page. For example, if a player deposits money from a country that is different from their registered country, you can set the last used country as the default country for future deposits. use gateway.[msdomain]

Request (GET)

/gateway/financials/{brand_id}/{version}/player/deposit

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string true Player login session.

Response

Status 200

{
  "updateDate": "YYY-MM-DD hh:mm:ss",
  "depositAmount": 0,
  "depositCurrency": "EUR",
  "paymentMethodId": 7,
  "countryCode": "DE"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
updateDate last approved deposit time.
depositAmount deposit Amount.
depositCurrency deposit Currency.
paymentMethodId deposit payment methiod id.
countryCode player login country.

Deposit Cascading Continue

Request (POST)

/gateway/financials/{brand_id}/{version}/deposit/continue-cascading/{ref_id}

Parameters:

Name In Type Required Description
version path string true The API version to use, for any version higher than 3.0, response will be async, and should be fetched from Status API.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
ref_id path int true Deposit reference number.
x-auth-token header string true Player login session.

Response

Status 200

{
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Credit Card Validation

This API validate credit card details.

Request (POST)

/gateway/financials/:brand_id/:version/deposit/validation/:method_id

{
  "cc_number": "4111111111111111"
}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string true The ID of the casino.
method_id path string true ID of method to validate the credit card in front of.
cc_number body string true credit card number to validate, only numbers.
x-auth-token header string true Player login session.

Response

Status 200

{
  "status": "Success",
  "message": "CC_VALID"
}

400 Response

{
  "status": "Failure",
  "message": "BAD_REQUEST"
}
{
  "status": "Failure",
  "message": "CC_EMPTY"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

Status 422

  {
  "status": "Failure",
  "message": "CC_INVALID"
}

Status 500

  {
  "status": "Error",
  "message": "INTERNAL_SERVER_ERROR"
}

Cashier Events

Request (POST)

/gateway/financials/{brand_id}/{version}/cashier-events

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true none
X-Auth-Token header string true header received from ‘Login’ 
{
  "ref_id": 1,
  "event": "Close Window"
}

Response

Status 200

{
  "status": "Success",
  "data": {
    "brand_id": 1,
    "player_id": 123456,
    "ref_id": 1,
    "event": "Close Window"
  }
}

Status 400

{
  "status": "Error",
  "data": {
    "brand_id": 1,
    "player_id": 123456,
    "ref_id": 1,
    "event": "Close Window"
  },
  "message": "invalid deposit ref id",
  "userFriendlyMessage": "invalid deposit ref id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "status": "Error",
  "data": {
    "brand_id": 1,
    "player_id": 123456,
    "ref_id": 1,
    "event": "Close Window"
  },
  "message": "error saving cashier event",
  "userFriendlyMessage": "error saving cashier event"
}