Show Menu

Create Beneficiary User Wallets

Create Beneficiary User Wallets

This allows you to create beneficiary user wallets and specify wallet currency. There can only be one wallet per currency. Note that you can also create user beneficary user wallets simple by using the transfer funds api. If you use transfer funds and the currency wallet doesnt exist for the beneficiary, it will create it for them.

post/API/v4/Wallet/CreateUserWallet

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

UserIDstring

String length: inclusive between 1 and 25

WalletNamestring

String length: inclusive between 1 and 100

WalletCurrencystring

String length: 3

Reponse Parameters

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

{
  "CreateUserWallet": {
    "request": {
        "IssuerAccountNumber":"SPN Account Number",
        "UserID": "PAT Account Number",
        "WalletName": "Wallet Name",
        "WalletCurrency": "Currency Code"
    }
  }
}

Sample Response:


{
	"CreateUserWalletResponse": {
		"CreateUserWalletResult": {
			"WalletID": 75429,
			"WalletName": "AnyPay",
			"WalletCurrency": "USD",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}

Why

Products

Developers

How It Works

Resources

Payment and foreign exchange transactions are powered and provided by Corpay. “Corpay” is the marketing trade name for the International Payment Solutions and Risk Management Solutions provided by certain subsidiaries of FleetCor Technologies, Inc. Use of this service is governed by Corpay’s Terms and Conditions.

➤