Show Menu

Company Program Type

Company Program Type

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

post/API/v4/Programs/ProgramType

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

CategoryIDint

String length: inclusive between 1 and 10

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

ProgramTypeDetailstring

List of Program types found. For each Program types the following parameters are allowed: SubCategoryID—Sub Category ID
SubCategoryName—Sub Category Name

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

{
    "GetProgramType": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",
            "CategoryID": "Use 'ProgramCategory' to get Program Category ID",
            "Pagination": {
                "RecordsToSkip": 1,
                "RecordsToTake": 10
            }
        }
    }
}

Sample Response:


{
	"GetProgramTypeResponse": {
		"ProgramTypeResult": {
			"ProgramType": {
				"ProgramTypeDetail": [
					{
						"SubCategoryID": 4,
						"SubCategoryName": "SPIF"
					},
					{
						"SubCategoryID": 5,
						"SubCategoryName": "Bonus"
					},
					{
						"SubCategoryID": 7,
						"SubCategoryName": "Rebates"
					},
					{
						"SubCategoryID": 8,
						"SubCategoryName": "MDF"
					},
					{
						"SubCategoryID": 9,
						"SubCategoryName": "Other"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": [
					""
				]
			},
			"PaginationTotal": {
				"RecordsToSkip": 1,
				"RecordsToTake": 10,
				"RecordsTotal": 5
			}
		}
	}
}

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.

➤