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