Fields at the first Create/Change/Display Authorization Services screen include:

Service Code

Typically set to EXT or EXC, but can be set to anything.

Application

Select Auth/Deposit.

Request token

Select this field to perform credit card tokenization; otherwise, leave unselected. You can select this field only if the Use Credit Card Tokenization (L18) system control value is selected.

Void auth at deposit 

Select this field to void any unused portion of a credit card or stored value card authorization at deposit time.

Note:  The Retain Unused Stored Value Card Authorization After Deposit (J21) system control value does not control stored value card deposit updates for the External Payment Layer.

Send reversal 

Select this field to perform a credit card authorization reversal when you process a cancellation associated with a credit card payment or deactivate a credit card payment.

Fields at the second Create/Change/Display Authorization Services screen:

Media type

Select Communication.

Batch/Online

Select Online or Batch.

Immediate response

Must be selected.

Primary authorization service

Must be set to .IL. See .IL Service Bureau Setup for required settings.

Communication type

Payment Link must be selected, to indicate messages sent the external payment layer are processed directly.

Response check frequency

Indicates the multiple to apply to the Response time to determine how long to wait for a response after a connection when you are using the External Payment Service. For example, if the Response check frequency is 6 and the Response time is 10,000, the system waits 60,000 milliseconds (60 seconds or 1 minute) for a response after connection.

Note:  If the total response interval is exceeded for an authorization record, the record goes into *RCVD status with a response type of SU, and is then removed from the Credit Card Authorization Transaction table (CCAT00).

Response time

Indicates the number of milliseconds to wait for a connection to the service bureau when you are using the External Payment Service. For example, set this field to 10,000 milliseconds to wait 10 seconds for a connection. Note: Order Management System does not wait the entire response time if it is not necessary.

To avoid potential timeout issues, Oracle recommends that you set the Response Time high enough for the authorization service to prevent issues that could potentially occur if the authorization process times out while processing multiple authorizations for an order.

Country codes

If needed, define a cross reference between your country code and the country code used by the service bureau.

Note:  This option also indicates whether a service bureau performs address verification processing for the country.

See Defining Authorization Service Countries.

Currency codes

If needed, define a cross reference between your currency code and the currency code used by the service bureau; see Defining Authorization Service Currencies.

Merchant ID Override

If needed, define a merchant ID override for the different entities in your company; see Defining Merchant ID Overrides.

Paytype codes

If needed, define a cross reference between your pay type code and the pay type code used by the service bureau; see Defining Vendor Paytype Codes.

Response codes

Define the reasons that the service bureau approves (authorizes) or declines a transaction. The codes are assigned to each transaction by the service bureau when approving or declining the request; see Defining Vendor Response Codes.

A response code of SU, indicating service unavailable, must be created.

When there is a REJECT or ERROR response, the order goes on AT hold and the authorization is updated as declined when:

•         The reason code passed is not defined as an authorization response code, or

•         The reason code passed is defined as an authorization response code but also has a hold code defined, or

•         No reason code is passed.

If no reason code is passed, a response code of SU is applied.

The additional External Service Settings at the Work with External Authorization Service Screen are accessible only to users with External Authorization Service Access (B25) authority.

All fields on the screen are required, with the exception of the External Service flag.

Tracking changes to external service settings: Changes that users make to external service settings are tracked in the User Audit table, and listed on the User Authority Change report. See Tracking User, Authority, and Password Updates for more information.

For more information: See the External Payment Layer RESTful Service technical reference on My Oracle Support for more information on updating these settings.

External Service

Select this field to have request messages generated for the External Payment Service.

External URL Prefix

The prefix that forms the beginning of the URL where messages are sent.

Must begin with https.

The message type defines the endpoint suffix that is appended to the prefix, creating the entire URL. For example, for a credit card authorization request, the entire URL might be https://remote.auth.com:1234/authorization, where remote.auth.com is the remote server, 1234 is the port, and authorization identifies an authorization request.

The following endpoints are supported:

•        /balanceInquiry

•        /authorization

•        /reversal

•        /getToken

•        /generateGift

•        /activateGift

•        /rechargeGift

•        /deposit

•        /return

Message Version

Indicates which message version is supported:

•         Version 1.0: Messages include and support all tags as of Order Management System 19.5.

•         Version 2.0 (default when creating a new authorization service): Messages include and support all tags from Version 1.0, plus all tags introduced in Order Management System 20.0.

Tags that are included in version 2.0 provide support for subsequent authorization requests through the External Payment Service. See Subsequent Authorization Requests through the External Payment Service for a discussion, and see Defining Authorization Services (WASV) for information on setting the Message Version.

Authentication User

The user ID for authentication of the messages to the external service.

Authentication Password

The password for authentication of the messages to the external service. Must be at least 6 positions long, include both numbers and letters, include a special character, and cannot end with a number.

Use Credit Card Tokenization (L18)

Select this system control value to replace the credit card number in the Order Management System database with a token provided by the external system. In addition, the number will be encrypted if you have credit card encryption enabled.

Require Credit Card Token (L40)

Select this system control value to require a token for a credit card number. This ensures that credit card numbers are never stored in the Order Management System database and follows full PCI compliance and maximum security of sensitive data.

If the Credit Card Tokenization Process is unable to replace the card number with a token, the system:

•         During Order Entry/Maintenance, Customer Memberships, and Change Invoice Payment Method: displays the Tokenization Warning window, requiring you to enter a different form of payment.

•         During web order processing: replaces the credit card number with the text TOKENIZATION FAILED and places the order in an error status with the reason Invalid Credit Card. You can correct the credit card payment method and resend the card for tokenization in batch order entry.

Deselect this system control value to allow the system to accept a credit card number that has not been replaced with a token. The credit card number will be replaced by a token during authorization processing or when you use Work with Batch Tokenization (WBTK).

Note:  If you change the setting of this system control value, you must stop and restart the ORDER_IN integration layer job before your change takes effect for orders received through the Generic Order Interface (Order API).

ExternalPaymentServiceMessageRequest

