Simple Order API

Recent Revisions to This Document

24.09

April 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • ccAuthReply_paymentInsightsInformation_orchestration_infoCodes
Updated these fields:
  • item_#_grossNetIndicator

24.08

April 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • additionalToken_responseInformation
  • developerID
  • paymentTypeIndicator
Updated these fields:
  • ccAuthReply_processorResponse
  • ccAuthReversalReply_processorResponse
  • ccCreditReply_processorResponse
  • ccIncrementalAuthReply_processorResponse
  • ecCreditReply_processorResponse
  • ecDebitReply_processorResponse
  • octReply_processorResponse
  • pinDebitCreditReply_processorResponse
  • pinDebitPurchaseReply_processorResponse
  • pinDebitReversalReply_processorResponse

24.07

April 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • emvRequest_combinedTags
  • enablerId
  • healthCard
Updated these fields:
  • ccAuthReply_merchantAdviceCode
  • ccAuthReply_merchantAdviceCodeRaw
  • ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode
  • ccAuthService_aggregatorID
  • ccAuthService_authType
  • ccAuthService_networkPartnerId
  • ccAuthService_paSpecificationVersion
  • ccCaptureService_authType
  • emvReply_combinedTags
  • invoiceHeader_salesOrganizationID
  • invoiceHeader_submerchantID
  • paymentNetworkTransactionInformation
  • pinDataEncryptedPIN

24.06

March 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • ccAuthService_dsReferenceNumber
  • transactionTypeIndicator

24.05

February 2024:
This revision of the guide contains updated or new field information.
Added this new field:
  • businessRules_ignoreExportResult

24.04

February 2024:
This revision of the guide contains updated or new field information.
Updated the field length for
installment_identifier
(Request)

24.03

January 2024:
This revision of the guide contains updated or new field information.
Added the value
UA
to the field
ccAuthService_overridePaymentMethod
.
Added these new fields:
  • billTo_companyPhoneNumber
  • billTo_prefix
  • check_checkTransactionCode
  • check_transactionReason
  • ecAVSReply_accountType
  • ecAVSReply_addedOrClosedDate
  • ecAVSReply_additionalStatusCode
  • ecAVSReply_authorizationLevel
  • ecAVSReply_calculatedResponse
  • ecAVSReply_customerDataCondition Code
  • ecAVSReply_fcraDisputeCode
  • ecAVSReply_lastUpdateDate
  • ecAVSReply_matchBillToAddress
  • ecAVSReply_matchBillToCity
  • ecAVSReply_matchBillToCompany
  • ecAVSReply_ matchBillToCompanyPhoneNumber
  • ecAVSReply_matchBillToCompanyTaxID
  • ecAVSReply_ matchBillToDateOfBirth
  • ecAVSReply_matchBillToFirstName
  • ecAVSReply_matchBillToFullName
  • ecAVSReply_matchBillToLastName
  • ecAVSReply_matchBillToMiddleName
  • ecAVSReply_matchBillToPhoneNumber
  • ecAVSReply_matchBillToPostalCode
  • ecAVSReply_matchBillToPrefix
  • ecAVSReply_matchBillToSSN
  • ecAVSReply_matchBillToState
  • ecAVSReply_matchBillToSuffix
  • ecAVSReply_matchPersonalID
  • ecAVSReply_matchPersonalID
  • ecAVSReply_matchPersonalIDIssuedBy
  • ecAVSReply_matchPersonalIDType
  • ecAVSReply_overallMatchScore
  • ecAVSReply_previousStatusCode
  • ecAVSReply_primaryStatusCode
  • ecAVSReply_referenceID
  • ecAVSReply_resultCode
  • ecAVSReply_scoredAccountProcessorResponse1
  • ecAVSReply_scoredAccountProcessorResponse2
  • ecAVSReply_scoredAccountProcessorResponse3
  • ecAVSReply_scoredAccountProcessorResponse5
  • ecAVSReply_secondaryStatusCode
  • ecAVSReply_validationType
  • personalID_issuedBy
Updated supported processor information for these fields:
  • billTo_companyName
  • billTo_customerID
  • card_cardType
  • card_cvNumber
  • ccAuthReply_reconciliationReferenceNumber
  • ccAuthService_cavvAlgorithm
  • ccAuthService_commerceIndicator
  • ccCaptureReply_reconciliationReferenceNumber
  • ccCreditReply_reconciliationReferenceNumber
  • ccCreditService_commerceIndicator
  • invoiceHeader_purchaserCode
  • octService_commerceIndicator
  • payerAuthEnrollReply_cavvAlgorithm
  • payerAuthValidateReply_cavvAlgorithm
  • pinDebitCreditService_commerceIndicator
  • pinDebitPurchaseService_commerceIndicator
  • shipTo_city
  • shipTo_firstName
  • shipTo_lastName
  • shipTo_street1
  • shipTo_street2

