Show Menu

Company Wallets

Get Company Wallets

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

post/API/v4/Wallet/GetCompanywallets

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

Reponse Parameters

WalletDetailsstring

Returned if successful List of Company Wallets found. For each Wallet the following parameters are returned:
WalletID—Wallet ID
WalletName—Wallet name
WalletCurrency— Wallet currency name
WalletBalance—Wallet balance
WalletType—Standard or Accrual

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/GetCompanywallets

{
    "GetCompanywallets": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number"
        }
    }
}
						

Sample Response:


{
	"GetCompanyWalletResponse": {
		"CompanyWalletResult": {
			"CompanyWallets": {
				"CompanyWalletDetails": [
					{
						"WalletID": 3170,
						"WalletName": "Fund Account",
						"WalletCurrency": "USD",
						"WalletBalance": 55839.00,
                        "WalletType": "Standard"
					},
					{
						"WalletID": 3171,
						"WalletName": "Fund Account",
						"WalletCurrency": "GBP",
						"WalletBalance": 5000.00,
                        "WalletType": "Accrual"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}