Show Menu

Beneficiary Wallets

Get Beneficiary Wallets

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

post/API/v4/Wallet/GetBeneficiaryWallets

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

Response Parameters

Walletsstring

Returned if successful List of Beneficiary Wallets found. For each Wallet the following parameters are returned:
ID—Wallet ID
Name—Wallet name
Currency— 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/GetBeneficiaryWallets

{  
  "GetBeneficiaryWallets":{  
    "request":{  
      "IssuerAccountNumber":"SPN Account Number",
      "BeneficiaryAccountNumber":"SPN Account Number"
    }
  }
}
						

Sample Response:


{  
  "GetBeneficiaryWalletsResponse":{  
    "GetBeneficiaryWalletsResult":{  
      "Wallets":[  
        {  
          "Name":"Fund Account",
          "ID":3172,
          "Currency":"INR"
        },
        {  
          "Name":"Fund Account",
          "ID":3173,
          "Currency":"USD"
        },
        {  
          "Name":"Fund Wallet",
          "ID":3174,
          "Currency":"AED"
        }
      ],
      "OperationStatus":{  
        "Success":true,
        "Errors":null
      }
    }
  }
}