24.02

January 2024:
This revision of the guide contains updated or new field information.
Added clarifying information for
FDC Nashville Global
about the uses of this field:
  • ccAuthReply_merchantAdviceCode

24.01

January 2024:
This revision of the guide contains editorial improvements and potentially updated or new field information.
Added an important note about relaxed requirements for address data and the expiration date to these fields:
  • billTo_city
  • billTo_country
  • billTo_email
  • billTo_firstname
  • billTo_lastname
  • billTo_postalCode
  • billTo_state
  • billTo_street1
  • card_expirationMonth
  • card_expirationYear
Added clarifying information for
FDC Nashville Global
about the uses of these fields:
  • issuer_responseCode
  • ccAuthReply_merchantAdviceCode
Added these new fields:
  • apCancelReply_dateTime
  • apCancelReply_paymentStatus
  • apCancelReply_processorResponse
  • apCancelReply_reasonCode
  • apCancelReply_reconciliationID
  • apCancelReply_responseCode
  • apCancelReply_status
  • apCancelService_dateTime
  • apCancelService_run
  • apCancelService_saleRequestID
  • apCreateMandateReply_dateCreated
  • apCreateMandateReply_dateSigned
  • apCreateMandateReply_dateTime
  • apCreateMandateReply_encodedHTML
  • apCreateMandateReply_encodedPopupHTML
  • apCreateMandateReply_mandateID
  • apCreateMandateReply_merchantURL
  • apCreateMandateReply_processorTransactionID
  • apCreateMandateReply_reasonCode
  • apCreateMandateReply_responseCode
  • apCreateMandateReply_riskScore
  • apCreateMandateReply_status
  • apCreateMandateService_cancelURL
  • apCreateMandateService_failureURL
  • apCreateMandateService_run
  • apCreateMandateService_saleRequestID
  • apCreateMandateService_successURL
  • apImportMandateReply_dateCreated
  • apImportMandateReply_dateSigned
  • apImportMandateReply_dateTime
  • apImportMandateReply_mandateID
  • apImportMandateReply_processorTransactionID
  • apImportMandateReply_reasonCode
  • apImportMandateReply_reconciliationID
  • apImportMandateReply_responseCode
  • apImportMandateReply_status
  • apImportMandateService_dateSigned
  • apImportMandateService_run
  • apMandateStatusReply_dateCreated
  • apMandateStatusReply_dateRevoked
  • apMandateStatusReply_dateSigned
  • apMandateStatusReply_dateTime
  • apMandateStatusReply_mandateID
  • apMandateStatusReply_processorTransactionID
  • apMandateStatusReply_reasonCode
  • apMandateStatusReply_responseCode
  • apMandateStatusReply_status
  • apMandateStatusService_run
  • apRevokeMandateReply_dateCreated
  • apRevokeMandateReply_dateRevoked
  • apRevokeMandateReply_dateSigned
  • apRevokeMandateReply_dateTime
  • apRevokeMandateReply_mandateID
  • apRevokeMandateReply_processorTransactionID
  • apRevokeMandateReply_reasonCode
  • apRevokeMandateReply_responseCode
  • apRevokeMandateReply_status
  • apRevokeMandateService_run
  • apSaleService_dateCollect
  • apUpdateMandateReply_dateCreated
  • apUpdateMandateReply_dateSigned
  • apUpdateMandateReply_dateTime
  • apUpdateMandateReply_encodedHTML
  • apUpdateMandateReply_encodedPopupHTML
  • apUpdateMandateReply_mandateID
  • apUpdateMandateReply_merchantURL
  • apUpdateMandateReply_processorTransactionID
  • apUpdateMandateReply_reasonCode
  • apUpdateMandateReply_responseCode
  • apUpdateMandateReply_riskScore
  • apUpdateMandateReply_status
  • apUpdateMandateService_cancelURL
  • apUpdateMandateService_esign
  • apUpdateMandateService_failureURL
  • apUpdateMandateService_run
  • apUpdateMandateService_successURL
  • billTo_title
  • paymentDetails_executionDate
  • paymentScheme

23.06

December 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.05

November 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.04

April 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.03

March 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.02

February 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.

23.01

January 2023:
This revision of the guide contains editorial improvements and potentially updated or new field information.