ExternalPaymentServiceMessageRequest{

"typeDescription": "AuthorizationRequest",

"requestType": "CreditCard",

"cardNumber": "",

"emailAddress": "first.last@example.com",

"merchantId": "MERCHANT",

"compCurrency": "USD",

"vendCurrency": "400      ",

"vendPaymentMethod": "",

"ecommerceIndicator": "false",

"useTokenization": "Y",

"billToAuthServiceCountry": "",

"ciTransactionId":"1234567890"

"multipleCaptureSequence":"1"

"finalCapture":"Y"

typeDescription

Indicates the type of request.

Credit card: Supported credit card request types are:

•         AuthorizationRequest: See Authorization Request and Response 

•         DepositRequest: See Deposit Request and Response

•         ReturnRequest: See Return Request and Response

•         ReversalRequest: See Reversal Request and Response (Stored Value Card)

•        TokenRequest

Stored value card: Supported stored value card request types are:

•         ActivateRequest: See Activation Request and Response (Stored Value Card)

•         AuthorizationRequest: See Authorization Request and Response

•         BalanceRequest: See Balance Request and Response (Stored Value Card)

•         DepositRequest: See Deposit Request and Response 

•         GenerateRequest: See Generate Request and Response (Stored Value Card)

•         RechargeRequest: See Recharge Request and Response (Stored Value Card)

•         ReturnRequest: See Return Request and Response

•         ReversalRequest: See Reversal Request and Response (Stored Value Card)

requestType

Indicates whether the request is related to a credit card or a stored value card. Supported request types are:

•         GiftCard: The request is related to a stored value card.

•         CreditCard: The request is related to a credit card.

cardNumber

The credit card number, stored value card number, or token number, if any, related to the request.

authenticationData

The PIN, if any, assigned to a stored value card, or the CVV number for a credit card.

emailAddress

The email address for the customer. Not included for a stored value card generate request.

merchantId

The Merchant ID specified for the service bureau. Blank if no Merchant ID is specified.

compCurrency

The Currency code defined in the Local Currency Code (A55) system control value.

vendCurrency

The Authorization service currency specified for the Currency, as set up through the Work with Authorization Currency screen. May include trailing blanks.

vendPaymentMethod

The Vendor Pay Code specified for the pay type, as set up through the Work with Pay Type Cross Reference screen.

ecommerceIndicator

Indicates whether the order was placed on a web storefront. Valid values are:

•         true = The order was placed over the web storefront. This value is used if the order type matches the E-Commerce Order Type (G42).

•         false = The order was not placed over the web storefront. This value is used if the order type does not match the E-Commerce Order Type (G42).

From the Ecomm Indic field in the Order Payment Method table.

useTokenization

Set to Y if tokenization is enabled; otherwise, set to N. Based on the setting of the Use Credit Card Tokenization (L18) system control value.

requestAuth

Indicates whether authorization is required for a stored value card or credit card deposit request, where Y indicates an authorization + deposit, while N indicates deposit only; otherwise, not used.

billToAuthServiceCountry

The authorization service country, as set up through Defining Authorization Service Countries.

Subsequent Authorization Tags

The following tags are available in version 2.0 of the message (Update 20.0 of Order Management System) and are included for the subsequent authorizations listed under Subsequent Authorization Requests through the External Payment Service. See Defining Authorization Services (WASV) for information on setting the Message Version.

ciTransactionId

The customer-initiated transaction ID, if known. This transaction ID could be from the CWOrderIn message that originated the order, or from the ciTransactionId passed in the authorization response message.

See Subsequent Authorization Requests through the External Payment Service for a discussion.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).

subsequentAuth

Set to Y if this is a subsequent authorization request for a credit card, and the ci_transaction_id is stored on the Order Payment Method record. See the discussion of the subsequentAuthTransactionID, below, for more information.

Set to N if this is the first authorization request for the credit card. This might occur if the order was initially created without the authorization, or if the credit card number was changed.

Not passed if this is an authorization request for a stored value card.

See Subsequent Authorization Requests through the External Payment Service for a discussion.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).

subsequentAuthTransactionID

The ci_transaction_id identifying the authorization. Passed when this is a subsequent authorization either from a previous message through the External Payment Service, through the ci_transaction_id received in the Inbound Order XML Message (CWORDERIN), or from the customer membership if this is a generated membership order. Otherwise, not passed.

See Subsequent Authorization Requests through the External Payment Service for a discussion.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).

subsequentAuthReason

Passed only for a subsequent authorization request. Possible reasons:

RESUBMIT: You need to obtain an authorization for a customer-initiated purpose. This situation can occur when the original authorization was declined for insufficient funds and the goods or services have already been delivered to the customer. This reason is passed only if the Supports Auth Resubmission flag is selected for the authorization service; otherwise, the reason passed is REAUTH.

INSTALLMENT: This is a delayed charge related to deferred or installment billing. Used only if the pay type has Notify of installments selected; otherwise, this tag is set to REAUTH.

REAUTH: One of the following is true:

•         The request is for a reauthorization for a split shipment or delayed shipment. A split or delayed shipment occurs when some of the goods that were ordered are not available for shipment at the time of purchase. When you ship goods after the authorization validity time limit set by Visa, you must perform a separate authorization to ensure that customer funds are available.

•         The request is for a delayed charge related to deferred or installment billing if the pay type has Notify of installments unselected.

•         The authorization request is for a generated membership order after the authorization was obtained for the customer membership.

•         You need to obtain an authorization for a custom-initiated purpose, as described above under RESUBMIT; however, the Supports Auth Resubmission flag is not selected for the authorization service.

Note:  Even if the order uses deferred and installment billing and Notify of installments is selected, the reason passed is still REAUTH if an authorization is required for other reasons, such as adding new items or the original authorization expiring.

See Subsequent Authorization Requests through the External Payment Service for a discussion.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).

subsequentAuthOriginalAmount

The amount of the original approved authorization. This is the authorization amount from the oldest Auth History record, or from the customer membership if this is for a generated membership order.

Passed only when the ci_transaction_id is stored on the Order Payment Method, either in a previous message through the External Payment Service, through the ci_transaction_id received in the Inbound Order XML Message (CWORDERIN).

See Subsequent Authorization Requests through the External Payment Service for a discussion.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).

subsequentAuthStoreCredential

Set to Y if the authorization credentials are stored. Passed when this is a subsequent authorization and the ci_transaction_id is stored on the Order Payment Method, either in a previous message through the External Payment Service, through the ci_transaction_id received in the Inbound Order XML Message (CWORDERIN).

See Subsequent Authorization Requests through the External Payment Service for a discussion.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).

