Service Information Data Elements

AddressInfo

Contains merchant address information. Required.

Parameter Description Data Type
City City. Required. String
CountryCode Country. Required. Enum
PostalCode Postal Code. Required. String
StateProvince State or Province. Required. Enum
Street1 Street Address Line 1. Required. String
Street2 Street Address Line 2. Optional. String

 


 

ApplicationData

ApplicationData contains information about the application that must be supplied to the Service Information endpoint prior to transacting. Required.

ApplicationData is returned by the following Service Information operation signatures:

Parameter Description Data Type
ApplicationAttended Indicates whether the application is attended or unattended. Required. Boolean
ApplicationLocation Location of the application relative to the merchant. Required. Enum
ApplicationName Name of the application. Required. String
DeveloperId Developer Identifier, or Third-Party Processor Identifier (TPP ID). Conditional, required if provided to application developer by application certification entity. String
DeviceSerialNumber Specifies the serial number located on the physical device used to acquire payment account data. Optional. String
EncryptionType Specifies the type of encryption block used by the card reader. Optional. Enum
HardwareType Type of device running the application. Required. Enum
PINCapability Indicates support for cardholder Personal Identification Number (PIN). Required. Enum
PTLSSocketId
(see string value below)
Identifier use by certified software applications. Required. This is a fixed value for all merchants.
Note:
This value is passed with all subsequent transaction requests as applicationProfileId.
String
ReadCapability Capability of the device to read cardholder data. Required. Enum
SerialNumber Serial number of the application provided by the software developer. Unique per installed instance of the application. Required. String
SoftwareVersion Software version of the application provided by the software developer. Required. String
SoftwareVersionDate Software version date of the application provided by the software developer. Required. DateTime
VendorId Vendor Identifier. Conditional, required if provided to application developer by application certification entity. String

PTLSSocketId

MIIFCzCCA/OgAwIBAgICAoEwDQYJKoZIhvcNAQEFBQAwgbExNDAyBgNVBAMTK0lQIFBheW1lbnRzIEZyYW1ld29yayBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkxCzAJBgNVBAYTAlVTMREwDwYDVQQIEwhDb2xvcmFkbzEPMA0GA1UEBxMGRGVudmVyMRowGAYDVQQKExFJUCBDb21tZXJjZSwgSW5jLjEsMCoGCSqGSIb3DQEJARYdYWRtaW5AaXBwYXltZW50c2ZyYW1ld29yay5jb20wHhcNMTMwODI2MTcxMDI3WhcNMjMwODI0MTcxMDI3WjCBjDELMAkGA1UEBhMCVVMxETAPBgNVBAgTCENvbG9yYWRvMQ8wDQYDVQQHEwZEZW52ZXIxGjAYBgNVBAoTEUlQIENvbW1lcmNlLCBJbmMuMT0wOwYDVQQDEzR0ZHNwM25TZ0FJQUFBUDhBSCtDWUFBQUVBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUE9MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtn6ILI78EaOLcWrmI9RZf8Vj+3P/WcrDLimSyJJH/8LnIBbXNkiKcZSMg/KHqNLAtq/ncYqZcicgAfaoSbj9FxKGIXTDEICriv/i8sQIGFhIwW/V6H02E8SpWjdCQO9EUUaFPUVMhHfiabwJ3B0VODsQfVuG7mbrAvD/wAqiUVR2Q0rpgHkToCkytdhMlkXiFtnfy4nnoFnI6c5cmsQU7AZgI6Zr08pDMN9y3uSRGSJIzdcTohBA1qb8C4+ZVRCmwCfQZiBHxjC8c5DTiGlPQVEDfRjKXm6ffqBKCttX7qCeB0s57iob0Q7ucz8NfoWtY8dZVzMhYH8obU/dSXaZ6wIDAQABo4IBTjCCAUowCQYDVR0TBAIwADAdBgNVHQ4EFgQUJ64+T3k9d5nWfplPlxVZsN382XUwgeYGA1UdIwSB3jCB24AU3+ASnJQimuunAZqQDgNcnO2HuHShgbekgbQwgbExNDAyBgNVBAMTK0lQIFBheW1lbnRzIEZyYW1ld29yayBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkxCzAJBgNVBAYTAlVTMREwDwYDVQQIEwhDb2xvcmFkbzEPMA0GA1UEBxMGRGVudmVyMRowGAYDVQQKExFJUCBDb21tZXJjZSwgSW5jLjEsMCoGCSqGSIb3DQEJARYdYWRtaW5AaXBwYXltZW50c2ZyYW1ld29yay5jb22CCQD/yDY5hYVsVzA1BgNVHR8ELjAsMCqgKKAmhiRodHRwOi8vY3JsLmlwY29tbWVyY2UuY29tL2NhLWNybC5jcmwwDQYJKoZIhvcNAQEFBQADggEBAJrku2QD0T/0aT+jfFJA947Vf7Vu/6S1OxUGhMipx6z/izXZ+o4fK/Nsg0G39KvfxippFG/3MUo621dwXwtqq9SM72zy9ry9E0ptmEiG8X8bSVOyGj4MqyExCPs9LgloV5GgewqYRgq2hmbXOv8Gw7EeXGCfnQ+eROxGu1+p3ZWUnGMQnBbayg43npcHYfyLFHOzd57pj6ncYoxY3kun5GLMLr6tJXKpPNvbM5lAOzcAmKviPMCM2T53UzJlsRdVvCbnkrc5cYqN4l01elqr3MSsj6BJ+JqIqViFrYYkD34THKO8c+wZGb8IN+NJAVre9YOvt5+Cvbbd5ik0UQ+YQNM=

