Show Menu

Transfer Fund Wallet to Wallet

Transfer Fund Wallet to Wallet

This allows you to transfer fund from a user wallet to company wallet, user wallet to another user wallet, company wallet to user wallet, company wallet ot another company wallet. On TransferFundWallettoWallet call a 6 digit one time password(OTP) is generated and sent to user from whom the fund is going to debited. Get the 6 digit OTP value from the user in your application and resubmit TransferFundWallettoWallet with OTP included.

post/API/v4/Fund/TransferFundWallettoWallet

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

FromAccountNumberstring

String length: inclusive between 1 and 25. Can be Issuer account number(SPNXXX) or Beneficiary company account number (SPNXXX) or beneficiary user id(PATXXX)

FromWalletIDint

Int length: inclusive between 1 and 10. Use 'GetCompanyWallets' or 'GetUserWallets' or 'GetBeneficiaryWallets' to get WalletID.

ToAccountNumberstring

String length: inclusive between 1 and 25. Can be Issuer account number(SPNXXX) or Beneficiary company account number (SPNXXX) or beneficiary user id(PATXXX)

ToWalletIDint

Int length: inclusive between 1 and 10. Use 'GetCompanyWallets' or 'GetUserWallets' or 'GetBeneficiaryWallets' to get WalletID.

Currencystring

String length: 3

Amountdecimal

String length: inclusive between 1 and 25

Descriptionstring

String length: inclusive between 1 and 200

OTPintRequired on every transfer fund wallet to wallet API call.

Int length: six digit integer

Reponse Parameters

Transfer Fund Wallet to Wallet Responsestring

Returned if successful. Allowed parameters are
TransactionID — Unique transaction ID transferred
Amount — Amount transferred from wallet to wallet
Fee — Fee amount of the transaction
TotalAmount - Total amount including fees

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/Fund/TransferFundWallettoWallet

{
  "TransferFundWallettoWallet": {
    "Request": {
        "IssuerAccountNumber": "SPN Issuer Account Number",
        "FromAccountNumber":"SPN/PAT Issuer Account Number",
        "FromWalletID":"SPN/PAT Wallet ID",
        "ToAccountNumber":"SPN/PAT Issuer Account Number",
        "ToWalletID":"SPN/PAT Wallet ID",
        "Currency": "Currency Code",
        "Amount": "Amount",    
        "Description": "Payment Description",
        "OTP": "six digit integer" 
      }
    }
  }
						

Sample Response:


{
	"TransferFundWallettoWalletResponse": {
		"TransferFundWallettoWalletResult": {
			"TransactionID": "30569",
			"Amount": "$10.00 USD",
			"Fee": "$1.20 USD",
			"TotalAmount": "$11.20 USD",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}