Show Menu

Beneficiary User Wallets

Get Beneficiary User Wallets

You can get a list of wallet for a particular user.

post/API/V4/Wallet/GetUserWallets

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

User IDstring

String length: inclusive between 1 and 25

Reponse Parameters

Walletsstring

Returned if successful List of User Wallets found. For each Wallet the following parameters are returned:
WalletID—Wallet ID
WalletName—Wallet name
WalletCurrency— Wallet currency name

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Wallet/GetUserWallets

{
    "GetUserWallets": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",
             "UserID":"PAT Account Number"
        }
    }
}
						

Sample Response:


{
	"GetUserWalletsResponse": {
		"GetUserWalletsResult": {
			"Wallets":  [
					{
						"WalletID": 3170,
						"WalletName": "Fund Account",
						"WalletCurrency": "USD"
					},
					{
						"WalletID": 3171,
						"WalletName": "Fund Account",
						"WalletCurrency": "GBP"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
}