Show Menu

Beneficiary Company Withdraw Funds

Beneficiary Company Withdraw Funds

This allows beneficiary company to withdraw funds to their Bank from their XTRM 'AnyPay™' Digital Wallet. On UserWithdrawFund call a 6 digit one time password(OTP) is generated and sent to user. Get the 6 digit OTP value from the user in your application and resubmit UserWithdrawFund with OTP included.

post/API/v4/Fund/BeneficiaryCompanyWithdrawFund

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

Amountdecimal

String length: inclusive between 1 and 25

Currencystring

String length: 3

PaymentMethodIdstring

String length: inclusive between 1 and 25

BeneficiaryWalletIDstring

Int length: inclusive between 1 and 25

OTPstringRequired on every withdraw call.

String length: six digit integer

Reponse Parameters

TransactionDetailstring

Returned if successful List of Transaction detail found. For each transaction detail the following parameters are allowed: 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/BeneficiaryCompanyWithdrawFund 

{
  "BeneficiaryCompanyWithdrawFund": {
    "request": {
        "IssuerAccountNumber": "SPN Account Number",                
        "Currency":"Currency Code",  
        "Amount": "Payment Amount",    
        "PaymentMethodId": "Use 'GetBeneficiaryCompanyPaymentMethods' to get PaymentMethodID",       
        "BeneficiaryAccountNumber":"SPN Account Number",
        "BeneficiaryWalletID":"Use 'GetBeneficiaryWallets' to get WalletID",
        "BeneficiaryLinkedBankID":"Use 'GetLinkedBankAccounts' to get LinkedBankID",
        "OTP": "six digit integer"

    }
  }
}

Sample Response:


{
	"BeneficiaryCompanyWithdrawFundResponse": {
		"BeneficiaryCompanyWithdrawFundResult": {
			"PaymentDate": 2017-11-09T03:50:22.893,
			"PaymentStatus": "Completed",
			"OperationStatus": {
				"Success": false,
				"Errors": []
			}
		}
	}
}

Why

Products

Developers

How It Works

Resources

Payment and foreign exchange transactions are powered and provided by Corpay. “Corpay” is the marketing trade name for the International Payment Solutions and Risk Management Solutions provided by certain subsidiaries of FleetCor Technologies, Inc. Use of this service is governed by Corpay’s Terms and Conditions.

➤