Wallet API
Endpoint: {server}/api/wallet/v1/ — see Getting started for the server URL, authentication and JSON Web Tokens.
API Post Functions
getWalletAvailableBalance
Endpoint: {server}/api/wallet/v1/getWalletAvailableBalance
getWalletAvailableBalance: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
getWalletAvailableBalance: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| Status | Text | Y | Success or Failed |
| availableBalance | Decimal | Y | Current wallet Available Balance |
Example getWalletAvailableBalance Post:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJ7UFJPVklERUQgQVBJIEtFWX0iLCJhY2Nlc3NUb2tlbiI6IntQUk9WSURFRCBBQ0NFU1MgVE9LRU59IiwianRpIjoie1VOSVFVRSBWQUxVRX0iLCJpYXQiOjE1ODk5OTA5MDIsImV4cCI6MTU4OTk5MTUwMn0._Lk6FPqYITrJIUztulif8MdvuOMAVBZXZJEiBpdSwkw "
}
Example getWalletAvailableBalance response:
{
"jti": "{UNIQUE VALUE}",
"status": "Success",
"availableBalance": 123.45
}
getWalletStatement
Endpoint: {server}/api/wallet/v1/getWalletStatement
getWalletStatement: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| dateFrom | Date | O | A date to filter from |
| dateTo | Date | O | A date to filter to |
getWalletStatement: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| Status | Text | Y | Success |
| statement | Array | Y | 1-n of statement fields |
getWalletStatement: STATEMENT FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| date | Text | Y | Transaction date |
| description | Text | Y | Transaction description |
| amount | Text | Y | Transaction amount |
| balance | Text | Y | A cumulative balance |
Example getWalletStatement Post:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
Example getWalletStatement Response:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
Errors
If there is any submission error relating to authentication or missing fields the response fields will be:
- status: The status will be Error
- error: The error message
Example Error Message:
{
"status": "Error",
"error": "Token secret verify fail"
}