The following tags are always passed in a deposit request for both credit cards and stored value cards if the message version is 2.0.

multipleCaptureSequence

Indicates the sequence number of the deposit based on the number of deposits against the authorization. Set to:

•         0 if Void auth at deposit is set to Y for the authorization service.

•         1 if Void auth at deposit is set to N for the authorization service, and this is the first capture for the deposit.

•         2 or higher if Void auth at deposit is set to N for the authorization service, and this is a subsequent authorization for the deposit.

See Multiple Capture Sequence and Final Capture Sent to External Payment Service andVoid Unused Authorization After Initial Deposit for a discussion and examples.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).

finalCapture

Indicates whether this is the final capture against the authorization. Set to:

•         empty if Void auth at deposit is set to Y for the authorization service.

•         Y if there are no additional shipments remaining against the authorization.

•         N if there are additional shipments remaining against the authorization.

See Multiple Capture Sequence and Final Capture Sent to External Payment Service andVoid Unused Authorization After Initial Deposit for a discussion and examples.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).

cca: Included for:

•         Credit card: authorization, reversal, and token request

•         Stored value card: activation, authorization, balance, generate, recharge, and reversal request

The fields in the cca container are primarily from the CC_Authorization_Trans table. Not all of these fields are used.

   "cca":{  
       "ccNbrAsBlob":{

        "buf":[

        ],

        "len":0,

        "origLen":0

     },      

      "vendorResp":"",
      "vendorResp2":" ",
      "authNbr":" ",
      "authDate":0,
      "alphaOrderNbr":"00001234",
      "expireMonth":0,
      "expireYear":0,
      "AVSResp":" ",
      "chargeDesc":"SVC",
      "authAmt":100,
      "custNbr":197,
      "custLastName":"LAST",
      "custFirstName":"FIRST",
      "addrLine1":"99 EXAMPLE ADDRESS LINE ONE",
      "addrLine2":"APART 999",
      "billtoCity":"MANSFIELD",
      "billtoState":"MA",
      "billtoZip":"02048",
      "billtoExtraZip":" ",
      "billtoCountry":"US",
      "phoneNbr":0,
      "ordNbr":1234,
      "opmSeqNbr":0,
      "auhSeqNbr":0,
      "authService":"EXT",
      "currCode":" ",
      "lastModifiedPgm":" ",
      "selected":false
   }

ccd: Included for credit card and stored value card deposit and return requests.

The fields in the ccd container are primarily from the CC_Deposit_Transaction table. Not all of these fields are used.

   "ccd":{  
      "id":{  
         "cmp":9,
         "ordNbr":1234,
         "invNbr":INV,
         "ordPayMethodSeqNbr":1,
         "selected":false      },
      "transType":"*PURCH",
       "ccNbrAsBlob":{

        "buf":[

        ],

        "len":0,

        "origLen":0

     },

      "transStatus":"*RDY",
      "vendorResp":"",
      "vendorResp2":" ",
      "authNbr":"AUTHNBR",
      "authDate":1180613,
      "alphaOrderNbr":" ",
      "merchantName":" ",
      "oasisPayType":0,
      "oasisPayCode":" ",
      "companyDivision":" ",
      "expireMonth":0,
      "expireYear":0,
      "AVSResp":" ",
      "custLastName":"LAST",
      "custFirstName":"FIRST",
      "addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
      "addrLine2":"APART 999",
      "billtoCity":"MANSFIELD",
      "billtoState":"MA",
      "billtoZip":"02048",
      "billtoExtraZip":" ",
      "billtoCountry":"US",
      "transDate":1180613,
      "transTime":164638,
      "longInvoiceNbr":528,
      "merchDollars":30,
      "freightDollars":0,
      "addlFreightDollars":1.67,
      "totalTaxDollars":2.38,
      "GSTTaxDollars":0,
      "PSTTaxDollars":0,
      "addlTaxDollars":0,
      "handlingDollars":0,
      "totalDollars":34.05,
      "depositMerchantNbr":" ",
      "flexPaymentType":" ",
      "authService":"EXT",
      "payType":34,
      "currCode":" ",
      "selected":false  }

The tags included in the cca or ccd container are described below. Because these containers contain many of the same tags, the listing is combined. The listing indicates tags that are included in only the cca or ccd container.

cmp

The code identifying the company originating a deposit or return request. Included in the ccd container.

ordNbr

The order number related to a credit card authorization, deposit, return, reversal, or token request, and a stored value card activation, authorization, deposit, generation, recharge, return, or reversal request.

invNbr

The invoice number related to a shipment or return related to a deposit or return request. Included in the ccd container.

ordPayMethodSeqNbr

The unique sequence number identifying the stored value card or credit card used on the order. Used for stored value card and credit card deposit and return requests. Included in the ccd container.

ccNbrAsBlob

Added automatically. Not mapped.

LRAid

May be included only in the ccd container for a credit card deposit request, but left blank. Not currently implemented.

selected

Set to false. Included in the ccd container.

transType

Set to:

•         PURCH:

-      Credit card requests: authorization request with token, deposit request, and reversal request

-      Stored value card requests: activation request, authorization request, recharge request, and reversal request

•         RETURN for a credit card return request or stored value card return request

Otherwise, not included.

creditCardNbr

Always blank.

transStatus

Set to RDY for:

•         Credit card requests: authorization request with token, deposit request, return request, and reversal request

•         Stored value card requests: activation request, deposit request, recharge request, return request, and reversal request

Otherwise, not included.

vendorResp

Not currently implemented.

vendorResp2

Not currently implemented.

authNbr

The authorization number related to a credit card or stored value card deposit or reversal request.

authDate

The authorization date for a credit card or stored value card deposit or reversal request.

alphaOrderNbr

The Web Order number, if any, from the E-commerce order number from the Order Header Extended table.

merchantName

Not currently implemented.

authMerchantNbr

Not currently implemented.

oasisPayType

Not currently implemented.

oasisPayCode

Not currently implemented.

oasisPayTypeCode

Not currently implemented.

companyDivision

Not currently implemented.

expireMonth

From the first two positions of the Expiration date. The month when the credit card is no longer active.

expireYear

From the second two positions of the Expiration date. The year when the credit card is no longer active.

AVSResp

From the AVS response. A code representing the address verification response for the credit card authorization if AVS is used.

