Show Menu

Transfer Funds to Beneficiary User Wallet

Transfer Funds to Beneficiary User Wallet

This allows you to make transfers from a company wallet to a beneficiary user wallet, (AnyPay™) or passthrough payments to a beneficiaries Bank account or PayPal or Prepaid Virtual Visa. When you make transfers, if the beneficiary does not have a wallet in that currency, one will be created automatically.

post/API/v4/Fund/TransferFund

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

PaymentTypestring

String length: inclusive between 1 and 50 Set to: Personal

PaymentMethodIdstring

String length: inclusive between 1 and 25. Use 'GetPaymentMethods' to get PaymentMethodID.

WalletIDint

Int length: inclusive between 1 and 25. Use 'GetCompanyWallets' to get WalletID.

ProgramIdint

Int length: inclusive between 1 and 25. Use 'GetPrograms' to get Program ID.

PaymentDescriptionstring

String length: inclusive between 1 and 300

PaymentCurrencystring

String length:3

EmailNotificationboolean

IssuerTransactionIdint

Int length: inclusive between 1 and 25. Value submitted in this field in the request will be returned unchanged in the corresponding response. Typically the value would be a unique identifier of the issuer.

PaymentAmountdecimal

String length: inclusive between 1 and 25

PartnerAccountNumberstring

String length: inclusive between 1 and 25

RecipientUserIdstring

String length: inclusive between 1 and 25

UserLinkedBankIDstring

String length: inclusive between 1 and 100
If payment method is bank otherwise its optional

UserPayPalEmailIDstring

String length: inclusive between 1 and 100
if payment method PayPal otherwise its optional

UserPrepaidVisaEmailIDstring

String length: inclusive between 1 and 100
if payment method Prepaid Virtual Visa otherwise its optional
Minimum amount is $5.00 and Maximum amount is $1000.00

DealRegIdstring

String length: inclusive between 1 and 25

Commentstring

String length: inclusive between 1 and 500

Reponse Parameters

TransactionDetailstring

Returned if successful List of Transaction detail found. For each transaction detail the following parameters are allowed: IssuerTransactionId—unique Id send along with request
PaymentTransactionId—Unique id created when payment is successful
RecipientUserId—Unique id recipient send alonf with request
PaymentDate—Date when payment is processed
PaymentStatus—Status of payment

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

{
  "TransferFund": {
    "request": {
      "Transaction": {
        "IssuerAccountNumber": "SPN Account Number",
        "PaymentType": "Personal",
        "PaymentMethodId": "Use 'GetPaymentMethods' to get PaymentMethodID",
        "ProgramId": "Use 'GetPrograms' to get Program ID",
        "WalletId": "Use 'GetCompanyWallets' to get WalletID",
        "PaymentDescription": "Payment Description",
        "PaymentCurrency":"Currency Code",
        "EmailNotification" :"true/false",
        "TransactionDetails": [
          {
            "IssuerTransactionId": "Unique ID",
            "PaymentAmount": "Payment Amount",
            "PartnerAccountNumber": "SPN Account Number",
            "RecipientUserId": "PAT Account Number",
            "UserLinkedBankID": "Use 'GetLinkedBankAccounts' to get UserLinkedBankID",
            "UserPayPalEmailID": "User PayPal Email ID",
            "UserPrepaidVisaEmailID": "User Prepaid Virtual Visa Email ID",
            "DealRegId": "Deal_Reg_ID",
            "Comment": "Comment"
          }
        ]
      }
    }
  }
}
						

Sample Response:


{
	"TransferFundResponse": {
		"TransferFundResult": {
			"TransactionDetail": [
				{
					"IssuerTransactionId": "222",
					"PaymentTransactionId": "59697",
					"RecipientUserId": "PAT1886461",
					"PaymentDate": "2018-11-02T01:41:37.773",
					"PaymentStatus": "Completed",
					"Amount": "100.00",
					"Fee": "88.76",
					"TotalAmount": "188.76",
					"Currency": "INR"
				}
			],
			"OperationStatus": {
				"Success": true,
				"Errors": []
			}
		}
	}
}