Show Menu

Personal Beneficiaries

Personal Beneficiaries

This allows you to get a list of your Personal's beneficiaries.

post/API/V4/Beneficiary/GetPersonalBeneficiaries

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

Paginationint

Specifies pagination information to limit the number of records to return. Allowed parameters are: RecordsToSkip—Number of records to skip. RecordsToTake—Number of records to return.

Response Parameters

Beneficiarystring

Returned if successful List of User found. For each Partner details the following parameters are allowed: AccountNo—Beneficiary Account Number
Name—Beneficiary Name
State—Beneficiary State
Country—Beneficiary Country
Employer—Employer of Beneficiary
Email—Beneficiary Email

PaginationTotalstring

Returned if successful Returned pagination result including total number of records available. Allowed parameters are: RecordsToSkip—Number of records skipped
RecordsToTake—Number of records returned
RecordsTotal—Total number of records in the underlying data set

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/GetPersonalBeneficiaries

{
  "GetPersonalBeneficiaries": {
    "request": {
      "IssuerAccountNumber": "SPN Account Number",
      "Pagination": {
        "RecordsToSkip": "1",
        "RecordsToTake": "10"
      }
    }
  }
}
						

Sample Response:


{  
  "GetPersonalBeneficiariesResponse":{  
    "GetPersonalBeneficiaryResult":{  
      "Beneficiary":[  
        {  
          "AccountNo":"PAT1781764",
          "Name":"Oojam Mark",
          "State":"California",
          "Country":"United States of America",
          "Employer":"Citrix Systems",
          "Email":"Oojam@Citrix.com"
        },
        {  
          "AccountNo":"PAT1781763",
          "Name":"Omanand Clark",
          "State":"California",
          "Country":"United States of America",
          "Employer":"Citrix Systems",
          "Email":"Omanand@Citrix.com"
        }
      ],
      "OperationStatus":{  
        "Success":true,
        "Errors":null
      },
      "PaginationTotal":{  
        "RecordsToSkip":1,
        "RecordsToTake":10,
        "RecordsTotal":5
      }
    }
  }
}