Show Menu

Get Balance

Get Balance

This allows you to get beneficiary user's digital wallet balance.

post/API/v4/Wallet/GetUserWalletBalance

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

Currencystring

String length:3

Reponse Parameters

Balancestring

Digital Wallat balance of the user. Returned if successful.

Currencystring

Digital Wallat balance currency of the user. Returned if successful.

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

{
    "GetUserWalletBalance": {
        "request": {
           "IssuerAccountNumber": "SPN Account Number",
            "UserID": "PAT Account Number",
            "Currency": "Currency Code"
        }
    }
}

Sample Response:


{
	"UserWalletBalnceResponse": {
		"UserWalletBalanceResult": {
			"Balance": 35,
			"Currency": "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.

➤