REST Data Elements

The following data elements may be required when processing REST-specific Bankcard (Credit or PIN Debit), Electronic Checking (ACH), and Stored Value (SVA) transactions.

Refer to the Commerce Web Services Developer's Guide for more information about the transaction body data elements associated with each REST operation.

ApplicationProfileId

A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required.

Parameter Description Data Type
href URL to get the application profile data. Required. String
id The Application Profile ID. Required. String

 


 

FederatedSignOn

Contains claims to federate into the generated sessionToken that have been extracted from an external domain token issued by an external Identity Provider (IDP)/Identity Authority (IA).

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

 


 

MerchantProfileId

The unique Merchant Profile ID. Returned by the GetMerchantProfiles operation. Required.

Parameter Description Data Type
href URL to get the merchant profile data. Required. String
id The Merchant Profile ID. Required. String

 


 

Rest.Acknowledge

Indicates an Acknowledge request. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String

 


 

Rest.ActivationTransaction

 

Parameter Description Data Type
Activation The activation data. The actual class should be a descendant of the Activation class. Required. Object

 


 

Rest.ActivationTransactionWithProfile

 

Parameter Description Data Type
Activation The activation data. The actual class should be a descendant of the Activation class. Required. Object
MerchantProfile The specific Merchant Profile to include in the transaction request. Required. Object

 


 

Rest.Adjust

Indicates an Adjust request containing adjusted transaction data. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
DifferenceData Data for the adjustment. Required. Object

 


 

Rest.AuthorizeAndCaptureTransaction

Indicates an AuthorizeAndCapture request. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfileId The unique Merchant Profile Identifier. Required. String
Transaction The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. Required.  Object

 


 

Rest.AuthorizeAndCaptureTransactionWithProfile

Indicates an AuthorizeAndCapture request using an Unmanaged Merchant Profile. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfile The specific Merchant Profile to include in the transaction request. Required. Object
Transaction The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. Required.  Object

 


 

Rest.AuthorizeTransaction

Base class for all Authorize requests. Contains common data fields. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfileId The unique Merchant Profile Identifier. Required. String
Transaction The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. Required. Object

 


 

Rest.AuthorizeTransactionWithProfile

Base class for all Authorize requests using Unmanaged Merchant Profiles. Contains common data fields. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfile The specific Merchant Profile to include in the transaction request. Required. Object
Transaction The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. Required. Object

 


 

Rest.Capture

Indicates a Capture request containing updated data, if necessary. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
DifferenceData Capture data. Conditional, required if there were data changes since the original authorization.  Object

 


 

Rest.CaptureAll

Indicates a CaptureAll request containing additional data. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
BatchIds A list of batches to settle. Conditional, required for customer-defined batches. List<String>
DifferenceData The details of the transactions to capture. Conditional, required if there were data changes since the original authorization. List<Object>
MerchantProfileId The unique Merchant Profile Identifier. Required. String

 


 

Rest.CaptureAllWithProfile

Indicates a CaptureAll request using Unmanaged Merchant Profiles. Contains additional data in the request. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required String
BatchIds A list of batches to settle. Conditional, required for customer-defined batches. List<String>
DifferenceData The details of the transactions to capture. Conditional, required if there were data changes since the original authorization. List<Object>
MerchantProfile The specific Merchant Profile to include in the transaction request. Required. Object

 


 

Rest.CaptureAllAsync

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. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
DifferenceData The details of the transactions to capture. Conditional, required if there were data changes since the original authorization. List<Object>
MerchantProfileId The unique Merchant Profile Identifier. Required. String
BatchIds A list of batches to settle. Conditional, required for customer-defined batches. List<String>

 


 

Rest.CaptureAllAsyncWithProfile

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. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
DifferenceData The transactions to capture. Conditional, required if there were data changes since the original authorization. List<Object>
MerchantProfile The specific Merchant Profile to include in the transaction request. Required. Object
BatchIds A list of batches to settle. Conditional, required for customer-defined batches. List<String>

 


 

Rest.CaptureSelective

Marks one or more succesfully authorized transactions for settlement by the processor. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
DifferenceData The details of the transactions to capture. Conditional, required if there were data changes since the original authorization. List<Object>
TransactionIds The list of transaction Ids that will be captured. Required. List<String>

 


 

