Show Menu

Check User Exist

Check User Exist

This allows you to get a list of personal beneficiaries.

post/API/V4/Beneficiary/CheckUserExist

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

Email Addressstring

String length: inclusive between 1 and 100

Response Parameters

Beneficiarystring

Returned if successful List of Personal Beneficiaries found. For each Beneficiary the following parameters are allowed: AccountNo—Beneficiary Account Number
Name—Beneficiary Name
State—Beneficiary State
Country—Beneficiary Country
Employer—Employer of 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/v4/API/V4/Beneficiary/CheckUserExist 

{  
  "CheckUserExist":{  
    "request":{  
      "IssuerAccountNumber":"SPN Account Number",
     "Email":"Email Address"
    }
  }
}

Sample Response:


{  
  "CheckUserExistResponse":{  
    "CheckUserExistResult":{  
      "Beneficiary":[  
        {  
          "AccountNo":"PAT1273777",
          "Name":"Jared Mark",
          "State":"California",
          "Country":"United States of America",
          "Employer":"Citrix Systems"
        },
        {  
          "AccountNo":"PAT0613589",
          "Name":"Michael Smith",
          "State":"California",
          "Country":"United States of America",
          "Employer":""
        }
      ],
      "OperationStatus":{  
        "Success":true,
        "Errors":null
      }
    }
  }
}

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.

➤