If AVS is not used, this field is blank.

The AVS response code is from the AVS response field in the Authorization History table.

See Address Verification Service (AVS).

chargeDesc

Set to SVC for a credit card reversal, and for a stored value card activation request, recharge request, or reversal request; otherwise, not used. Included in the cca container.

authAmt

The authorization amount requested for a credit card authorization request or reversal request, and for a stored value card activation request, recharge request, or reversal request; otherwise, not used. Included in the cca container.

reauthCode

May be included in the cca container. Not currently implemented.

mailPhoneOther

May be included in the cca container. Not currently implemented.

oasisHoldRsn

May be included in the cca container. Not currently implemented.

vendHoldRsn

May be included in the cca container. Not currently implemented.

termPayCode

May be included in the cca container. Not currently implemented.

custNbr

The customer number for a stored value card activation, authorization, recharge, or reversal request, and for a credit card authorization, reversal, or token request. Included in the cca container.

custLastName

The sold-to customer’s last name. Always included in the cca or ccd container.

custFirstName

The sold-to customer’s first name. Always included in the cca or ccd container.

addrLine1

The first line of the sold-to customer’s address. Always included in the cca or ccd container.

addrLine2

The second line of the sold-to customer’s address. Always included in the cca or ccd container.

billtoCity

The city of the sold-to customer’s address. Always included in the cca or ccd container.

billtoState

The state or province of the sold-to customer’s address. Always included in the cca or ccd container.

billtoZip

The zip or postal code of the sold-to customer’s address. Always included in the cca or ccd container.

billtoExtraZip

The additional positions of the zip or postal code of the sold-to customer’s address.

billtoCountry

The sold-to customer’s country code. Always included in the cca or ccd container.

phoneNbr

Not currently implemented. Included in the cca container.

phoneType

Included in the cca container.

transDate

The date of the transaction.

transTime

The time of the transaction.

ccPassCode

Set to P in a stored value card activation request, and set to V in a stored value card recharge request. (When the stored value card is a virtual card (the ccPassCode is set to V), the card is activated through a recharge request rather than an activation request.) Otherwise, not used. Included in the cca container.

opmSeqNbr

A unique sequence number to identify the payment method on the order. Populated for a stored value card authorization or reversal request, and for a credit card authorization, reversal, or token request. Included in the cca container.

auhSeqNbr

A unique sequence number to identify the authorization on the order. Populated for a stored value card activation, authorization, balance, recharge, or reversal request, and for a credit card authorization or token request. Included in the cca container.

longInvoiceNbr

The invoice number. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

merchDollars

The total merchandise value. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

freightDollars

The total freight value. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

addlFreightDollars

The total additional freight value. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

totalTaxDollars

The total tax value. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

GSTTaxDollars

The total GST value. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

PSTTaxDollars

The total PST value. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

addlTaxDollars

The total additional tax value. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

handlingDollars

The total handling value. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

totalDollars

The total value of the deposit or return. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

depositMerchantNbr

The account number assigned by the service bureau to identify transmissions to and from your company. Populated for a stored value card deposit or return request, and for a credit card deposit or return request. Included in the ccd container.

flexPaymentType

Identifies whether a deposit is for an installment or deferred billing. Included in the ccd container.

authService

The 3-position alphanumeric code to identify the service bureau.

payType

From the Pay type. The pay type code associated with this order.

Pay type codes are defined in and validated against the Pay Type table. See Working with Pay Types (WPAY).

currCode

The code identifying the currency used on the order, if different from the default.

lastModifiedPgm

Not currently implemented.

selected

Set to false.

orderPaymentMethod