Rest.CaptureSelectiveAsync

Marks one or more 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. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
DifferenceData The details of the transactions to capture. Conditional, required if there were data changes since the original authorization. List<Object>
TransactionIds The list of transaction Ids that will be captured. Required. List<String>

 


 

Rest.ChangeTransaction

Base class for transaction updates. This class should not be used directly. A descendent of this class should be used. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String

 


 

Rest.DisburseTransaction

Base class for all Disburse requests. Contains common data fields. Required.

Parameter Description Data Type
Transaction The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. Required. Object

 


 

Rest.DisburseWithProfile

Indicates a Disburse request using Unmanaged Merchant Profiles. Contains additional data in the request. Required.

Parameter Description Data Type
MerchantProfile The specific Merchant Profile to include in the disburse request. Required. Object
Transaction The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. Required. Object

 


 

Rest.ManageAccount

 

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfileId The unique Merchant Profile Identifier. Required. String
Transaction The transaction data. The actual class should be a descendant of the Transaction class. Required. Object

 


 

Rest.ManageAccountById

 

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
DifferenceData Data for the account updates. Required. Object

 


 

Rest.ManageAccountWithProfile

 

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfile The specific Merchant Profile to include in the transaction request. Required. Object
Transaction The transaction data. The actual class should be a descendant of the Transaction class. Required. Object

 


 

Rest.ReturnById

Indicates a ReturnById request. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Required. String
MerchantProfileId The unique Merchant Profile Identifier. Optional. String
DifferenceData Contains updated transaction data for the return. Optional. Object

 


 

Rest.ReturnByIdWithProfile

Indicates a ReturnById request using an Unmanaged Merchant Profile. Required.

Parameter Description Data Type
DifferenceData Contains updated transaction data for the return. Optional. Object

 


 

Rest.ReturnTransaction

Indicates a Return request. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfileId The unique Merchant Profile Identifier. Required. String
Transaction The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. Required. Object

 


 

Rest.ReturnTransactionWithProfile

Indicates a Return request using an Unmanaged Merchant Profile. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfile The specific Merchant Profile to include in the transaction request. Required. Object
Transaction The transaction data. If supporting Level 2/3 data, this is BankcardTransactionPro. Required. Object

 


 

Rest.SubmitTransaction

Base class for new transactions. This class should not be used directly. A descendent of this class should be used. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfileId The unique Merchant Profile Identifier. Required. String

 


 

Rest.SubmitTransactionWithProfile

Base class for new transactions using Unmanaged Merchant Profiles. This class should not be used directly. A descendent of this class should be used. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
MerchantProfile The specific Merchant Profile to include in the transaction request. Required. Object

 


 

Rest.TransactionRequest

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. Required.

Parameter Description Data Type
MerchantProfileId The unique Merchant Profile Identifier. Required. String
TransactionTenderData The tender data used for the transaction query. Required. Object

 


 

Rest.Undo

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. Required.

Parameter Description Data Type
ApplicationProfileId A token representing the PTLS Socket ID unique to each Service Key and configuration data combination. Returned by the SaveApplicationData operation. Required. String
DifferenceData Undo data. The actual instance should be a descendant of the Undo class. Conditional, required if you need to set fields in addition to transactionId. Object

 


 

Rest.ErrorResponse

Contains user validation errors. Specific data rule validation errors are listed in ValidationError.

Parameter Description Data Type
ErrorId The error code of the fault. Required.
Refer to the specific fault codes listed in the CWS Fault Reference for additional information.
Integer
HelpUrl The web URL that will display more information about the fault. Optional. String
Messages List of error messages. Optional. List<String>
Operation The CWS operation name that originated the fault. Required. String
Reason Main error message. Required. String
ValidationErrors List of validation error messages. Optional. List<ValidationError>

 


 

Rest.ValidationError

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.

Parameter Description Data Type
RuleKey Identifies the data rule that failed. Required. String
RuleLocationKey Where the data rule failed. Optional. String
RuleMessage A message that describes the failure. Required. String
TransactionId TransactionId where the data rule failed. Required. Helpful for CaptureSelective or CaptureAll. String

Updated: 5/25/16 ~DS

Comments