Show Menu

Transfer Fund Dynamic Account Create User

This allows you to transfer funds from a company wallet to a new user or existing user's wallet. User is created dynamically if the email id used doesn't exist in the system.

post/API/v4/Fund/TransferFundDynamicAccountCreateUser

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 'GetBeneficiaryWallets' to get WalletID.

RecipientFirstNamestring

String length: inclusive between 1 and 50.

RecipientLastNamestring

String length: inclusive between 1 and 50.

RecipientEmailstring

String length: inclusive between 1 and 255.

Currencystring

String length: 3

Amountdecimal

Decimal length: inclusive between 1 and 10

Descriptionstring

String length: inclusive between 1 and 300

Reponse Parameters

Transfer Fund Dynamic Account Create User Responsestring

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

Currency — Currency of the amount transferred from wallet

RecipientAccountNumber - New or existing beneficiary user account number

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

{
  "TransferFundToDynamicAccountUser": {
    "Request": {
        "IssuerAccountNumber": "SPN Issuer Account Number",
        "FromAccountNumber":"SPN Issuer Account Number",
        "FromWalletID":"SPN Wallet ID",
        "RecipientFirstName":"User First Name(Optional)", 
        "RecipientLastName":"User Last Name(Optional)",
        "RecipientEmail":"User Email",
        "Currency": "Currency Code",
        "Amount": "Amount",
        "Description":"Description"
      }
    }
  }					

Sample Response:


{
	"TransferFundToDynamicAccountUserResponse": {
		"TransferFundToDynamicAccountUserResult": {
			"TransactionID": "70146",
			"Amount": "10.00",
			"Fee": "1.30",
			"TotalAmount": "11.30",
			"Currency": "USD",
			"RecipientAccountNumber": "PAT20136997",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}