Important! Make sure that when copying the string above that no spaces exist when pasted into the application.

 


 

AutoSettlement

Enable this merchant profile along with service key, service id, application profile id for auto settlement. Optional

Parameter Description Data Type
Active Turn on or off auto settlement. Required. Boolean
SettlementHour Settlement time to run, 24h format (1-24). Required. Int
ApplicationProfileId Appliocation profile used to process settlement. Required. String
NotificationEmail Email for settlement notifications. Optional. String

 


 

BankcardMerchantData

Contains information specific to the Bankcard Processing service class for the merchant using the application. Required for merchants using Credit Card and PIN Debit services.

Parameter Description Data Type
ABANumber Identifies the merchant to a direct debit switch. Conditional, required if provisioned by the service provider. String
AcquirerBIN Acquirer Bank Identification Number. Identifies the merchant's acquiring bank. Typically provisioned by the service provider. Optional. String
AgentBank Agent Bank Identifier. Typically provisioned by the service provider. Optional. String
AgentChain Agent Chain Identifier. Typically provisioned by the service provider. Optional. String
Aggregator Identifies the merchant as an aggregator. Typically provisioned by the service provider. If not present, the default value is 'false'. Optional. Boolean
ClientNumber Client number. Typically provisioned by the service provider. Optional. String
IndustryType The industry type of the transaction. This is saved in the MerchantProfile (default) and cannot be overridden on each transaction. Required. Enum
Location Unique identifier for the merchant's location. Conditional, required if provisioned by the service provider. String
MerchantType Merchant type. Typically provisioned by the service provider. Optional. String
PrintCustomerServicePhone Indicates whether to print the customer service telephone number on the customer's transaction receipt. Conditional, required for MOTO transactions. Boolean
QualificationCodes Qualification codes. Typically provisioned by the service provider. Optional. String
ReimbursementAttribute Designates the reimbursement fee applicable to the transaction. Conditional, required if provisioned by the service provider. String
SecondaryTerminalId Additional transaction device identifier. Conditional, required if provisioned by the service provider. String
SettlementAgent Identifies the merchant settling agent to direct debit networks. Conditional, required if provisioned by the service provider. String
SharingGroup Provides a list of debit and EBT networks that a Point-of-Sale (POS) system can access. Conditional, required if provisioned by the service provider. String
SIC Standard Industry Code. Identifies the merchant industry classification. May be provisioned by the service provider. Required. String
StoreId Unique merchant store identifier. Conditional, required if provisioned by the service provider. String
TerminalId Transaction device identifier. Often referred to as Terminal Number or Terminal Id (TID). Conditional, required if provisioned by the service provider. String
TimeZoneDifferential Timezone of the merchant location and the Daylight Savings Time observation status. Conditional, required if provisioned by the service provider. String

 


 

BankcardService

Contains information returned to the application with details about the Bankcard service(s) for which it is configured.

