REST API Reference
REST Data Elements
The following REST data elements are used in transactions sent to https://api.cipcert.goevo.com/REST/x.x.x/Txn endpoints.
A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. This element is Required.
Required? | Parameter | Description | Data Type |
---|---|---|---|
X | href | URL to get the application profile data. | String |
X | id | The Application Profile ID. | String |
Contains claims to federate into the generated sessionToken extracted from an external domain token issued by an external Identity Provider (IDP)/Identity Authority (IA). For more information, please refer to the SSO API for Federated Identity.
Required | Parameter | Description | Data Type |
---|---|---|---|
Claims | The specific claims to federate into the generated session token. - Maps to ClaimMetaData. | Object | |
ExternalDomainToken | The external domain token containing one or more claims to federate into the generated session token. | String |
The unique Merchant Profile ID. Returned by the GetMerchantProfiles operation. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | href | URL to get the merchant profile data. | String |
X | id | The Merchant Profile ID. | String |
Indicates an Acknowledge request. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
Required | Parameter | Description | Data Type |
---|---|---|---|
X | Activation | The activation data. The actual class should be a descendant of the Activation class. | Object |
Required | Parameter | Description | Data Type |
---|---|---|---|
X | Activation | The activation data. The actual class should be a descendant of the Activation class. | Object |
X | MerchantProfile | The specific Merchant Profile to include in the transaction request. | Object |
Indicates an Adjust request containing adjusted transaction data. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | DifferenceData | Data for the adjustment. - Maps to Adjust. | Object |
Indicates an AuthorizeAndCapture request. The element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the operation. | String |
X | MerchantProfileId | The unique Merchant Profile Identifier. | String |
X | Transaction | The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. | Object |
Indicates an AuthorizeAndCapture request using an Unmanaged Merchant Profile. The element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfile | The specific Merchant Profile to include in the transaction request. | Object |
X | Transaction | The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. | Object |
Base class for all Authorize requests. Contains common data fields. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfileId | The unique Merchant Profile Identifier. | String |
X | Transaction | The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. | Object |
Base class for all Authorize requests using Unmanaged Merchant Profiles. Contains common data fields. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfile | The specific Merchant Profile to include in the transaction request. | Object |
X | Transaction | The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. | Object |
Indicates a Capture request containing updated data, if necessary. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
Conditional* | DifferenceData | Capture data. *Required if there were data changes since the original authorization. - Maps to Capture. | Object |
Indicates a CaptureAll request containing additional data. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
Conditional* | BatchIds | A list of batches to settle. *Required for customer-defined batches. | List |
Conditional* | DifferenceData | The details of the transactions to capture. *Required if there were data changes since the original authorization. | List |
X | MerchantProfileId | The unique Merchant Profile Identifier. | String |
Indicates a CaptureAll request using Unmanaged Merchant Profiles. Contains additional data in the request. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
Conditional* | BatchIds | A list of batches to settle. *Required for customer-defined batches. | List |
Conditional* | DifferenceData | The details of the transactions to capture. *Required if there were data changes since the original authorization. | List |
X | MerchantProfile | The specific Merchant Profile to include in the transaction request. | Object |
‘Marks’ all succesfully authorized transactions for settlement by the processor without waiting for the settlement to complete. The Response object indicates a successful receipt of the settlement request. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
Conditional* | DifferenceData | The details of the transactions to capture. *Required if there were data changes since the original authorization. | List |
X | MerchantProfileId | The unique Merchant Profile Identifier. | String |
Conditional* | BatchIds | A list of batches to settle. *Required for customer-defined batches. | List |
‘Marks’ all succesfully authorized transactions for settlement by the processor without waiting for the settlement to complete. The Response object will indicate a successful receipt of the settlement request. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
Conditional* | DifferenceData | The transactions to capture. *Required if there were data changes since the original authorization. | List |
X | MerchantProfile | The specific Merchant Profile to include in the transaction request. | Object |
Conditional* | BatchIds | A list of batches to settle. *Required for customer-defined batches. | List |
Base class for transaction updates. This class should not be used directly. A descendent of this class should be used. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
Base class for all Disburse requests. Contains common data fields. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | Transaction | The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. | Object |
Indicates a Disburse request using Unmanaged Merchant Profiles. Contains additional data in the request. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | MerchantProfile | The specific Merchant Profile to include in the disburse request. | Object |
X | Transaction | The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. | Object |
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfileId | The unique Merchant Profile Identifier. | String |
X | Transaction | The transaction data. The actual class should be a descendant of the Transaction class. | Object |
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | DifferenceData | Data for the account updates. - Maps to Manage. | Object |
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfile | The specific Merchant Profile to include in the transaction request. | Object |
X | Transaction | The transaction data. The actual class should be a descendant of the Transaction class. | Object |
Indicates a ReturnById request. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. | String |
Optional | MerchantProfileId | The unique Merchant Profile Identifier. | String |
Optional | DifferenceData | Contains updated transaction data for the return. - Maps to Return. | Object |
Indicates a ReturnById request using an Unmanaged Merchant Profile. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
Optional | DifferenceData | Contains updated transaction data for the return. - Maps to Return. | Object |
Indicates a Return request. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfileId | The unique Merchant Profile Identifier. | String |
X | Transaction | The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. | Object |
Indicates a Return request using an Unmanaged Merchant Profile. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfile | The specific Merchant Profile to include in the transaction request. | Object |
X | Transaction | The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. | Object |
Base class for new transactions. This class should not be used directly. A descendant of this class should be used. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfileId | The unique Merchant Profile Identifier. | String |
Base class for new transactions using Unmanaged Merchant Profiles. This class should not be used directly. A descendent of this class should be used. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
X | MerchantProfile | The specific Merchant Profile to include in the transaction request. | Object |
Provides the mechanism to request any transaction that matches given tender data. This operation should only be used when you do not have the transaction ID. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | MerchantProfileId | The unique Merchant Profile Identifier. | String |
X | TransactionTenderData | The tender data used for the transaction query. | Object |
Voids or reverses an authorization in order to release cardholder funds. If the transaction to be undone is in an ErrorUnknown state, TenderData must be set on the BankcardUndo. This element is Required.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ApplicationProfileId | A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. | String |
Conditional* | DifferenceData | Undo data. The actual instance should be a descendant of the Undo class. *Required if you need to set fields in addition to transactionId. Maps to Undo. | Object |
Contains user validation errors. Specific data rule validation errors are listed in ValidationError.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | ErrorId | The error code of the fault. Please refer to the specific fault codes listed in the CWS Fault Reference for additional information. | Integer |
Optional | HelpUrl | The web URL that will display more information about the fault. | String |
Optional | Messages | List of error messages. | List |
X | Operation | The CWS operation name that originated the fault. | String |
X | Reason | Main error message. | String |
Optional | ValidationErrors | List of validation error messages. | List |
ValidationError is a complex type for validation errors generated by the data rules processor that are contained in the ErrorResponse. These rules are usually enforced by the service provider and have to do with field length, data type, allowed characters or values, and inter-relations between fields.
Required | Parameter | Description | Data Type |
---|---|---|---|
X | RuleKey | Identifies the data rule that failed. | String |
Optional | RuleLocationKey | Where the data rule failed. | String |
X | RuleMessage | A message that describes the failure. | String |
X | TransactionId | TransactionId where the data rule failed. Helpful for CaptureAll. | String |