AsyncAPI for wallet service 0.0.1 documentation
- Specification ID:
urn:net:accelbyte:platform:wallet - Protobuf File Spec: wallet.proto
- Default content type: application/json
Table of Contents
Operations
PUB walletProcessing Operation
Accepts one of the following messages:
Message walletDisabled
message is sent when wallet is disabled
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.walletStatusChange | object | - | - | - | additional properties are allowed |
| payload.walletStatusChange.walletId | string | wallet id | - | - | - |
| payload.walletStatusChange.userId | string | user id | - | - | - |
| payload.walletStatusChange.status | string | wallet status | - | - | - |
| payload.walletStatusChange.previousStatus | string | wallet status before change | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | event id | - | - | - |
| version | integer | - | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | event namespace | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | client id | - | - | - |
| userId | string | the operator id | - | - | - |
| traceId | string | trace id | - | - | - |
| sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"walletStatusChange": {
"walletId": "string",
"userId": "string",
"status": "string",
"previousStatus": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message walletEnabled
message is sent when wallet is enabled
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.walletStatusChange | object | - | - | - | additional properties are allowed |
| payload.walletStatusChange.walletId | string | wallet id | - | - | - |
| payload.walletStatusChange.userId | string | user id | - | - | - |
| payload.walletStatusChange.status | string | wallet status | - | - | - |
| payload.walletStatusChange.previousStatus | string | wallet status before change | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | event id | - | - | - |
| version | integer | - | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | event namespace | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | client id | - | - | - |
| userId | string | the operator id | - | - | - |
| traceId | string | trace id | - | - | - |
| sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"walletStatusChange": {
"walletId": "string",
"userId": "string",
"status": "string",
"previousStatus": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message walletCredited
message is sent when credit wallet
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.walletBalanceChange | object | - | - | - | additional properties are allowed |
| payload.walletBalanceChange.walletId | string | wallet id | - | - | - |
| payload.walletBalanceChange.namespace | string | namespace | - | - | - |
| payload.walletBalanceChange.userId | string | user id | - | - | - |
| payload.walletBalanceChange.currencyCode | string | currency code | - | - | - |
| payload.walletBalanceChange.balance | integer | the balance after change | - | format (int64) | - |
| payload.walletBalanceChange.amount | integer | change amount, positive for both credit & debit | - | format (int64) | - |
| payload.walletBalanceChange.source | string | credit source | - | - | - |
| payload.walletBalanceChange.reason | string | reason | - | - | - |
| payload.walletBalanceChange.origin | string | origin | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | event id | - | - | - |
| version | integer | - | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | event namespace | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | client id | - | - | - |
| userId | string | the operator id | - | - | - |
| traceId | string | trace id | - | - | - |
| sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"walletBalanceChange": {
"walletId": "string",
"namespace": "string",
"userId": "string",
"currencyCode": "string",
"balance": 0,
"amount": 0,
"source": "string",
"reason": "string",
"origin": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message walletDebited
message is sent when debit wallet
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.walletBalanceChange | object | - | - | - | additional properties are allowed |
| payload.walletBalanceChange.walletId | string | wallet id | - | - | - |
| payload.walletBalanceChange.namespace | string | namespace | - | - | - |
| payload.walletBalanceChange.userId | string | user id | - | - | - |
| payload.walletBalanceChange.currencyCode | string | currency code | - | - | - |
| payload.walletBalanceChange.balance | integer | the balance after change | - | format (int64) | - |
| payload.walletBalanceChange.amount | integer | change amount, positive for both credit & debit | - | format (int64) | - |
| payload.walletBalanceChange.source | string | credit source | - | - | - |
| payload.walletBalanceChange.reason | string | reason | - | - | - |
| payload.walletBalanceChange.origin | string | origin | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | event id | - | - | - |
| version | integer | - | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | event namespace | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | client id | - | - | - |
| userId | string | the operator id | - | - | - |
| traceId | string | trace id | - | - | - |
| sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"walletBalanceChange": {
"walletId": "string",
"namespace": "string",
"userId": "string",
"currencyCode": "string",
"balance": 0,
"amount": 0,
"source": "string",
"reason": "string",
"origin": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message walledPaid
message is sent when pay with wallet
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.walletBalanceChange | object | - | - | - | additional properties are allowed |
| payload.walletBalanceChange.walletId | string | wallet id | - | - | - |
| payload.walletBalanceChange.namespace | string | namespace | - | - | - |
| payload.walletBalanceChange.userId | string | user id | - | - | - |
| payload.walletBalanceChange.currencyCode | string | currency code | - | - | - |
| payload.walletBalanceChange.balance | integer | the balance after change | - | format (int64) | - |
| payload.walletBalanceChange.amount | integer | change amount, positive for both credit & debit | - | format (int64) | - |
| payload.walletBalanceChange.source | string | credit source | - | - | - |
| payload.walletBalanceChange.reason | string | reason | - | - | - |
| payload.walletBalanceChange.origin | string | origin | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | event id | - | - | - |
| version | integer | - | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | event namespace | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | client id | - | - | - |
| userId | string | the operator id | - | - | - |
| traceId | string | trace id | - | - | - |
| sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"walletBalanceChange": {
"walletId": "string",
"namespace": "string",
"userId": "string",
"currencyCode": "string",
"balance": 0,
"amount": 0,
"source": "string",
"reason": "string",
"origin": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message walledExpired
message is sent when wallet balance is expired
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.walletBalanceChange | object | - | - | - | additional properties are allowed |
| payload.walletBalanceChange.walletId | string | wallet id | - | - | - |
| payload.walletBalanceChange.namespace | string | namespace | - | - | - |
| payload.walletBalanceChange.userId | string | user id | - | - | - |
| payload.walletBalanceChange.currencyCode | string | currency code | - | - | - |
| payload.walletBalanceChange.balance | integer | the balance after change | - | format (int64) | - |
| payload.walletBalanceChange.amount | integer | change amount, positive for both credit & debit | - | format (int64) | - |
| payload.walletBalanceChange.source | string | credit source | - | - | - |
| payload.walletBalanceChange.reason | string | reason | - | - | - |
| payload.walletBalanceChange.origin | string | origin | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | event id | - | - | - |
| version | integer | - | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | event namespace | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | client id | - | - | - |
| userId | string | the operator id | - | - | - |
| traceId | string | trace id | - | - | - |
| sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"walletBalanceChange": {
"walletId": "string",
"namespace": "string",
"userId": "string",
"currencyCode": "string",
"balance": 0,
"amount": 0,
"source": "string",
"reason": "string",
"origin": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}