Show Menu

Create Beneficiary Company Wallet

Create Beneficiary Company Wallet

This allows you to create beneficiary company wallets and specify wallet currency.

post/API/V4/Wallet/CreateBeneficiaryCompanyWallet

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

BeneficiaryAccountNumberstring

String length: inclusive between 1 and 25

WalletNamestring

String length: inclusive between 1 and 100

WalletCurrencystring

String length: 3

WalletTypestring

String: Allowed values are "Standard" or "Accrual"

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

{
  "CreateBeneficiaryCompanyWallet": {
    "request": {
    	"IssuerAccountNumber":"SPN Account Number",
        "BeneficiaryAccountNumber":"SPN Account Number",
    	"WalletName": "Wallet Name",
        "WalletCurrency": "Currency Code",
        "WalletType":"Standard/Accrual"
    }
  }
}
						

Sample Response:


{
	"CreateBeneficiaryCompanyWalletResponse": {
		"CreateBeneficiaryCompanyWalletResult": {
			"WalletID": 101428,
			"WalletName": "GBP API Wallet 22",
			"WalletCurrency": "GBP",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}