Each tag is described briefly below. Details on order payment methods are available for review in order inquiry. See Reviewing Payment Methods for more information.

   "orderPaymentMethod":{  
      "id":{  
         "cmp":9,
         "ordNbr":1234,
         "seqNbr":1,
      "amtToChg":0.01,
      "amtAuth":0,
      "amtBilled":0,
      "amtCollected":0,
      "amtCredited":0,
      "authDate":0,
      "authNbr":" ",
      "manualAuthAmt":0,
      "cashApplDate":0,
      "cashCtrlNbr":0,
      "chgSeq":99,
      "expirationDate":0,
      "giftCertificateCpnNbr":0,
      "payCategory":"2",
      "cardSecurityVal":0,
      "deferBill":"N",
      "holdUntilDate":0,
      "issuingBank":" ",
      "nbrDaysForDeferral":0,
      "fixDateForDeferral":0,
      "nbrOfInstallments":0,
      "installmentInterval":0,
      "fixInstallmentBillDay":0,
      "fpoExpirationDate":0,
      "suppressDeposit":" ",
      "suppressRefund":" ",
      "checkingAct":" ",
      "authVal":" ",
      "ecommIndicator":" ",
      "checkIntefaceDownload":0,
      "cardStartDate":0,
      "checkNbr":0,
      "routingNbr":0,
      "pinStorage":0,
      "cardSecurityPresence":" ",
      "cardIssueNbr":" ",
      "payType":34,
      "holdRsn":"CW",
      "fpoPmtCode":" ",
"ccNbr":[

     ],

     "ccNbrAsBlob":{

        "buf":[

        ],

        "len":0,

        "origLen":0

     },

      ],
      "ccLast4":" ",
      "tokenized":" ",
      "verifiedToken":" ",
      "bin":" ",
      "lastModifiedPgm":"OrderPaymentMethodDAL.updateHoldReason",

     "ciTransactionId":"124567890",

     "ccNumberChange":" ",

     "originalAmountAuthorized":12.34,
      "selected":false

id

Includes identifying information about the service bureau.

cmp

The company where the service bureau was created.

ordNbr

The order associated with the order payment method.

seqNbr

An internal sequence number to identify the order payment record.

LRAId

May be included. Not currently implemented.

creditCardNbr

Always blank.

selected

Set to false.

amtToChg

From the Amount to charge. The total value charged to the payment method. If no value is specified, then this payment type serves as a “catch-all,” meaning any amount not assigned to another payment method applies to this one.

amtAuth

From the Amount authorized. The amount authorized for the credit card payment.

amtBilled

From the Amount billed. For credit card payments, this is the total amount billed to the credit card. The system updates this amount as soon as the card is billed even before you process deposits. If you are using deferred or installment billing, the total amount to charge the card displays, even if the total amount has not yet been billed.

amtCollected

From the Amount collected. An amount is collected when a shipment is billed using a credit card payment type.

Note: This field is updated before you process deposits, and the update occurs regardless of whether the credit card uses a deferred or installment payment plan or is set up for immediate deposit.

amtCredited

From the Amount credited. The amount from this payment type that the customer has received as credit or refund, represented by the creation of a refund in the Refund table. This information is updated when the refund is processed.

authDate

From the Authorization date. The month, day, and year that your credit card authorization service confirmed or authorized the customer's credit card for the order, or you manually authorized the credit card.

authNbr

From the Authorization number. The number you used when you manually authorized the credit card, or the authorization service assigned when authorizing the credit card. The number can be overridden for manual or authorization service updates, and clears when the order is purged.

For orders using a payment plan, the system retains the original authorization number from pick slip generation, even after you receive a full authorization for deposit.

manualAuthAmt

Not implemented in these messages.

cashApplDate

Not implemented in these messages.

cashCtrlNbr

Not implemented in these messages.

chgSeq

From the Charge sequence setting. A number that designates the order in which a payment method is used.

expirationDate

From the Expiration date. The date the credit card is no longer active. The expiration date may be zero, depending on the setting of the Require expiration date flag for the pay type. For example, a stored value card credit card type typically does not require an expiration date.

giftCertificateCpnNbr

Not implemented in these messages.

payCategory

Set to 2.

cardSecurityVal

The card security value, if any. See Credit Card Security Service (CID, CVV2, CVC2) for a discussion.

deferBill

Set to Y if the payment method is flagged for deferred billing; otherwise, set to N.

holdUntilDate

From the Hold until date. The date when the order is eligible for release through the Release Orders on Time Hold Periodic Function. You can assign a number of days for the system to add when calculating the hold date to each response code you receive from an authorization service. See Defining Vendor Response Codes for more information on setting up vendor responses for authorization services, and releasing orders from time hold.

issuingBank

Not implemented in these messages.

nbrDaysForDeferral

From the # days for deferral. The number of days the payment is deferred. This field is used with deferred payment plans only.

fixDateForReferral

From the Fix date for deferral. The day of the month when payment for this order is due. This field is used with deferred payment plans only.

nbrOfInstallments

From the # of installments. The number of installments for this order. This field is used with installment payment plans only.

fixInstallmentBillDay

From the Fixed installment date. The day of the month when each installment is due. This field is used with installment payment plans only.

fpoExpirationDate

From the Expiration date. The date when this payment plan expires.

suppressDeposit

From the Suppress deposit setting. Indicates whether the system will include this invoice payment method when you run Processing Auto Deposits (SDEP).

suppressRefund

From the Suppress refund setting. Indicates whether the system will ever generate a refund for this payment method. A selected setting indicates that system will never generate a refund to the customer for this payment method; instead, any refund will be created in a cancel pending status, and canceled when you process refunds.

checkingAct

Not implemented in these messages.

authVal

Not implemented in these messages.

ecommIndicator

Not implemented in these messages.

checkInterfaceDownload

Not implemented.

cardStartDate

From the Start date. The first date when the card is effective. The Require start date flag for the pay type controls whether the start date is required or optional.

checkNbr

Not implemented in these messages.

routingNbr

Not implemented in these messages.

pinStorage

Not implemented in these messages.

cardSecurityPresence

From the Card security presence setting. Indicates to the authorization service whether a card security value (CID, CVV, CVC) is present on the credit card. If a card security presence exists for the credit card payment method, the authorization service performs card security identification.

cardIssueNbr

From the Issue #. An incremental issue number, assigned by some banks when they replace a card because it is lost or stolen.

payType

From the Pay type. The pay type code associated with this order.

Pay type codes are defined in and validated against the Pay Type table. See Working with Pay Types (WPAY).

holdRsn

Not implemented in these messages.

fpoPmtCode

From the Pay plan code. The payment plan code and description associated with the pay type on this order.

Payment plan codes are defined in and validated against the Flexible Payment Options table. See Working with Flexible Payment Options (WFPO).

ccLast4

From the CC Last 4. The last four positions of the credit card number. From the CC Last 4 field in the Order Payment Method table.

If you use credit card encryption, the system does not encrypt the value in this field.

tokenized

Set to Y if the credit card is tokenized; otherwise, blank.

verifiedToken

Not currently implemented.

bin

The first six digits of the actual credit card number in order to perform Level II and III Discounting on the card during deposit processing.

Updates the Bin field in the Order Payment Method table if the credit card number is replaced with a token otherwise, the system does not store the bin number. If this value is not passed and the credit card number is replaced with a token, the system updates the Bin with the first 6 positions of the credit card number.

lastModifiedPgm

The program that most recently updated the Order Payment Method record.

selected

Set to false.

authorizationService

This container provides information on the service bureau. Each tag is described briefly below. See Defining Authorization Services (WASV) for more information.

   "authorizationService":{  
      "id":{  
         "cmp":9,
         "authService":"EXT",

      }
       "application":"ATDP",
      "batchOnline":"C",
      "mediaType":"C",
      "activeProductionSys":"Y",
      "addrVerification":"Y",
      "declineDays":10,
      "selectForDeposit":"Y",
      "immediateDeposit":"Y",
      "immediateResp":"Y",
      "industryFormat":"INDCD",
      "installmentBilling":"Y",
      "keepHist":"Y",
      "chgDesc":"EXTERNAL SERVICE",
      "merchantId":"merchant id for ext",
      "password":"password",
      "receivingCode":"RECCODE",
      "signon":"signon",
      "startUpInfo":"STARTUPINFO",
      "subCode":"SUBCODE",
      "fileSeqNbr":0,
      "presenterId":"PRESIDAU",
      "PIDPassword":"password",
      "submitterId":"SUBAUTH",
      "SIDPassword":"password",
      "presenterIdDep":"PRESIDDP",
      "PIDPasswordDep":"password",
      "submitterIdDep":"SUBDEP",
      "SIDPasswordDep":"password",
      "APIUsername":"api user name",
      "APIPassword":"password",
      "APISignature":"api signature",
      "selected":false   },

id

Includes identifying information about the service bureau.

cmp

The company where the service bureau was created.

authService

The 3-position alphanumeric code to identify the service bureau.

LRAId

May be included. Not currently implemented.

selected

Set to false.

application

From the Application setting. The type of activity performed by the service bureau.

Valid values are:

•         ATDP= The service bureau authorizes card charges and deposits dollar amounts billed to the cards.

•         AT = The service bureau only authorizes card charges.

•         DP = The service bureau only deposits dollar amounts billed to cards.

batchOnline

From the Batch/Online setting. A code that indicates whether transactions are transmitted to/received from the service bureau immediately (online) as each order is entered, or whether groups of transactions are transmitted to/received from the service bureau at predefined times during the day (in batch).

Possible settings are:

•         B (batch) = Transactions are grouped and transmitted to/received from the service bureau at predefined times throughout the day.

•         I (on-line) = Transactions are transmitted to/received from the service bureau immediately for each order.

•         C (online or batch) = Transactions are transmitted to/received from the service bureau immediately if the order is eligible for online authorization. Any order that does not receive an authorization immediately is grouped and transmitted to/received from the service bureau at predefined times.

mediaType

The method by which the data is transmitted to the service bureau. Set to C (communication).

activeProductionSys

Indicates whether you are processing in a live environment (production) or in a testing environment.   

Valid values are:

•         Y = Transactions are being processed in a live environment.

•         N = Transactions are being processed in a testing environment.

addrVerification

From the Address verification setting. Indicates whether you will be using the Address Verification Service provided by the service bureau to verify the customer's address and credit card number.

Valid values are:

•         Y = Perform address verification

•         N = Do not perform address verification

See Address Verification Service (AVS).

declineDays

Not currently implemented.

selectForDeposit

From the Selected for deposit setting. Indicates whether the service bureau is included in the next deposit run. By default, all service bureaus are selected for deposit; however, you can remove a service bureau from the next deposit run at the Select Auth Service for Deposit Screen in Processing Auto Deposits (SDEP). Once you submit the deposit run, the system reselects all service bureaus for the next deposit run.

Possible values are:

•         Y (default) = The system includes the service bureau in the next deposit run.

•         N = The system does not include the service bureau in the next deposit run.

immediateDeposit

From the Immediate deposit setting. Indicates whether the service bureau sends a detailed response to Order Management System.

Valid values are:

•         Y = The service bureau does not send a detailed response to Order Management System; Order Management System marks the transaction as received and subsequently confirmed.

•         N = The service bureau sends a detailed response to Order Management System; Order Management System waits for the response based on the Wait time defined for the associated integration layer job.

immediateResp

From the Immediate response setting. Indicates whether a response from the service bureau is received immediately for each authorization transaction.

Valid values are:

•         Y = Responses from the service bureau are received immediately for each transaction.

•         N = Responses from the service bureau are not received immediately (delayed turnaround).

industryFormat

From the Industry format code. A code that is assigned by the service bureau to identify your company type.

installmentBilling

From the Installment billing? setting. Indicates if the service bureau supports installment billing of credit cards. Installment billing plans are typically established for high cost items.

Note:  This field is informational only and is not used to set up an installment pay plan in Order Management System.

Valid values are:

•         Y = The service bureau supports installment billing.

•         N = The service bureau does not support installment billing.

keepHist

From the Keep history information? setting. Indicates whether transactions sent to the service bureau will be kept online. Typically, this feature is used in test environments.

Valid values are:

•         Y = Keep the transaction records on-line.

•         N = Do not keep the transaction records on-line.

chgDesc

From the Charge description. A description that identifies your company's product line or the type of service performed.

merchantId

From the Merchant ID or from a merchant ID override. The account number assigned by the service bureau to identify transmissions to/from your company. See Defining Merchant ID Overrides for more information.

password

From the Password.

receivingCode

From the Receiving code. A code that identifies your company to the service bureau.

signon

From the Signon. A code required to sign on to the service bureau.

startUpInfo

From the Start up information. Startup text that identifies your company to the service bureau.

subCode

From the Sub code. A code required to sign on to the service bureau.

fileSeqNbr

Not currently implemented.

presenterId

From the Presenter’s ID. A code required to sign on to the service bureau.

PIDPassword

From the PID password. A password required to sign on to the service bureau.

SubmitOrder

From the Submitter’s ID. A code required to sign on to the service bureau.

SIDPassword

From the SID Password. A password required to sign on to the service bureau.

presenterIdDep

From the Presenter’s ID / Deposit (field after the auth ID). A code required to sign on to the service bureau.

PIDPasswordDep

From the PID password / Deposit (field the auth ID) A code required to sign on to the service bureau.

submitterIdDep

From the Submitter’s ID / Deposit (field after the auth ID). A code required to sign on to the service bureau.

SIDPasswordDep

From the SID password / Deposit (field after the auth ID). A password required to sign on to the service bureau.

APIUsername

From the API User name. The user name, provided by the service bureau, used to establish a direct connection to the service bureau.

APIPassword

From the API Password. The password, provided by the service bureau, used to establish a direct connection to the service bureau.

APISignature

From the API Signature. The encrypted signature, provided by the service bureau, used to establish a direct connection to the service bureau.

selected

Set to false.

authorizationServiceExt

This container provides additional information on the service bureau. Each tag is described briefly below. See Defining Authorization Services (WASV) for more information.

   "authorizationServiceExt":{  
      "id":{  
         "cmp":9,
         "authService":"EXT",
      "authPhoneNbr":5085550100,
      "depositPhoneNbr":5085550101,
      "communicationType":"P",
      "respCheckFreq":5,
      "testMode":"Y",
      "authSrvProvider":"AUTHPR",
      "merchDiv":123456,
      "providerNetworkAddr":" ",
      "portNbr":0,
      "respTime":1000,
      "deferredMerchId":"DEFERRED MERCHANT ID",
      "installmentMerchId":"INSTALLMENT MERC ID",
      "excludeFromFlexPay":"Y",
      "onLineILPProc":"CCAUTH_ONL",
      "batchILPProc":"CCAUTH_BTH",
      "depositILPProc":"DEPOSITS",
      "svcActivationProc":"SVC_OUT",
      "svcBalInqProc":"SVC_BALANC",
      "primaryAuthSrv":".IL",
      "requestToken":"N",
      "voidAuth":"Y",
      "allowReversal":"Y",
      "selected":false   }

id

Includes identifying information about the service bureau.

cmp

The company where the service bureau was created.

authService

The 3-position alphanumeric code to identify the service bureau.

LRAId

May be included. Not currently implemented.

selected

Set to false.

authPhoneNbr

The Authorization phone # defined for the service. Informational.

depositPhoneNbr

The Deposit phone # defined for the service. Informational.

communicationType

From the Communication type. Should be set to P (Payment Link).

respCheckFreq

From the Response check frequency. Indicates the number of seconds to wait between checking for a response from the authorization service. The system will continue to check at this interval for a total of 20 minutes.

testMode

Not currently implemented.

authSrvProvider

From the Authorization service provider. Not currently implemented.

merchDiv

From the Merchant division. Assigned by the authorization service.

providerNetworkAddr

Not currently implemented.

portNbr

Not currently implemented.

respTime

From the Response time. Indicates the number of seconds to wait for an authorization response if you are performing online credit card authorization.

deferredMerchId

From the Deferred merchant ID. The account number assigned by the service to identify transmission of deferred pay plan transactions for deposit. See Deferred/Installment Billing Overview for more information on deferred and installment billing, and see Processing Auto Deposits (SDEP) for more information on processing deposits.

You can also set up overrides for different entities in your company, including deferred or installment overrides. See Defining Merchant ID Overrides.

installmentMerchId

From the Installment merchant ID. The account number assigned by the service to identify transmission of installment pay plan transactions for deposit. See Deferred/Installment Billing Overview, and see Processing Auto Deposits (SDEP).

You can also set up overrides for different entities in your company, including deferred or installment overrides. See Defining Merchant ID Overrides.

excludeFromFlexPay

From the Exclude from FPO setting. Indicates whether to exclude orders associated with this service bureau from a deferred or installment pay plan. If an order includes any pay type whose authorization service has this field selected, the order is not eligible for a pay plan.

Valid values are:

•         T = exclude from pay plan

•         N = do not exclude from pay plan

See Deferred/Installment Billing Overview for information on how the system determines whether an order is eligible for a pay plan in order entry.

onLineILPProc

From the Online authorization setting. The name of the integration layer process used to transmit the online version of the Authorization Request XML Message (CWAuthorizationRequest) to the service bureau.

Enterable only if you are using online credit card authorization. Defined in and validated against the Integration Process Control table.

See Processing Authorizations and Deposits using an Integration Layer Process for an overview and required setup.

batchILPProc

From the Batch authorization setting. The name of the integration layer process used to transmit batch version of the Authorization Request XML Message (CWAuthorizationRequest) to the service bureau.

Integration Layer process codes are defined in and validated against the Integration Process Control table. If you enter a value that is not valid, an error message indicates: Integration layer process not found.

See Processing Authorizations and Deposits using an Integration Layer Process for an overview and required setup.

depositILPProc

From the Deposit setting. The name of the integration layer process used to transmit the Deposit Request XML Message (CWDepositRequest) to the service bureau.

Integration Layer process codes are defined in and validated against the Integration Process Control table.

See Processing Authorizations and Deposits using an Integration Layer Process for an overview and required setup.

svcActivationProc

From the SVC activation setting. The name of the integration layer process used to transmit the Authorization Request XML Message (CWAuthorizationRequest) for a stored value card activation to the service bureau.

Integration Layer process codes are defined in and validated against the Integration Process Control table.

See Stored Value Card Overview and Setup.

svcBalInqProc

From the SVC balance inquiry setting. The name of the integration layer process used to transmit the Authorization Request XML Message (CWAuthorizationRequest) for a stored value card balance inquiry to the service bureau.

Integration Layer process codes are defined in and validated against the Integration Process Control table.

See Stored Value Card Overview and Setup.

primaryAuthSrv

From the Primary authorization service. Should be set to .IL.

requestToken

From the Request token setting. Defines whether the service bureau uses credit card tokenization to replace the credit card number on a credit card payment with a token.

Possible values are:

•         Y = The service bureau supports tokenization.

•         N = The service bureau does not support tokenization.

See Credit Card Tokenization in the Data Security and Encryption Guide on My Oracle Support (1988467.1) for an overview and processing details.

voidAuth

From the Void auth at deposit setting. Defines whether any unused portion of an authorization for a credit card pay type should be voided at deposit time.

Possible values are:

•         Y = The system voids any unused portion of an authorization for a credit card pay type at deposit time.

•         N = The system retains any unused portion of an authorization for a credit card pay type at deposit time.

See Void Unused Authorization After Initial Deposit for processing details.

Stored value card pay types: The setting of the Retain Unused Stored Value Card Authorization After Deposit (J21) system control value defines whether the system automatically voids a partially deposited stored value card authorization. See Stored Value Card Deposits for processing details.

allowReversal

From the Send reversal setting. Defines whether the service bureau supports authorization reversals for credit card payments.

Possible values are:

•         Y = The service bureau supports authorization reversal processing for credit card pay types; see Credit Card Authorization Reversal.

•         N = The service bureau does not support authorization reversal processing for credit card pay types.

Regardless of the setting of this field, you can still perform stored value card authorization reversals; see Stored Value Card Authorization Reversal.

allowsResubmit

Indicates whether the Supports Auth Resubmission flag is selected for the authorization service. Possible values are:

•         true - The service bureau supports authorization resubmission.

•         false = The service bureau does not support authorization resubmission.

overrideReconciliatoinId

Not currently implemented for the External Payment Service.

LRAId

May be included. Not currently implemented.

selected

Set to false.

authorizationHistory

Each tag is described briefly below. Details on authorization history are available in order inquiry. See the Display Authorization History Screen and the Authorization History Details Window for more information.

No authorization record exists for:

•         Credit card requests: return requests and token requests.

•         Stored value card requests: activation requests, balance requests, generation requests, recharge requests, and return requests.

   "authorizationHistory":{  
      "id":{  
         "cmp":9,
         "ordNbr":1234,
         "ordPayMethodSeqNbr":1,
         "seqNbr":1,
         "selected":false      },
      "authSts":"S",
      "authAmt":12.55,
      "depositAmt":0,
      "authDate":0,
      "sentDate":1180614,
      "authNbr":" ",
      "vendorResp":" ",
      "vendorResp2":" ",
      "AVSResp":" ",
      "transactionId":" ",
      "authTime":0,
      "lastModifiedPgm":" ",
      "selected":false   }}

id

Includes additional information identifying the authorization history.

cmp

The company associated with the order.

ordNbr

The order associated with the authorization history.

seqNbr

An internal sequence number to identify the authorization history record.

ordPayMethodSeqNbr

An internal sequence number to identify the order payment method.

LRAId

May be included. Not currently implemented.

selected

Set to false.

authSts

The status of the authorization as updated by the system.

Valid values are:

•         blank = Not sent yet

•         S = Sent, but not received

•         A = Authorized

•         D = Declined

•         E = Expired; updated to this status by Pick Slip Generation only

•         O = Authorized, but not used

•         M = Mismatch Auth/Deposit (created for authorizations during deposits)

authAmt

The amount the service bureau authorized to be charged on the credit card.

depositAmt

The amount deposited to the bank for the charge.

authDate

The date the authorization service approved the amount to be charged.

sentDate

The date you transmitted the authorization to the authorization service.

authNbr

A number for the authorization transaction assigned by the authorization service.

vendorResp

A code representing the response of the authorization service.

The vendor response code is from the Vendor response 1 field in the Authorization History table.

vendorResp2

An additional code representing the response of the authorization service.

The vendor response code is from the Vendor response 2 field in the Authorization History table.

AVSResp

A code representing the address verification response for the credit card authorization if AVS is used.

The AVS response code is from the AVS response field in the Authorization History table.

See Address Verification Service (AVS).

transactionId

The transaction ID, or reference number, associated with the authorization transaction for the credit card payment.

authTime

The time the authorization service approved the amount to be charged.

lastModifiedPgm

The last program that updated the authorization history record.

selected

Set to false.

captureSequence

The current sequence number for the order payment authorization request id for a deposit. Set to 1 if this is the first deposit for the order, and incremented by 1 for each subsequent deposit.

captureCount

The total number of deposits made for the order payment method.

totalDeposited

The total amount deposited for an authorization.

captureVendorResp

The response code received when a deposit is rejected. This field is used identify resubmissions.

{  
   "cardNumber":"CARDNUMBER",
   "status":"ACCEPT",
   "reasonCode":"100",
   "authenticationData":"1234",
   "errorResponse":""
}

cardNumber

The card number returned to a successful stored value card generate request.

Required for a stored value card generate request.

transactionId

The transaction ID returned to a successful stored value card activation request, authorization request, or recharge request, or a successful credit card authorization request or deposit request.

If only a transactionId is returned to a stored value card authorization request, it is used as the Authorization Code. If both the transactionId and authorizationCode are returned, they are used as the Transaction Id and the Authorization Code, respectively.

Either the transactionId or the authorizationCode is required for a stored value card balance inquiry.

Required to successfully active or recharge a stored value card. If the response does not include the transactionId, then the card is not activated, even if the status passed in the response is ACCEPT, although the reason code is updated.

Required for deposit requests if the requestAuth in the request was set to Y, indicating an authorization + deposit.

status

Set to ACCEPT in a successful stored value card or credit card response; set to REJECT if the request has been rejected; otherwise, set to ERROR.

See the transactionId, above, for more discussion on when the status is ACCEPT but there is no transactionId for a stored value card activation or recharge request.

Reject or error response? When the status passed is REJECT or ERROR, the order goes on hold, and the authorization status is declined, and the record is cleared from the Credit Card Authorization Transaction table (CCAT00) if:

•         The reason code is defined as a response code for the authorization service with a hold reason specified, or

•         The reason code passed is not defined as a response code for the authorization service, or

•         No reason code is passed. In this case, the system sets the response code to SU.

Required for all request types.

balance

The current balance of the stored value card. Returned only to a stored value card balance inquiry, and required.

reasonCode

The reason code returned from the external service. Mapped through vendor response codes for the authorization service; see Defining Vendor Response Codes for more information.

Note:  When configuring a response code that indicates a reject from the External Payment Service, you need to define a Hold Reason of AT so that a rejected order goes on hold.

A response code of SU indicates that the service is unavailable.

Required for all request types.

approvedAmount

The approved amount returned to a successful stored value card authorization or recharge request, or to a credit card authorization request.

If this is a subsequent transaction, this amount updates the current authorization amount for the order if:

•         The message version 2.0 or higher is selected for the External Payment Service.

•         A ciTransactionId is also specified in the response.

•         The payment method is a credit card.

•         This is not already a subsequent transaction.

See Subsequent Authorization Requests through the External Payment Service for background.

Required for a stored value card recharge request or authorization request. For a REJECT/ERROR response, pass 0.00. Otherwise, not used.

authenticationData

The authentication data returned to a successful stored value card generate response.

Optional.

authorizationCode

The authorization code returned to a credit card authorization request or deposit request.

Required for credit card authorization requests.

Required for deposit requests if the requestAuth in the request was set to Y, indicating an authorization + deposit.

Optional for stored value card authorization requests; if not returned for a stored value card authorization request, the transactionId is used as the authorization code.

cvnResponseCode

The CVN response code returned to a credit card authorization request.

Optional.

avsCode

The address verification response code returned to a credit card authorization request.

Optional.

requestAuth

Returns the requestAuth setting from the stored value card or credit card deposit request.

Required for credit card deposit requests. A Y setting indicates an authorization + deposit, while an N setting indicates a deposit only.

token

Indicates the token in response to a token request, or if the credit card authorization request or deposit request useTokenization selected.

Optional for credit card authorization requests or deposit requests; required for token requests.

errorResponse

Indicates the error, if any, returned from the external service. Errors are written to the TRACE.log file.

If an error response of DEPOSIT_GREATER_THAN_AUTH is returned to a deposit request, along with a status of ERROR, then deposit requests will be generated for the authorization amounts of each individual authorization.

For more information: See Multiple Capture Sequence and Final Capture Sent to External Payment Service for an example of when this error might be returned for a stored value card.

ciTransactionId

The customer-initiated transaction ID. Should be passed only for a successful message. Updates the order payment method and authorization history only if the version message specified for the External Payment Service is 2.0 or higher, there is not already a customer-initiated transaction ID, and this is a credit card, and the response indicates a successful authorization.

See Subsequent Authorization Requests through the External Payment Service for a discussion.

Available in: Version 2.0 of the message (Update 20.0 of Order Management System).