Parameter Description Data Type
AlternativeMerchantData Indicates whether the service supports AlternativeMerchantData which will appear on the accountholder's statements. Subject to Issuer discretion. Optional. Boolean
AutoBatch Indicates whether AutoBatch is supported by the service. Required. Boolean
AVSData Address Verification Services supported by the service. Required. Object
CutoffTime The cut-off time for new transactions to be included in the daily, automated batch (when supporting AutoBatch). Conditional, required if the service supports AutoBatch. DateTime
EncryptionKey Public key used for encrypting payment account data. Required. String
ManagedBilling Indicates whether the service supports Managed Billing. Required. Boolean
MaximumBatchItems Maximum number of transactions to include in a single batch. Required. Long
MaximumLineItems Maximum number of line items that may be provided when sending Level 3 line item data. Optional. Long
MultiplePartialCapture Indicates whether the service supports multiple partial captures of a single authorization amount. Required. Boolean
Operations The Transaction Processing Bankcard operations supported by the service. Required. Object
PurchaseCardLevel Indicates the highest level of purchase card data supported by the service. Level 3 support is inclusive of Level 2 data, and Level 2 support is inclusive of Level 1 data. Required. Enum
ServiceId Unique service identifier. Required. String
ServiceName Service name. Required. String
Tenders Tenders supported by the service. Required. Object

 


 

BankcardServiceAVSData

Contains information returned to the application specifying the Address Verification System (AVS) fields. Conditional, may be required by the service provider.

Parameter Description Data Type
CardholderName Indicates whether Cardholder Name is required for AVS. Conditional, required if BankcardServiceAVSData is not null. Boolean
City Indicates whether City is required for AVS. Conditional, required if BankcardServiceAVSData is not null. Boolean
Country Indicates whether Country is required for AVS. Conditional, required if BankcardServiceAVSData is not null. Boolean
Phone Indicates whether cardholder Phone Number is required for AVS. Conditional, required if BankcardServiceAVSData is not null. Boolean
PostalCode Indicates whether Postal Code is required for AVS. Conditional, required if BankcardServiceAVSData is not null. Boolean
StateProvince Indicates whether State or Province is required for AVS. Conditional, required if BankcardServiceAVSData is not null. Boolean
Street Indicates whether Street Address is required for AVS. Conditional, required if BankcardServiceAVSData is not null. Boolean

 


 

BankcardServices

Contains a collection of Bankcard-specific services. Conditional, required if the service supports Bankcard.

Parameter Description Data Type
BankcardService Contains information returned to the application with details about the Bankcard service(s) for which it is configured. Required. Object
ElectronicCheckingService Contains information returned to the application with details about the Electronic Checking service(s) for which it is configured. Required. Object

 


 

BankcardTransactionDataDefaults

Contains information sent with all Bankcard transactions. May be overridden on each transaction, as necessary. Required.

Parameter Description Data Type
CurrencyCode Merchant's currency code as defined by the International Standards Organization (ISO). Optional. Enum
CustomerPresent Presence of cardholder relative to the transaction point of service. Optional. Enum
EntryMode DEPRECATED: This must now be set on each individual transaction. Indicates how the cardholder data was retrieved. When authorizing with stored card data, either locally or with PaymentAccountDataToken, indicates that the card data was manually collected (Keyed or one of its variants). Optional. Enum
RequestACI Authorization Characteristics Indicator. Identifies the request as potentially qualifying for the Visa CPS or MasterCard Merit programs. Optional. Enum
RequestAdvice Indicates whether to include advice on declined recurring payment transactions. Optional. Enum

 


 

DuplicateCheck

Enable this merchant profile to perform duplicate check.

Parameter Description Data Type
Active Turn on or off duplicate checking. Required. Boolean

 


 

ElectronicCheckingMerchantData

Contains information specific to the Electronic Checking service class for the merchant using the application. Conditional, required if one of the data elements is required by the service provider.

Parameter Description Data Type
ClientNum Client Number.  Typically provisioned by the service provider. Optional. String
MerchLocation Merchants location Id.  Typically provisioned by the service provider. Optional. String
OriginatorId Unique identifier that represents the ACH originator in the service provider system. Typically provisioned by the service provider. Optional. String
ProductId Product Identifier. Typically provisioned by the service provider. Optional. String
SiteId Site Identifier. Typically provisioned by the service provider. Optional. String

 


 

ElectronicCheckingService

Contains information returned to the application with details about the Electronic Checking service(s) for which it is configured. Conditional, required if the service supports Electronic Checking.

Parameter Description Data Type
Operations The Transaction Processing Electronic Checking operations supported by the service. Required. Object
ServiceId Unique service identifier. Required. String
ServiceName Service name. Required. String
Tenders Tenders supported by the service. Required. Object

 


 

MerchantProfile

Contains required merchant data across all supported service classes. In the case of single-merchant applications, it is required that a merchantProfileId be saved for that merchant. In multi-merchant applications, a unique merchantProfileId is required for each merchant.

Once saved, the IsMerchantProfileInitialized operation can be invoked to verify that their specific merchant profile has been saved. If successfully verified, the application will then pass their unique merchantProfileId with all subsequent transactions.

MerchantProfile is returned by the following Service Information operation signatures:

