Methods
#
(static) cancelWithdraw(options) → {Promise.<void>}
Returns statistics about player payments. See
ims docs
Parameters:
| Name |
Type |
Description |
options |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
transactionCode |
string
|
<optional>
|
|
reason |
string
|
<optional>
|
|
|
Returns:
-
Type
-
Promise.<void>
Example
Playtech.API.payments.cancelWithdraw(params).then(() => { ... });
#
(static) deposit(options) → {Promise.<void>}
Creates deposit request.
Parameters:
| Name |
Type |
Description |
options |
Object
|
|
Returns:
-
Type
-
Promise.<void>
Example
Playtech.API.payments.deposit(params).then(() => { ... });
#
(static) getBalanceHistory(options) → {Promise.<{Object}>}
Returns balance change history of player's published balances. See
ims docs
Parameters:
| Name |
Type |
Description |
options |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
startDate |
string
|
<optional>
|
|
endDate |
string
|
<optional>
|
|
clientType |
string
|
<optional>
|
|
orderByDate |
string
|
<optional>
|
|
returnSummary |
string
|
<optional>
|
|
transactionGroups |
string
|
<optional>
|
|
ignorePlayerViewConf |
boolean
|
<optional>
|
|
ignoreStartingEndingBalances |
boolean
|
<optional>
|
|
pagerRequest |
Object
|
<optional>
|
|
|
Returns:
{ pagerResponse: Object, endingBalances: Array, startingBalances: Array, walletTransactions: Array, defaultTypeNames: Array, usedTagsDefaults: Array, usedTemplates: Array, summary: Object }
-
Type
-
Promise.<{Object}>
Example
Playtech.API.payments.getBalanceHistory(params).then((data) => { ... });
#
(static) getDetailedTransactionHistory(options) → {Promise.<{pagingResponseParams: Object, transactions: Array, historyResponseSummary: Object}>}
Returns information about player's transactions. See
ims docs
Parameters:
| Name |
Type |
Description |
options |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
clientPlatform |
string
|
<optional>
|
|
cancellations |
string
|
<optional>
|
|
corrections |
string
|
<optional>
|
|
endTime |
string
|
<optional>
|
|
excludePaymentRequests |
string
|
<optional>
|
|
historyRequestSummary |
string
|
<optional>
|
|
pagingRequestParams |
Object
|
|
Properties
| Name |
Type |
Description |
returnTotalCount |
boolean
|
|
pageSize |
number
|
|
pageId |
string
|
|
returnAllPageIds |
boolean
|
|
|
reason |
string
|
<optional>
|
|
startTime |
string
|
<optional>
|
|
status |
string
|
<optional>
|
|
transactionCode |
string
|
<optional>
|
|
type |
string
|
<optional>
|
|
|
Returns:
-
Type
-
Promise.<{pagingResponseParams: Object, transactions: Array, historyResponseSummary: Object}>
Example
Playtech.API.payments.getDetailedTransactionHistory(params).then((data) => { ... });
#
(static) getPaymentStatistics() → {Promise.<{Object}>}
Returns statistics about player payments.
Returns:
{ deposits: {firstDepositDate: string, lastDepositDate: string, totalDepositAmount: string, totalDepositCount: string}, withdrawals: {approvedWithdrawRequestsCount: string, lastWithdrawRequestDate: string, pendingWithdrawRequestsCount: string} }
-
Type
-
Promise.<{Object}>
Example
Playtech.API.payments.getPaymentStatistics().then((data) => { ... });
#
(static) getTransactionHistory(options) → {Promise.<{payments: Object, maxResultsExceeded: boolean}>}
Returns customizable list of all payment transactions for a user based on criteria. See
ims docs
Parameters:
| Name |
Type |
Description |
options |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
type |
string
|
<optional>
|
Values: "Deposit"|"Withdraw". Type of transactions |
status |
string
|
<optional>
|
Values: "Pending"|"Waiting"|"Approved"|"Declined"|"Cancelled". Status of the transactions |
startTime |
string
|
<optional>
|
Filter by date in ISO8601. Cannot be further than 3 months ago |
endTime |
string
|
<optional>
|
Filter by date in ISO8601 format. Maximum 7 days from startTime |
corrections |
string
|
<optional>
|
To include correction transactions or not |
|
Returns:
-
Type
-
Promise.<{payments: Object, maxResultsExceeded: boolean}>
Example
Playtech.API.payments.getTransactionHistory({type: 'Deposit', status: 'Approved'}).then((data) => { ... });