Show Menu

Create Company Program

Create Company Program

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

post/API/v4/Programs/CreateProgram

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

Descriptionstring

String length: inclusive between 0 and 100

TransactionCategoryIDint

Int length: inclusive between 1 and 5. Use 'GetProgramCategory' to get TransactionCategoryID.

TransactionSubCategoryIDint

Int length: inclusive between 1 and 5. Use 'GetProgramType' to get TransactionSubCategoryID.

ClaimAmountdecimal

Decimal length: inclusive between 1 and 25

CurrencyCodestring

String length: inclusive between 1 and 25

IsClaimboolean

Response Parameters

ProgramID—Program ID

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

{
    "CreateProgram": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",                                
            "Description":"Program Name",
            "TransactionCategoryID":"Use 'ProgramCategory' to get Program Category ID",
            "TransactionSubCategoryID":"Use 'ProgramType' to get Program SubCategory ID",
            "Amount":"Amount",
            "CurrencyCode":"Currency Code",
            "IsClaim":boolean
        }
        }
    }
}

Sample Response:


{
	"CreateProgramsResponse": {
		"CreateProgramsResult": {
			"ProgramID": 2316,
			"OperationStatus": {
				"Success": true
				"Errors": []
			}
		}
	}
}

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.

➤