Show Menu

Check Beneficiary Exist

Check Beneficiary Exist

This allows you to get a list of beneficiaries.

post/API/v4/Beneficiary/CheckBeneficiaryExist

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

CompanyNamestring

String length: inclusive between 1 and 100

Response Parameters

Beneficiarystring

Returned if successful List of Beneficiaries found. For each Beneficiary the following parameters are allowed: Name—Beneficiary Company Name
AccountNumber—Beneficiary Account Number

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/Beneficiary/CheckBeneficiaryExist

{  
  "CheckBeneficiaryExist":{  
    "request":{  
      "IssuerAccountNumber":"SPN Account Number",
      "CompanyName":"Company Name"
    }
  }
}
						

Sample Response:


{  
  "CheckBeneficiaryExistResponse":{  
    "CheckBeneficiaryExistResult":{  
      "Beneficiary":[         
        {  
          "Name":"Test Xtrm",
          "AccountNumber":"SPN1781861",
           "Email": "xtrm2009@gmail.com",
			"MasteradminFirstname": "",
			"MasteradminLastname": ""
        },
        {  
          "Name":"Test Xtrm 1",
          "AccountNumber":"SPN1679234",
         "Email": "xtrm2009@gmail.com",
		"MasteradminFirstname": "",
		"MasteradminLastname": ""
        },
       
        {  
          "Name":"Xtrm Inc.",
          "AccountNumber":"SPN0500201",
          "Email": "xtrm2009@gmail.com",
           "MasteradminFirstname": "",
            "MasteradminLastname": ""
        }
      ],
      "OperationStatus":{  
        "Success":true,
        "Errors":null
      }
    }
  }
}