Show Menu

Linked Bank Accounts

Linked Bank Accounts

This allows you to get a list of the beneficiary linked bank accounts. This is used when making direct pass through payments to a beneficiary user's bank account.


Header Parameters


bearer access_token



Request Parameters


String length: inclusive between 1 and 25


String length: inclusive between 1 and 25

Response Parameters


Returned if successful List of Beneficiary details found. For each Beneficiary details the following parameters are allowed: BeneficiaryId—unique Id of beneficiary
BeneficiaryName—Name of beneficiary
Currency—Bank account currency name
Country—Bank account country name
TransferFee—Bank transfer fee
PaymentMethods—Type of Payment EFT/WIRE
AccountNumber—Bank account number
BankName—Bank name
BranchName—Bank branch name


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:

    "GetLinkedBankAccounts": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",
            "RecipientUserId": "PAT Account Number"

Sample Response:

	"GetLinkedBankAccountsResponse": {
		"GetLinkedBankAccountsResult": {
			"Beneficiary": {
				"BeneficiaryDetails": [
						"BeneficiaryId": "288c587ee76a47239876454dc6ed89c1",
						"BeneficiaryName": "James Smith",
						"Currency": "INR",
						"Country": "India",
						"TransferFee": 4,
						"PaymentMethods": {
							"Payment": "WIRE"
						"BankDetails": {
							"BeneficiaryBankInformation": {
								"AccountNumber": "912010017174472",
								"BankName": "Axis Bank",
								"BranchName": "Madurai"
			"OperationStatus": {
				"Success": true,
				"Errors": null