Show Menu

Fetch Beneficiary User Wallet Transactions

Fetch Beneficiary User Wallet Transactions

You can get a list of transactions of a User wallet. There can be one or more wallets.

post/API/v4/Wallet/GetUserWalletTransactions

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

WalletCurrencystring

String length: 3

Paginationint

Specifies pagination information to limit the number of records to return. Allowed parameters are: RecordsToSkip—Number of records to skip. RecordsToTake—Number of records to return.

Reponse Parameters

GetUserWalletTransactionsResultstring

Returned if successful List of Transactions found. For each transaction the following parameters are returned:
TransactionID—Transaction ID
CompanyName—Company name
ProgramName—Program Name
TransactionDate—Transaction Date
Description—Description
Amount—Amount
Type—Transaction Type
PaymentMethod—Payment Method

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

{
  "GetUserWalletTransactions": {
    "Request": {
       "IssuerAccountNumber": "SPN Account Number",
       "UserID": "PAT Account Number",
       "WalletCurrency": "Currency Code",
       "Pagination": {
       "RecordsToSkip": "1",
       "RecordsToTake": "10"
      }
    }
  }
}
						

Sample Response:


{
	"GetUserWalletTransactionsResponse": {
		"GetUserWalletTransactionsResult": {
			"Transactions": [
				{
					"TransactionID": 1819,
					"CompanyName": "-",
					"ProgramName": "-",
					"TransactionDate": "2017-10-16T04:10:05.397",
					"Description": "Currency Exchange",
					"Amount": 9000,
					"Type": "Debit",
					"PaymentMethod": ""
				},
				{
					"TransactionID": 1818,
					"CompanyName": "-",
					"ProgramName": "-",
					"TransactionDate": "2017-10-16T03:58:27.987",
					"Description": "Fund transfer to acct. ending XXXX4472. Ref: 4190627",
					"Amount": 1000,
					"Type": "Debit",
					"PaymentMethod": "Bank"
				}
			],
			"OperationStatus": {
				"Success": true,
				"Errors": null
			},
			"PaginationTotal": {
				"RecordsToSkip": 1,
				"RecordsToTake": 10,
				"RecordsTotal": 3
			}
		}
	}
}