Show Menu

Transfer Funds to Beneficiary Company

Transfer Funds to Beneficiary Company

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

post/API/v4/Fund/TransferFundtoCompany

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: Company

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.

ProgramIdstring

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

Descriptionstring

String length: inclusive between 1 and 300

Currencystring

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.

Amountdecimal

String length: inclusive between 1 and 25

BeneficiaryAccountNumberstring

String length: inclusive between 1 and 25

BeneficiaryWalletIDstring

String length: inclusive between 1 and 25

BeneficiaryLinkedBankIDstring

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

BeneficiaryPayPalEmailIDstring

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

Response 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
BeneficiaryAccountNumber—Unique id recipient send along 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/TransferFundtoCompany

{  
  "TransferFundtoCompany":{  
    "request":{  
      "IssuerAccountNumber":"SPN Account Number",
      "PaymentType":"Company",
      "PaymentMethodId":"Use 'GetPaymentMethods' to get PaymentMethodID",
      "ProgramId":"Use 'GetPrograms' to get Program ID",
      "WalletId":"Use 'GetCompanyWallets' to get WalletID",
      "Description":"Payment Description",
      "Currency":"Currency Code",
      "Amount":"Payment Amount",
      "EmailNotification":"true/false",
      "IssuerTransactionId":"Unique ID",
      "BeneficiaryAccountNumber":"SPN Account Number",
      "BeneficiaryWalletID":"Use 'GetBeneficiaryWallets' to get Beneficiary WalletID",
      "BeneficiaryLinkedBankID":"Use 'GetLinkedBankAccounts' to get UserLinkedBankID",
      "BeneficiaryPayPalEmailID":"User PayPal Email ID"
    }
  }
}

						

Sample Response:


{  
  "TransferFundtoCompanyResponse":{  
    "TransferFundtoCompanyResult":{  
      "IssuerTransactionId":"123456789",
      "PaymentTransactionId":"123456789",
      "BeneficiaryAccountNumber":"SPN123456789",
      "PaymentDate":"2017-11-27T04:49:36.677",
      "PaymentStatus":"Completed",
      "OperationStatus":{  
        "Success":true,
        "Errors":null
      }
    }
  }
}