Parameter Description Data Type
AutoSettlement Enable this merchant profile along with service key, service id, application profile id for auto settlement. Optional. Object
DuplicateCheck Enable this merchant profile to perform duplicate check. Optional. Object
LastUpdated Date this merchant profile was last updated. This value is returned to the client application when GetMerchantProfiles is called. Required. DateTime
MerchantData Contains general data for a merchant that are used across all service classes. Required. Object
PartialApproval Allows a merchant to enable partial approvals. Optional. Boolean
ProfileId Unique identifer for the merchant profile. Referenced in transaction processing operations as merchantProfileId. Optional. String
RecurringBilling Enable the merchant profile along with service key, service id, application profile id for Recurring Billing Service. Optional. Object
ServiceId The service Id of the merchant's service provider. Conditional, required when the service key supports more than one Bankcard service. In this scenario, a merchant profile should be saved for each service provider. String
ServiceName The name of the service the profile is saved for. This value is returned to the client application when GetMerchantProfiles is called. Required. String
TransactionData Allows a merchant profile to be saved with transaction data defaults. If this data will not change for each transaction, there is no need to override these values on the transaction. Required. Object

 


 

MerchantProfileMerchantData

Contains information specific to the merchant. Required.

Parameter Description Data Type
Address Merchant address. Required. Object
BankcardMerchantData Additional merchant data for the Bankcard Processing service class, including Credit Card and PIN Debit. Conditional, required for merchants using Credit Card and PIN Debit services. Object
CustomerServiceInternet Merchant's customer service web URL or email address. Optional. String
CustomerServicePhone Merchant's customer service phone number. Conditional, required for Bankcard MOTO transactions. String
ElectronicCheckingMerchantData Additional merchant data for the Electronic Checking service class, including ACH. Optional. Object
Language Language to be used for the response text message. Required. Enum
MerchantId Merchant Identifier, or 'MID'. Provisioned by the service provider. Required. String
Name Name of the merchant. May be provisioned. Required. String
Phone Merchant's local telephone number. Conditional, required for Bankcard Ecommerce and MOTO transactions. String
StoredValueMerchantData Additional merchant data for the Stored Value Account service class. Optional. Object
TaxId Merchant's federal or Value-Added Tax (VAT) identification number. Optional. String

 


 

MerchantProfiles

Contains a list of merchant profiles. At least one merchant profile is required.

Parameter Description Data Type
List of MerchantProfile Contains all merchant data across all supported service classes. Required. Object

 


 

MerchantProfileTransactionData

Contains transaction-specific information associated with a specific merchant. Required.

Parameter Description Data Type
BankcardTransactionDataDefaults Contains information sent with all Bankcard transactions. May be overridden on each transaction, as necessary. Required. Object

 


 

Operations

The transaction processing operations supported by the service.

Parameter Description Data Type
Adjust Indicates whether the Adjust operation is supported. Required. Boolean
AuthAndCapture Indicates whether the AuthorizeAndCapture operation is supported. Required. Boolean
Authorize Indicates whether the Authorize operation is supported. Required. Boolean
Capture Indicates whether the Capture operation is supported. Required. Boolean
CaptureAll Indicates whether the CaptureAll operation is supported. Required. Boolean
CaptureSelective Indicates whether the CaptureSelective operation is supported. Required. Boolean
CloseBatch Defines the level of support for batch release functionality. Required. Enum
Disburse Indicates whether the Disburse operation is supported. Required. Boolean
ManageAccount Indicates whether the ManageAccount operation is supported. Required. Boolean
ManageAccountById Indicates whether the ManageAccountById operation is supported. Required. Boolean
QueryAccount Indicates whether the QueryAccount operation is supported. Required. Boolean
QueryRejected Indicates whether the QueryRejected operation is supported. Required. Boolean
ReturnById Indicates whether the ReturnById operation is supported. Required. Boolean
ReturnUnlinked Indicates whether the ReturnUnlinked operation is supported. Required. Boolean
Undo Indicates whether the Undo operation is supported. Required. Boolean
Verify Indicates whether the Verify operation is supported. Required. Boolean

 


 

RecurringBilling

Enable this merchant profile along with service key, service id, application profile id on the Recurring Billing Service. Optional

Parameter Description Data Type
ApplicatoinId The Application Profile ID, used while processing transactions. String
Active Indicates if this merchnat is able to use the Billing Service. Boolean
EmailNotificationToCustomer Indicates if payment notifications should be send to the customers e-mail address. Boolean(Nullable)
AutomaticeRetries Indicates if a sub fails, should billing be automatically retried. Boolean(Nullable)
DaysTillRetry If auto retry is on, this is the number of days to wait untill trying again. Int(Nullable)
Proration_Downgrades When a price lowers, should proration take place. Not yet implemented. Boolean(Nullable)
ModifiedBy Name of the person who changed this information last. String

 


 

