August 12, 2025
8min read
Wallet Dispatcher Web API Client
It provides a secure and straightforward way for external applications to interact with the wallet system. It enables seamless integration, ensuring reliable data exchange in JSON format, with a focus on performance, security, and ease of implementation.
GetUserBalance
Retrieves the current balance for the specified user or wallet. This request can return the default wallet balance for the user, or, if a WalletId is provided, the balance of that specific wallet.
Endpoint
POST /api/WalletDispatcher/GetUserBalance
Request Parameters
JSON Object
{
"traceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": "string",
"accountId": 0,
"walletId": "string"
}Field Details
| Parameters | Type | Required | Description |
| traceId | Guid? | No | Optional identifier used to track the request across the system. |
| userId | string | Yes | ID of the user whose wallet balance is being retrieved. |
| accountId | int | Yes | ID of the account for whom the data is being retrieved. |
| walletId | string? | No | Optional ID used when retrieving the balance of a specific wallet. |
Response Fields
JSON Object
{
"isSuccess": true,
"errorMessage": null,
"errorCode": null,
"userBalance": {
"userId": "bf0553a0-6677-43fb-ad70-9c5460c1b350",
"walletBalances": [
{
"walletId": "1f298b1e-0368-4d75-a09e-c442b10f84ac",
"accountWallet": {
"accountId": 224,
"accountWalletId": 3,
"accountWalletName": "SP BAM Wallet",
"currency": "BAM"
},
"balance": 875.2,
"reservedBalance": 0,
"availableBalance": 875.2,
"transactionId": "",
"transactionAmount": 0
},
{
"walletId": "2c0d335c-cac7-40cf-8072-81c48a24bff6",
"accountWallet": {
"accountId": 224,
"accountWalletId": 4,
"accountWalletName": "SP Bonus BAM Wallet",
"currency": "BAM"
},
"balance": 0,
"reservedBalance": 0,
"availableBalance": 0,
"transactionId": "",
"transactionAmount": 0
}
]
}
}Field Details
| Field Name | Type | Description |
| isSuccess | bool | Indicates whether the request is success. |
| errorMessage | string? | Text description of the error, returned only if the request was not successful. |
| errorCode | int? | Numeric code representing the specific error that occurred, optionally returned when the request fails. |
| userBalance | UserBalance | Object containing a list of the user’s wallet balances. |
GetUserBalance Related Errors
Field Details
| Error Code | Error Name | Error Description |
GetUserWalletTransactions
Retrieves a list of a user’s wallet transactions, with optional filters.
Endpoint
POST /api/WalletDispatcher/GetUserWalletTransactions
Request Parameters
JSON Object
{
"traceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountId": 0,
"userId": "string",
"walletId": "string",
"transactionTypeId": 0,
"transactionSourceId": 0,
"transactionId": "string",
"fromDateTime": "2025-08-13T08:50:17.907Z",
"toDateTime": "2025-08-13T08:50:17.907Z",
"limit": 0
}Field Details
| Parameters | Type | Required | Description |
| traceId | Guid? | No | Optional identifier used to track the request across the system. |
| accountId | int | Yes | ID of the user whose wallet balance is being retrieved. |
| userId | string? | No | ID of the account for whom the data is being retrieved. |
| walletId | string? | No | Optional ID used when retrieving the balance of a specific wallet. |
| transactionTypeId | int? | No | |
| transactionSourceId | int? | No | |
| transactionId | string? | No | |
| fromDateTime | DateTime? | No | |
| toDateTime | DateTime? | No | |
| limit | int | No |
Response Fields
JSON Object
{
"isSuccess": true,
"errorMessage": null,
"errorCode": null,
"walletTransactions": [
{
"transactionId": "205a0fc2-3092-44a2-92f4-3b16ba8cff36",
"transactionTypeId": 13,
"amount": 0.2,
"time": "2025-04-21T07:50:25.4177535",
"transactionSourceId": 9,
"externalId": "312306651231",
"accountId": 224,
"userId": "bf0553a0-6677-43fb-ad70-9c5460c1b350",
"walletId": "3",
"additionalFields": {}
},
{
"transactionId": "ef8277d3-68cf-4bd1-915d-f432fd1bfa44",
"transactionTypeId": 1,
"amount": 3,
"time": "2025-04-24T09:08:20.5827913",
"transactionSourceId": 7,
"externalId": "9bccea3c-e8d6-4e94-9f28-54964fb0c7af",
"accountId": 224,
"userId": "bf0553a0-6677-43fb-ad70-9c5460c1b350",
"walletId": "3",
"additionalFields": {}
}
]
}Field Details
| Field Name | Type | Description |
| isSuccess | bool | Indicates whether the request is success. |
| errorMessage | string? | Text description of the error, returned only if the request was not successful. |
| errorCode | int? | Numeric code representing the specific error that occurred, optionally returned when the request fails. |
| walletTransactions | List<WalletTransaction> | Object containing a list of the user’s wallet balances. |
GetUserWalletTransactions Related Errors
Field Details
| Error Code | Error Name | Error Description |
GetUserBySession
Retrieves the user information associated with a given session. This allows identifying the user based on their active session without requiring their explicit user ID.
Endpoint
POST /api/WalletDispatcher/GetUserBySession
Request Parameters
JSON Object
{
"traceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountId": 0,
"sessionId": "string"
}Field Details
| Parameters | Type | Required | Description |
| traceId | Guid? | No | Optional identifier used to track the request across the system. |
| accountId | int | Yes | ID of the user whose wallet balance is being retrieved. |
| sessionId | string | Yes | Identifier of the user’s active session used to retrieve associated user information. |
Response Fields
JSON Object
{
"isSuccess": true,
"errorMessage": null,
"errorCode": null,
"userId": "example-user-id",
"username": "example-username"
}Field Details
| Field Name | Type | Description |
| isSuccess | bool | Indicates whether the request is success. |
| errorMessage | string? | Text description of the error, returned only if the request was not successful. |
| errorCode | int? | Numeric code representing the specific error that occurred, optionally returned when the request fails. |
| userId | string | Identifier of the user associated with the session. |
| username | string | The user’s login name or display name associated with the session. |
GetUserBySession Related Errors
Field Details
| Error Code | Error Name | Error Description |
ProcessWalletTransaction
Executes a wallet transaction for the specified user and account, adjusting the wallet balance based on the provided transaction details.
Endpoint
POST /api/WalletDispatcher/ProcessWalletTransaction
Request Parameters
JSON Object
{
"traceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"walletTransaction": {
"transactionId": "string",
"transactionTypeId": 0,
"amount": 0,
"time": "2025-08-13T12:12:05.236Z",
"transactionSourceId": 0,
"transactionSourceType": 0,
"referencedTransactionId": "string",
"externalId": "string",
"accountId": 0,
"userId": "string",
"transactionSegmentationModel": 0,
"walletId": "string",
"referencedExternalId": "string",
"additionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
}Field Details
| Parameters | Type | Required | Description |
| traceId | Guid? | No | Optional identifier used to track the request across the system. |
| walletTransaction | WalletTransaction | Yes | Represents a single wallet transaction. |
Response Fields
JSON Object
{
"isSuccess": true,
"errorMessage": null,
"errorCode": null,
"errorEnumValue": null,
"transactionId": "string?",
"userBalance": {
"userId": "bf0553a0-6677-43fb-ad70-9c5460c1b350",
"walletBalances": [
{
"walletId": "1f298b1e-0368-4d75-a09e-c442b10f84ac",
"accountWallet": {
"accountId": 224,
"accountWalletId": 3,
"accountWalletName": "SP BAM Wallet",
"currency": "BAM"
},
"balance": 875.2,
"reservedBalance": 0,
"availableBalance": 875.2,
"transactionId": "",
"transactionAmount": 0
},
{
"walletId": "2c0d335c-cac7-40cf-8072-81c48a24bff6",
"accountWallet": {
"accountId": 224,
"accountWalletId": 4,
"accountWalletName": "SP Bonus BAM Wallet",
"currency": "BAM"
},
"balance": 0,
"reservedBalance": 0,
"availableBalance": 0,
"transactionId": "",
"transactionAmount": 0
}
]
}
}Field Details
| Field Name | Type | Description |
| isSuccess | bool | Indicates whether the request is success. |
| errorMessage | string? | Text description of the error, returned only if the request was not successful. |
| errorCode | int? | Numeric code representing the specific error that occurred, optionally returned when the request fails. |
| errorEnumValue | WalletError? | |
| transactionId | string? | |
| userBalance | UserBalance | Object containing a list of the user’s wallet balances. |
ProcessWalletTransaction Related Errors
Field Details
| Error Code | Error Name | Error Description |
Wallet Dispatcher Common Errors
Field Details
| Error Code | Error Name | Error Description |
| 100 | SESSION_NOT_FOUND | The specified session could not be found or is no longer valid. |
| 101 | USER_NOT_FOUND | The specified user could not be found. |
| 102 | USER_WALLET_NOT_FOUND | The specified user wallet could not be found. |
| 103 | TRANSACTION_SOURCE_NOT_FOUND | The specified transaction source could not be found. |
| 104 | NOT_ENOUGH_FUNDS | The wallet does not have sufficient balance to complete the transaction. |
| 105 | TRANSACTION_TYPE_NOT_FOUND | The specified transaction type is invalid or does not exist. |
| 106 | REFERENCED_TRANSACTION_NOT_FOUND | The transaction referenced could not be found. |
| 107 | REFERENCED_TRANSACTION_DUPLICATE_ACTION | The referenced transaction has already been processed with the same action. |
| 108 | ACCOUNT_WALLET_NOT_FOUND | The wallet for the specified account could not be found. |
| 109 | INTERNAL_ERROR | An unexpected error occurred within the system. |
| 110 | REFERENCED_TRANSACTION_CANCELLED | The referenced transaction has been cancelled and cannot be processed. |
| 111 | TRANSACTION_SEGMENTATION_MODEL_NOT_FOUND | The specified transaction segmentation model could not be found. |
| 112 | DUPLICATE_EXTERNAL_ID | The provided external ID has already been used for another transaction. |
Entities
UserBalance
JSON Object
{
"userId": "bf0553a0-6677-43fb-ad70-9c5460c1b350",
"walletBalances": [
{
"walletId": "1f298b1e-0368-4d75-a09e-c442b10f84ac",
"accountWallet": {
"accountId": 224,
"accountWalletId": 3,
"accountWalletName": "SP BAM Wallet",
"currency": "BAM"
},
"balance": 875.2,
"reservedBalance": 0,
"availableBalance": 875.2,
"transactionId": "",
"transactionAmount": 0
}
]
}Field Details
| Field Name | Field Type | Description |
| userId | string | ID of the user whose wallet balances are being retrieved. |
| walletBalances | List<WalletBalance> | Contains a list of objects type WalletBalance. |
References in documentation: GetUserBalance, ProcessWalletTransaction
WalletBalance
JSON Object
{
"walletId": "1f298b1e-0368-4d75-a09e-c442b10f84ac",
"accountWallet": {
"accountId": 224,
"accountWalletId": 3,
"accountWalletName": "SP BAM Wallet",
"currency": "BAM"
},
"balance": 875.2,
"reservedBalance": 0,
"availableBalance": 875.2,
"transactionId": "",
"transactionAmount": 0
}Field Details
| Field Name | Field Type | Description |
| walletId | string | ID of the user whose wallet balances are being retrieved. |
| accountWallet | AccountWallet | Contains a list of objects type WalletBalance. |
| balance | decimal | |
| reservedBalance | decimal | |
| availableBalance | decimal | |
| transactionId | string? | |
| transactionAmount | decimal |
References in documentation: UserBalance
AccountWallet
JSON Object
{
"accountId": 224,
"accountWalletId": 3,
"accountWalletName": "SP BAM Wallet",
"currency": "BAM"
}Field Details
| Field Name | Field Type | Description |
| accountId | int | ID of the user whose wallet balances are being retrieved. |
| accountWalletId | int | Contains a list of objects type WalletBalance. |
| accountWalletName | string | |
| currency | string |
References in documentation: WalletBalance
WalletTransaction
JSON Object
{
"transactionId": "205a0fc2-3092-44a2-92f4-3b16ba8cff36",
"transactionTypeId": 13,
"amount": 0.2,
"time": "2025-04-21T07:50:25.4177535",
"transactionSourceId": 9,
"externalId": "312306651231",
"accountId": 224,
"userId": "bf0553a0-6677-43fb-ad70-9c5460c1b350",
"walletId": "3",
"additionalFields": {}
}Field Details
| Field Name | Field Type | Description |
| transactionId | string? | Unique identifier of the transaction. |
| transactionTypeId | int | Identifier of the type of the transaction being performed. |
| amount | decimal | The monetary value involved in the transaction. |
| time | DateTime | The date and time when the transaction was created or processed. |
| transactionSourceId | int | Identifier of the source from which the transaction originated. |
| transactionSourceType | TransactionSourceType? | The type or category of the source from which the transaction originated. |
| referencedTransactionId | string? | Identifier of the transaction that this transaction references, if applicable. |
| externalId | string? | Optional identifier provided by an external system to reference the transaction. |
| accountId | int | Identifier of the account associated with the transaction. |
| userId | string | Identifier of the user associated with the transaction. |
| transactionSegmentationModel | int? | The model used to segment or categorize the transaction, if applicable. |
| walletId | string? | Optional identifier of the specific wallet associated with the transaction. |
| referencedExternalId | string? | Optional external identifier of a transaction that this transaction references. |
| additionalFields | Dictionary<string, string> | A dictionary of key-value pairs for any additional information related to the transaction. |
References in documentation: GetUserWalletTransactions, ProcessWalletTransaction
TransactionSourceType
Enum Details
| Field Name | Description |
| GAME_PROVIDER | Transaction originated from a game provider. |
| BANK | Transaction originated from a bank. |
| PAYMENT_GATEWAY | Transaction originated from a payment gateway. |
| AWARD | Transaction originated from a reward or award system. |
| RESERVATION | Transaction originated from a reservation or booking system. |
References in documentation: WalletTransaction
HTTP Status Codes
HTTP response status codes indicate whether a specific HTTP request has been successfully completed. Responses are grouped in five classes:
- Informational responses (100 – 199)
- Successful responses (200 – 299)
- Redirection messages (300 – 399)
- Client error responses (400 – 499)
- Server error responses (500 – 599)
Informational Responses Details
| Status Code | Short | Description |
| 100 | Continue | This interim response indicates that the client should continue the request or ignore the response if the request is already finished. |
| 101 | Switching Protocols | This code is sent in response to an Upgrade request header from the client and indicates the protocol the server is switching to. |
| 102 | Processing | This code was used in WebDAV contexts to indicate that a request has been received by the server, but no status was available at the time of the response. |
| 103 | Early Hints | This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources. |
Successful Responses Details
| Status Code | Short | Description |
| 200 | OK | The request succeeded. The result and meaning of “success” depends on the HTTP method: GET: The resource has been fetched and transmitted in the message body. HEAD: Representation headers are included in the response without any message body. PUT or POST: The resource describing the result of the action is transmitted in the message body. TRACE: The message body contains the request as received by the server. |
| 201 | Created | The request succeeded, and a new resource was created as a result. This is typically the response sent after POST requests, or some PUT requests. |
| 202 | Accepted | The request has been received but not yet acted upon. It is noncommittal, since there is no way in HTTP to later send an asynchronous response indicating the outcome of the request. It is intended for cases where another process or server handles the request, or for batch processing. |
| 203 | Non-Authoritative Information | This response code means the returned metadata is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy. This is mostly used for mirrors or backups of another resource. Except for that specific case, the 200 OK response is preferred to this status. |
| 204 | No Content | There is no content to send for this request, but the headers are useful. The user agent may update its cached headers for this resource with the new ones. |
| 205 | Reset Content | Tells the user agent to reset the document which sent this request. |
| 206 | Partial Content | This response code is used in response to a range request when the client has requested a part or parts of a resource. |
| 207 | Multi-Status | Conveys information about multiple resources, for situations where multiple status codes might be appropriate. |
| 208 | Already Reported | Used inside a <dav:propstat> response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection. |
| 226 | IM Used | The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. |
Redirection Responses Details
| Status Code | Short | Description |
| 300 | Multiple Choices | In agent-driven content negotiation, the request has more than one possible response and the user agent or user should choose one of them. There is no standardized way for clients to automatically choose one of the responses, so this is rarely used. |
| 301 | Moved Permanently | The URL of the requested resource has been changed permanently. The new URL is given in the response. |
| 302 | Found | This response code means that the URI of requested resource has been changed temporarily. Further changes in the URI might be made in the future, so the same URI should be used by the client in future requests. |
| 303 | See Other | The server sent this response to direct the client to get the requested resource at another URI with a GET request. |
| 304 | Not Modified | This is used for caching purposes. It tells the client that the response has not been modified, so the client can continue to use the same cached version of the response. |
| 305 | Use Proxy | Defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy. It has been deprecated due to security concerns regarding in-band configuration of a proxy. |
| 306 | unused | This response code is no longer used; but is reserved. It was used in a previous version of the HTTP/1.1 specification. |
| 307 | Temporary Redirect | The server sends this response to direct the client to get the requested resource at another URI with the same method that was used in the prior request. This has the same semantics as the 302 Found response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the redirected request. |
| 308 | Permanent Redirect | This means that the resource is now permanently located at another URI, specified by the Location response header. This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request. |
Client Error Responses Details
| Status Code | Short | Description |
| 400 | Bad Request | The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
| 401 | Unauthorized | Although the HTTP standard specifies “unauthorized”, semantically this response means “unauthenticated”. That is, the client must authenticate itself to get the requested response. |
| 402 | Payment Required | The initial purpose of this code was for digital payment systems, however this status code is rarely used and no standard convention exists. |
| 403 | Forbidden | The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client’s identity is known to the server. |
| 404 | Not Found | The server cannot find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web. |
| 405 | Method Not Allowed | The request method is known by the server but is not supported by the target resource. For example, an API may not allow DELETE on a resource, or the TRACE method entirely. |
| 406 | Not Acceptable | This response is sent when the web server, after performing server-driven content negotiation, doesn’t find any content that conforms to the criteria given by the user agent. |
| 407 | Proxy Authentication Required | This is similar to 401 Unauthorized but authentication is needed to be done by a proxy. |
| 408 | Request Timeout | This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers use HTTP pre-connection mechanisms to speed up browsing. Some servers may shut down a connection without sending this message. |
| 409 | Conflict | This response is sent when a request conflicts with the current state of the server. In WebDAV remote web authoring, 409 responses are errors sent to the client so that a user might be able to resolve a conflict and resubmit the request. |
| 410 | Gone | This response is sent when the requested content has been permanently deleted from server, with no forwarding address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for “limited-time, promotional services”. APIs should not feel compelled to indicate resources that have been deleted with this status code. |
| 411 | Length Required | Server rejected the request because the Content-Length header field is not defined and the server requires it. |
| 412 | Precondition Failed | In conditional requests, the client has indicated preconditions in its headers which the server does not meet. |
| 413 | Content Too Large | The request body is larger than limits defined by server. The server might close the connection or return an Retry-After header field. |
| 414 | URI Too Long | The URI requested by the client is longer than the server is willing to interpret. |
| 415 | Unsupported Media Type | The media format of the requested data is not supported by the server, so the server is rejecting the request. |
| 416 | Range Not Satisfiable | The ranges specified by the Range header field in the request cannot be fulfilled. It’s possible that the range is outside the size of the target resource’s data. |
| 417 | Expectation Failed | This response code means the expectation indicated by the Expect request header field cannot be met by the server. |
| 418 | I’m a teapot | The server refuses the attempt to brew coffee with a teapot. |
| 421 | Misdirected Request | The request was directed at a server that is not able to produce a response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI. |
| 422 | Unprocessable Content | The request was well-formed but was unable to be followed due to semantic errors. |
| 423 | Locked | The resource that is being accessed is locked. |
| 424 | Failed Dependency | The request failed due to failure of a previous request. |
| 425 | Too Early | Indicates that the server is unwilling to risk processing a request that might be replayed. |
| 426 | Upgrade Required | The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. The server sends an Upgrade header in a 426 response to indicate the required protocol(s). |
| 428 | Precondition Required | The origin server requires the request to be conditional. This response is intended to prevent the ‘lost update’ problem, where a client GETs a resource’s state, modifies it and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict. |
| 429 | Too Many Requests | The user has sent too many requests in a given amount of time (rate limiting). |
| 431 | Request Header Fields Too Large | The server is unwilling to process the request because its header fields are too large. The request may be resubmitted after reducing the size of the request header fields. |
| 451 | Unavailable For Legal Reasons | The user agent requested a resource that cannot legally be provided, such as a web page censored by a government. |
Server Error Responses Details
| Status Code | Short | Description |
| 500 | Internal Server Error | The server has encountered a situation it does not know how to handle. This error is generic, indicating that the server cannot find a more appropriate 5XX status code to respond with. |
| 501 | Not Implemented | The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD. |
| 502 | Bad Gateway | This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response. |
| 503 | Service Unavailable | The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached. |
| 504 | Gateway Timeout | This error response is given when the server is acting as a gateway and cannot get a response in time. |
| 505 | HTTP Version Not Supported | The HTTP version used in the request is not supported by the server. |
| 506 | Variant Also Negotiates | The server has an internal configuration error: during content negotiation, the chosen variant is configured to engage in content negotiation itself, which results in circular references when creating responses. |
| 507 | Insufficient Storage | The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. |
| 508 | Loop Detected | The server detected an infinite loop while processing the request. |
| 510 | Not Extended | The client request declares an HTTP Extension (RFC 2774) that should be used to process the request, but the extension is not supported. |
| 511 | Network Authentication Required | Indicates that the client needs to authenticate to gain network access. |
Reach us on WApp
