Show Menu

Delete Bank Account

Delete Bank Account

This allows you to delete a linked bank account of a beneficiary.

post/API/v4/Bank/DeleteBankBeneficiary

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

RecipientAccountNumberstring

String length: inclusive between 1 and 25

BeneficiaryBankIDstring

String length: inclusive between 1 and 50. Use value of the BeneficiaryID parameter from response of the API/v4/Bank/GetLinkedBankAccounts call.

Response Parameters

DeleteBankBeneficiarystring

Returned if successful BankBeneficiaryID—Bank ID of the beneficiary

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/Bank/GetLinkedBankAccounts 

{
    "DeleteBankBeneficiary": {
        "request": {
            "IssuerAccountNumber": "SPNXXXXXXXX",
            "RecipientAccountNumber": "PATXXXXXXX / SPNXXXXXXX",
            "BeneficiaryBankID": "12e6f8ac19804f90be485045f50ace57"			
        }
    }
}

Sample Response:


{
	"DeleteBankBeneficiary": {
		"DeleteBankBeneficiaryResult": {
			"BankBeneficiaryID": "12e6f8ac19804f90be485045f50ace57",
			"OperationStatus": {
				"Errors": [],
				"Success": true
			}
		}
	}
}

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.

➤