Simple Order API
 Field Reference

This section provides you with information about the
Simple Order API
 field reference.
Audience and Purpose
This guide is written for application developers who want to use the
Simple Order API
 to integrate
Cybersource
 services into an order management system. Implementing
Cybersource
 services requires software development skills. You must write code that uses the
Simple Order API
 request and reply fields.
Conventions
These special statements are used in this document:
An
Important
 statement contains information essential to successfully completing a task or learning a concept.
A
Warning
 contains information or instructions, which, if not heeded, can result in a security risk, irreversible loss of data, or significant cost in time or revenue or both.
Related Documentation
Refer to the Technical Documentation Hub in the
Cybersource
 Developer Center for additional technical documentation:
Customer Support
For support information about any service, visit the Support Center:

Recent Revisions to This Document

24.19

September 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • accountHolder_type
  • ccAuthService_aggregatorStreetAddress
  • octService_aggregatorStreetAddress
  • ccAuthService_aggregatorCity
  • octService_aggregatorCity
  • ccAuthService_aggregatorState
  • octService_aggregatorState
  • ccAuthService_aggregatorPostalcode
  • octService_aggregatorPostalcode
  • ccAuthService_aggregatorCountry
  • octService_aggregatorCountry

24.18

September 2024:
This revision of the guide contains updated or new field information.
Added these fields:
  • ccAuthService_acsReferenceNumber
  • payerAuthEnrollReply_authenticationBrand
  • payerAuthValidateReply_authenticationBrand

24.17

August 2024:
This revision of the guide contains updated or new field information.
Updated this field:
  • payerAuthEnrollService_httpUserAgent

24.16

August 2024:
This revision of the guide contains updated or new field information.
Updated these field:
  • lodgingData_additionalCoupon
  • ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode

24.15

July 2024:
This revision of the guide contains updated or new field information.
Updated these fields:
  • apCaptureService_isFinal
  • ccAuthService_acquirerMerchantId

24.14

July 2024:
This revision of the guide contains updated or new field information.
Updated these fields:
  • card_usage
  • ccAuthService_overridePaymentMethod
  • ccCreditService_overridePaymentMethod
  • pinDebitCreditService_overridePaymentMethod

24.13

June 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • Lodging data fields, which begin with
    lodgingData_
    .
Updated these fields:
  • ccAuthReply_processorResponse
  • ccAuthReply_merchantAdviceCode
  • ccAuthReversalReply_processorResponse
  • ccCreditReply_processorResponse
  • ccIncrementalAuthReply_processorResponse
  • ecCreditReply_processorResponse
  • ecDebitReply_processorResponse
  • octReply_processorResponse
  • pinDebitCreditReply_processorResponse
  • pinDebitPurchaseReply_processorResponse
  • pinDebitReversalReply_processorResponse

24.12

June 2024:
This revision of the guide contains updated or new field information.
Updated these fields:
  • card_cardType
  • ccCaptureService_totalCount
  • invoiceHeader_merchantDescriptorCountry
  • invoiceHeader_submerchantCountry
  • paymentNetworkTransactionInformation

24.11

May 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • apAuthService_reconciliationID
  • apCaptureService_authRequestID
  • ap_device_type
  • apImportMandateService_dateSigned
  • apSaleService_preapprovalToken
  • apSaleService_successURL
  • apSaleService_transactionTimeout
  • apSessionsService_cancelURL
  • apSessionsService_paymentFlowMode
  • billTo_company
  • billTo_county
  • billTo_gender
  • billTo_language
  • billTo_middleName
  • billTo_title
  • ccAuth_initiatorType
  • ccAuthService_extendAuthIndicator
  • fundTransfer_iban
  • merchantDefinedData_mddField_#
  • recipient_accountType
  • recipient_address2
  • recipient_buildingNumber
  • recipient_streetName
  • shipTo_company

24.10

April 2024:
This revision of the guide contains updated or new field information.
Added these new fields:
  • airlineData_clearingCount
  • airlineData_clearingSequence
  • airlineData_creditReasonIndicator
  • airlineData_electronicTicket
  • airlineData_purchaseType
  • airlineData_reservationSystem
  • airlineData_ticketIssuerCity
  • airlineData_ticketNumber
  • airlineData_totalClearingAmount
Updated these fields:
  • balanceInquiry
  • businessRules_declineAVSFlags
  • businessRules_ignoreCVResult
  • ccAuthReply_merchantAdviceCode
  • ccAuthReply_merchantAdviceCodeRaw
  • ccCaptureService_purchasingLevel
  • ccCreditService_purchasingLevel

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.

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

The following are specifications and conditions that apply to a Reseller/Partner enabling its merchants through
Cybersource for Visa Platform Connect (“VPC”) processing
. Failure to meet any of the specifications and conditions below is subject to the liability provisions and indemnification obligations under Reseller/Partner’s contract with Visa/Cybersource.
  1. Before boarding merchants for payment processing on a VPC acquirer’s connection, Reseller/Partner and the VPC acquirer must have a contract or other legal agreement that permits Reseller/Partner to enable its merchants to process payments with the acquirer through the dedicated VPC connection and/or traditional connection with such VPC acquirer.
  2. Reseller/Partner is responsible for boarding and enabling its merchants in accordance with the terms of the contract or other legal agreement with the relevant VPC acquirer.
  3. Reseller/Partner acknowledges and agrees that all considerations and fees associated with chargebacks, interchange downgrades, settlement issues, funding delays, and other processing related activities are strictly between Reseller and the relevant VPC acquirer.
  4. Reseller/Partner acknowledges and agrees that the relevant VPC acquirer is java.io.PrintWriter@7c1d5615 responsible for payment processing issues, including but not limited to, transaction declines by network/issuer, decline rates, and interchange qualification, as may be agreed to or outlined in the contract or other legal agreement between Reseller/Partner and such VPC acquirer.
DISCLAIMER: NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR ANY ERRORS OR OMISSIONS BY THE VISA PLATFORM CONNECT ACQUIRER IN PROCESSING TRANSACTIONS. NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR RESELLER/PARTNER BOARDING MERCHANTS OR ENABLING MERCHANT PROCESSING IN VIOLATION OF THE TERMS AND CONDITIONS IMPOSED BY THE RELEVANT VISA PLATFORM CONNECT ACQUIRER.