Show Menu

Beneficiaries

Beneficiaries

This allows you to get a list of your company's beneficiaries or recipient's employer.

post/API/v4/Beneficiary/GetBeneficiaries

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

BeneficiaryDetailstring

Returned if successful List of Partner details found. For each Partner details the following parameters are allowed: BeneficiaryCompanyName—Beneficiary Company Name
BeneficiaryContact—Beneficiary Contact
PartnerAccountManager—Partner Account Manager
BeneficiaryID—Beneficiary ID
BeneficiarySalesforceId—Beneficiary Salesforce ID
OtherPartnerID—Other Partner ID
Region—Region

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/API/v4/Beneficiary/GetBeneficiaries 

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

Sample Response:


{
	"GetBeneficiariesResponse": {
		"BeneficiaryResult": {
			"Beneficiaries": {
				"BeneficiaryDetail": [
					{
						"BeneficiaryCompanyName": "Nextbigxxx",
						"BeneficiaryContact": "Next Bigs",
						"PartnerAccountManager": "",
						"BeneficiaryID": "SPN1781889",
						"BeneficiarySalesforceId": "",
						"OtherPartnerID": "",
						"Region": ""
					},
					{
						"BeneficiaryCompanyName": "Console",
						"BeneficiaryContact": "Console Console",
						"PartnerAccountManager": "Mark Console",
						"BeneficiaryID": "SPN1781880",
						"BeneficiarySalesforceId": "001G000001mKtQCIA0",
						"OtherPartnerID": "Silver",
						"Region": "India"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": [
					""
				]
			},
			"PaginationTotal": {
				"RecordsToSkip": 1,
				"RecordsToTake": 10,
				"RecordsTotal": 12
			}
		}
	}
}

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.

➤