ServiceInformation

Contains information about the supported service(s). Returned to the application by GetServiceInformation. Expected.

ServiceInformation is returned by the following Service Information operation signatures:

Parameter Description Data Type
List of BankcardServices Represents a collection of Bankcard-specific services. Conditional, required if Credit Card or PIN Debit services are available. Object
List of ElectronicCheckingServices Represents a collection of Electronic Checking-specific services. Conditional, required if ACH, ECK, or RDC services are available. Object
List of StoredValueServices Represents a collection of Stored Value-specific services. Conditional, required if SVA services are available. Object
List of Workflows Represents a collection of workflows. Expected. Object

 


 

StoredValueMerchantData

Contains information specific to the Bankcard Processing service class for the merchant using the application. Required for merchants using Credit Card and PIN Debit services. Required.

Parameter Description Data Type
AgentChain Agent Chain Identifier. Typically provisioned by the service provider. Optional. String
ClientNumber Client number. Typically provisioned by the service provider. Optional. String
IndustryType The industry type of the transaction. This will be saved in the MerchantProfile but may be overridden on each transaction. Required. Enum
SIC Standard Industry Code. Identifies the merchant industry classification. May be provisioned by the service provider. Required. String
StoreId Unique merchant store identifier. Conditional, required if provisioned by the service provider. String
TerminalId Transaction device identifier. Often referred to as Terminal Number or Terminal ID (TID). Conditional, required if provisioned by the service provider. String

 


 

StoredValueService

Contains a collection of Stored Value-specific services. Conditional, required if the service supports Stored Value transaction processing.

Parameter Description Data Type
Operations The Transaction Processing Stored Value operations supported by the service. Required. Object
SecureMSRAllowed Indicates support for card data collected from a magnetic stripe and protected by an encrypting card reader. Required. Boolean
ServiceId Unique Service Identifier. Required. String
ServiceName Service Name. Required. String
Tenders Tenders supported by the service. Required. Object

 


 

Tenders

Contains specific information about the supported payment tenders. Returned to the application by GetServiceInformation. Expected.

Parameter Description Data Type
BatchAssignmentSupport Indicates level of BatchAssignment supported by the service. Required. Enum
CredentialsRequired Specifies whether or not user credentials are required for the service. Optional, if not present defaults to 'false'. Boolean
Credit Indicates support for the Credit Card tender. Required. Boolean
CreditAuthorizeSupport Indicates the level of credit authorization support on a service. Required. Enum
CreditReturnSupport Indicates the types of Return transactions supported by the service for Credit transactions. Required. Enum
CreditReversalSupportType Specifies if Reversal is supported. Enum
PartialApprovalSupportType Specifies whether the service supports partial authorizations at the transaction level. If not present, defaults to ‘DisabledAlwaysSupported’. Expected. Enum
PINDebit Indicates support for the PIN Debit tender. Required. Boolean
PINDebitReturnSupport Indicates if Return is supported by the service for PIN Debit transactions. Required. Defaults to 'Standalone'. Enum
PINDebitUndoSupport Indicates if Undo is supported by the service for PIN Debit transactions. Required. Enum
PINDebitUndoTenderDataRequired Specifies whether a new card swipe is required when performing an Undo on a PIN Debit card. Required. Boolean
PINlessDebit Indicates support for PINless Debit. Required. Boolean
QueryRejectedSupport Indicates if date ranges are supported for QueryRejected on a service. Required. Enum
TrackDataSupport Indicates the types of track data supported. Required. Enum

 


 

Workflow

Represents a collection of workflows. Returned by the GetServiceInformation operation in the ServiceInformation object. Expected.

Parameter Description Data Type
Name The workflow name. Expected. String
ServiceId The Service Id which corresponds to the Bankcard or Electronic Checking service within the workflow. Expected. String
WorkflowId The Workflow Identifier. Expected. String
List of WorkflowServices Represents a collection of workflow services. Expected. Object

 


 

WorkflowService

Contains information returned to the application with details about the workflow service(s) for which it is configured.

Parameter Description Data Type
Ordinal The ordinal position within the workflow. Expected. Integer
ServiceId The Service Id which corresponds to the Bankcard or Electronic Checking service within the workflow. Expected. String
ServiceName The Service Name. Expected. String
ServiceType The Service Type. Expected. String

 

Udated: 5/24/16 ~DS

Comments