Show Menu

Company Programs

Programs

This allows you to get a list of your company payment programs or projects and is used along with the Transfer Funds API request.

post/API/v4/Programs/GetPrograms

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

ProgramDetailsstring

List of Program details found. For each Program details the following parameters are allowed: ProgramId—unique Id of beneficiary
ProgramName—Name of Program
ProgramCategory—Program Category
ProgramType—Program Type
IsClaim—Is claimable True/False

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/Programs/GetPrograms 

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

Sample Response:


{
	"GetProgramsResponse": {
		"ProgramsResult": {
			"Programs": {
				"ProgramDetails": [
					{
						"ProgramId": 2316,
						"ProgramName": "Production Company",
						"ProgramCategory": "Performance",
						"ProgramType": "Bonus",
						"IsClaim": "N"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": [
					""
				]
			},
			"PaginationTotal": {
				"RecordsToSkip": 1,
				"RecordsToTake": 10,
				"RecordsTotal": 1
			}
		}
	}
}

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.

➤