Show Menu

ACH Debit Linked Bank Accounts

Linked Bank Accounts

This allows you to get a list of the ACH Debit linked bank accounts. This is used to fund company wallet using ACH debit method.

post/API/v4/Bank/GetACHDebitLinkedBankAccounts

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

RecipientUserIdstring

String length: inclusive between 1 and 25

Response Parameters

BeneficiaryDetailsstring

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

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
BankBeneficiaryStatus—Bank Beneficiary Status

ACHDebitApprovalStatus—ACH Debit Approval Status
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/Bank/GetACHDebitLinkedBankAccounts

{
    "GetACHDebitLinkedBankAccounts": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",
            "RecipientUserId": "SPN/PAT Account Number"
        }
    }
}
						

Sample Response:


{
	"GetACHDebitLinkedBankAccountsResponse": {
		"GetACHDebitLinkedBankAccountsResult": {
			"Beneficiary": {
				"BeneficiaryDetails": [
					{
						"BeneficiaryId": "cdf85c46d30547ceadb586a0c28e1000",
						"BeneficiaryName": "Beneficiary Contact Name",
						"Currency": "USD",
						"Country": "United States of America",
						"TransferFee": 0,
						"PaymentMethods": {
							"Payment": "ACH"
						},
						"BankDetails": {
							"BeneficiaryBankInformation": {
								"AccountNumber": "121312312",
								"BankName": "wells fargo",
								"BranchName": "",
								"BankBeneficiaryStatus": "Approved",
								"ACHDebitApprovalStatus": "Pending"
							}
						}
					},
					{
						"BeneficiaryId": "22da22fc977a4914a4ae52bcde8bc734",
						"BeneficiaryName": "Beneficiary Contact Name",
						"Currency": "USD",
						"Country": "United States of America",
						"TransferFee": 0,
						"PaymentMethods": {
							"Payment": "ACH"
						},
						"BankDetails": {
							"BeneficiaryBankInformation": {
								"AccountNumber": "121312312",
								"BankName": "wells fargo",
								"BranchName": "",
								"BankBeneficiaryStatus": "Approved",
								"ACHDebitApprovalStatus": "Pending"
							}
						}
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}