Sample External Payment Service Transactions
Overview: The sample request and response messages included in this help topic are:
• Sample Stored Value Card (SVC) Messages
- SVC Activation Request and Response
- SVC Authorization Request and Response
- SVC Balance Request and Response
- SVC Deposit Request and Response
- SVC Deposit Request and Response (Authorization Greater than Deposit)
- SVC Generate Request and Response
- SVC Recharge Request and Response
- SVC Return Request and Response
- SVC Reversal Request and Response
• Sample Credit Card (CC) Messages
- CC Authorization Request and Response without Token
- CC Authorization Request and Response with Token
- CC Deposit Request and Response
- CC Deposit Request and Response with Authorization
- CC Return (Credit) Request and Response
- CC Reversal Request and Response
- CC Token Request and Response
Depending on your configuration, these messages are typically logged in the INTEGRATIONORDER.log file, while errors are logged in the TRACE.log file. Personal data is not written to the logs.
Sample Stored Value Card (SVC) Messages
SVC Activation Request and Response
Note: When the stored value card is a virtual card (the ccPassCode is set to V), the card is activated through a recharge request. See SVC Recharge Request and Response.
SVC Activation Request
{
"typeDescription":"ActivateRequest",
"requestType":"GiftCard",
"cardNumber":"1234567890123456",
"emailAddress":"john.f.kennedy@example.com",
"merchantId":"",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"billToAuthServiceCountry":"US",
"cca":{
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":" ",
"authDate":0,
"alphaOrderNbr":"00001133",
"merchantName":" ",
"authMerchantNbr":" ",
"oasisPayType":0,
"oasisPayCode":" ",
"oasisPayTypeCode":" ",
"companyDivision":" ",
"expireMonth":0,
"expireYear":0,
"AVSResp":" ",
"chargeDesc":"SVC",
"authAmt":100,
"reauthCode":" ",
"mailPhoneOther":" ",
"oasisHoldRsn":" ",
"vendHoldRsn":" ",
"termPayCode":" ",
"custNbr":197,
"custLastName":"TRUMAN",
"custFirstName":"HARRY",
"addrLine1":"99 EXAMPLE ADDRESS LINE ONE",
"addrLine2":"APART 999",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":" ",
"billtoCountry":"US",
"phoneNbr":0,
"phoneType":" ",
"transDate":1180614,
"transTime":144253,
"ccPassCode":"P",
"ordNbr":1133,
"opmSeqNbr":0,
"auhSeqNbr":0,
"authService":"EXT",
"currCode":" ",
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"creditCardNbr":[
],
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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
}
}
SVC Activation Response
{
"transactionId":"SVCACT1234",
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":""
}
SVC Authorization Request and Response
SVCAuthorization Request
{
"typeDescription":"AuthorizationRequest",
"requestType":"GiftCard",
"cardNumber":"1234567890123456",
"emailAddress":"chester.arthur@example.com",
"merchantId":"AUTHMERCH#PT34",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"EXT34",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"billToAuthServiceCountry":"US",
"cca":{
"creditCardNbr":[
],
"vendorResp":"",
"vendorResp2":"",
"authNbr":"",
"authDate":0,
"alphaOrderNbr":"009000001129001",
"expireMonth":0,
"expireYear":0,
"AVSResp":"",
"chargeDesc":"",
"authAmt":12.55,
"custNbr":197,
"custLastName":"JAMES",
"custFirstName":"POLK",
"addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
"addrLine2":"999 EXAMPLE STREET ADDRESS LINE TWO",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":"",
"billtoCountry":"US",
"phoneNbr":0,
"ordNbr":1129,
"opmSeqNbr":1,
"auhSeqNbr":1,
"authService":"EXT",
"currCode":"",
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1129,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":0,
"amtBilled":0,
"amtCollected":0,
"amtCredited":0,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":2,
"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":" ",
"creditCardNbr":[
],
"ccLast4":"4444",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"OrderPaymentMethodDAL.updateHoldReason",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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":"PIDAUTH",
"submitterId":"SUBAUTH",
"SIDPassword":"SIDAUTH",
"presenterIdDep":"PRESIDDP",
"PIDPasswordDep":"PIDDEP",
"submitterIdDep":"SUBDEP",
"SIDPasswordDep":"SIDDEP",
"APIUsername":"api user name",
"APIPassword":"api password",
"APISignature":"api signature",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1129,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":"S",
"authAmt":12.55,
"depositAmt":0,
"authDate":0,
"sentDate":1180614,
"authNbr":" ",
"vendorResp":" ",
"vendorResp2":" ",
"AVSResp":" ",
"transactionId":" ",
"authTime":0,
"lastModifiedPgm":" ",
"selected":false
}
}
SVC Authorization Response
{
"transactionId":"SVCAUTH4444",
"approvedAmount":11.67,
"status":"ACCEPT",
"reasonCode":"100"
}
SVC Balance Request and Response
SVC Balance Request
{
"typeDescription":"BalanceRequest",
"requestType":"GiftCard",
"cardNumber":"1234567890123456",
"authenticationData":"1234",
"emailAddress":"",
"merchantId":"AUTHMERCH#PT34",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"EXT34",
"ecommerceIndicator":"false",
"useTokenization":"Y",
"billToAuthServiceCountry":"",
"cca":{
"creditCardNbr":[
],
"alphaOrderNbr":"009000000000000",
"oasisPayCode":"034",
"authAmt":0,
"ordNbr":0,
"opmSeqNbr":0,
"auhSeqNbr":0,
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"creditCardNbr":[
],
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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":"SIDAUTH",
"presenterIdDep":"PRESIDDP",
"PIDPasswordDep":"PIDDEP",
"submitterIdDep":"SUBDEP",
"SIDPasswordDep":"SIDDEP",
"APIUsername":"api user name",
"APIPassword":"api password",
"APISignature":"api signature",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
}
}
SVC Balance Response
{
"balance":100.00,
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":""
}
SVC Deposit Request and Response
SVC Deposit Request
{
"typeDescription":"DepositRequest",
"requestType":"GiftCard",
"cardNumber":"1234567890123456",
"emailAddress":"thomas.jefferson@example.com",
"merchantId":"AUTHMERCH#PT34",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"EXT34",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"requestAuth":"N",
"billToAuthServiceCountry":"",
"ccd":{
"id":{
"cmp":9,
"ordNbr":1129,
"invNbr":531,
"ordPayMethodSeqNbr":1,
"selected":false
},
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":"SVCAUTH4444",
"authDate":1180614,
"alphaOrderNbr":" ",
"merchantName":" ",
"oasisPayType":0,
"oasisPayCode":" ",
"companyDivision":" ",
"expireMonth":0,
"expireYear":0,
"AVSResp":" ",
"custLastName":"MADISON",
"custFirstName":"JAMES",
"addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
"addrLine2":"APART 999",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":" ",
"billtoCountry":"US",
"transDate":1180614,
"transTime":95226,
"longInvoiceNbr":531,
"merchDollars":10,
"freightDollars":0,
"addlFreightDollars":1.67,
"totalTaxDollars":0.88,
"GSTTaxDollars":0,
"PSTTaxDollars":0,
"addlTaxDollars":0,
"handlingDollars":0,
"totalDollars":12.55,
"depositMerchantNbr":" ",
"flexPaymentType":" ",
"authService":"EXT",
"payType":34,
"currCode":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1129,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":12.55,
"amtBilled":12.55,
"amtCollected":12.55,
"amtCredited":0,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":2,
"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":" ",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"4444",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"FLR0270",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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":"SIDAUTH",
"presenterIdDep":"PRESIDDP",
"PIDPasswordDep":"PIDDEP",
"submitterIdDep":"SUBDEP",
"SIDPasswordDep":"SIDDEP",
"APIUsername":"api user name",
"APIPassword":"api password",
"APISignature":"api signature",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1129,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":"A",
"authAmt":11.67,
"depositAmt":11.67,
"authDate":1180614,
"sentDate":1180614,
"authNbr":"SVCAUTH4444",
"vendorResp":"100",
"vendorResp2":" ",
"AVSResp":" ",
"transactionId":"SVCAUTH4444",
"authTime":94052,
"lastModifiedPgm":"ExternalServiceBO.processAuthorizationResponse",
"selected":false
}
}
SVC Deposit Response
{
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":""
}
SVC Deposit Request and Response (Authorization Greater than Deposit)
SVC Deposit Request
{
"typeDescription":"DepositRequest",
"requestType":"GiftCard",
"cardNumber":"1234567890123456",
"emailAddress":"john.adams@example.com",
"merchantId":"AUTHMERCH#PT34",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"EXT34",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"requestAuth":"N",
"billToAuthServiceCountry":"",
"ccd":{
"id":{
"cmp":9,
"ordNbr":1123,
"invNbr":528,
"ordPayMethodSeqNbr":1,
"selected":false
},
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":"ABC123277100",
"authDate":1180613,
"alphaOrderNbr":" ",
"merchantName":" ",
"oasisPayType":0,
"oasisPayCode":" ",
"companyDivision":" ",
"expireMonth":0,
"expireYear":0,
"AVSResp":" ",
"custLastName":"WASHINGTON",
"custFirstName":"GEORGE",
"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
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1123,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":34.05,
"amtBilled":34.05,
"amtCollected":34.05,
"amtCredited":0,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":2,
"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":" ",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"2221",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"FLR0270",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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":"SIDAUTH",
"presenterIdDep":"PRESIDDP",
"PIDPasswordDep":"PIDDEP",
"submitterIdDep":"SUBDEP",
"SIDPasswordDep":"SIDDEP",
"APIUsername":"api user name",
"APIPassword":"api password",
"APISignature":"api signature",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1123,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":"A",
"authAmt":11.67,
"depositAmt":11.67,
"authDate":1180613,
"sentDate":1180613,
"authNbr":"ABC222277100",
"vendorResp":"100",
"vendorResp2":" ",
"AVSResp":" ",
"transactionId":"ABC222277100",
"authTime":163246,
"lastModifiedPgm":"ExternalServiceBO.processAuthorizationResponse",
"selected":false
}
}
SVC Deposit Response (Unsuccessful)
{
"status":"ERROR",
"reasonCode":"100",
"errorResponse":"DEPOSIT_GREATER_THAN_AUTH"
}
SVC Generate Request and Response
SVC Generate Request
{
"typeDescription":"GenerateRequest",
"requestType":"GiftCard",
"emailAddress":"",
"merchantId":"",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"",
"ecommerceIndicator":"false",
"useTokenization":"Y",
"billToAuthServiceCountry":"",
"cca":{
"creditCardNbr":[
],
"transStatus":"",
"authAmt":0,
"ordNbr":1128,
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"creditCardNbr":[
],
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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":"SIDAUTH",
"presenterIdDep":"PRESIDDP",
"PIDPasswordDep":"PIDDEP",
"submitterIdDep":"SUBDEP",
"SIDPasswordDep":"SIDDEP",
"APIUsername":"api user name",
"APIPassword":"api password",
"APISignature":"api signature",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
}
}
SVC Generate Response
{
"cardNumber":"1234567890554444",
"status":"ACCEPT",
"reasonCode":"100",
"authenticationData":"1234",
"errorResponse":""
}
SVC Recharge Request and Response
SVC Recharge Request
{
"typeDescription":"RechargeRequest",
"requestType":"GiftCard",
"cardNumber":"1234567890123456",
"authenticationData":"1234",
"emailAddress":"john.f.kennedy@example.com",
"merchantId":"",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"billToAuthServiceCountry":"US",
"cca":{
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":" ",
"authDate":0,
"alphaOrderNbr":"00001128",
"merchantName":" ",
"authMerchantNbr":" ",
"oasisPayType":0,
"oasisPayCode":" ",
"oasisPayTypeCode":" ",
"companyDivision":" ",
"expireMonth":0,
"expireYear":0,
"AVSResp":"1234",
"chargeDesc":"SVC",
"authAmt":100,
"reauthCode":" ",
"mailPhoneOther":" ",
"oasisHoldRsn":" ",
"vendHoldRsn":" ",
"termPayCode":" ",
"custNbr":197,
"custLastName":"LINCOLN",
"custFirstName":"ABRAHAM",
"addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
"addrLine2":"APART 999",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":" ",
"billtoCountry":"US",
"phoneNbr":0,
"phoneType":" ",
"transDate":1180614,
"transTime":90217,
"ccPassCode":"V",
"ordNbr":1128,
"opmSeqNbr":0,
"auhSeqNbr":0,
"authService":"EXT",
"currCode":" ",
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"creditCardNbr":[
],
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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":"SIDAUTH",
"presenterIdDep":"PRESIDDP",
"PIDPasswordDep":"PIDDEP",
"submitterIdDep":"SUBDEP",
"SIDPasswordDep":"SIDDEP",
"APIUsername":"api user name",
"APIPassword":"api password",
"APISignature":"api signature",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
}
}
SVC Recharge Response
{
"transactionId":"ABCDE123456",
"approvedAmount":100.00,
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":""
}
SVC Return Request and Response
SVC Return Request
{
"typeDescription":"ReturnRequest",
"requestType":"GiftCard",
"cardNumber":"1234567890123456",
"emailAddress":"james.monroe@example.com",
"merchantId":"AUTHMERCH#PT34",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"EXT34",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"billToAuthServiceCountry":"",
"ccd":{
"id":{
"cmp":9,
"ordNbr":1129,
"invNbr":532,
"ordPayMethodSeqNbr":1,
"selected":false
},
"transType":"*RETURN",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":" ",
"authDate":0,
"alphaOrderNbr":" ",
"merchantName":" ",
"oasisPayType":0,
"oasisPayCode":" ",
"companyDivision":" ",
"expireMonth":0,
"expireYear":0,
"AVSResp":" ",
"custLastName":"VAN BUREN",
"custFirstName":"MARTIN",
"addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
"addrLine2":"APART 999",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":" ",
"billtoCountry":"US",
"transDate":1180614,
"transTime":114606,
"longInvoiceNbr":532,
"merchDollars":10,
"freightDollars":0,
"addlFreightDollars":0,
"totalTaxDollars":0.75,
"GSTTaxDollars":0,
"PSTTaxDollars":0,
"addlTaxDollars":0,
"handlingDollars":0,
"totalDollars":10.75,
"depositMerchantNbr":" ",
"flexPaymentType":" ",
"authService":"EXT",
"payType":34,
"currCode":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1129,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":12.55,
"amtBilled":12.55,
"amtCollected":12.55,
"amtCredited":10.75,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":2,
"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":" ",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"4444",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"FLR0270",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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":"SIDAUTH",
"presenterIdDep":"PRESIDDP",
"PIDPasswordDep":"PIDDEP",
"submitterIdDep":"SUBDEP",
"SIDPasswordDep":"SIDDEP",
"APIUsername":"api user name",
"APIPassword":"api password",
"APISignature":"api signature",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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
}
}
SVC Return Response
{
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":""
}
SVC Reversal Request and Response
SVC Reversal Request
{
"typeDescription":"ReversalRequest",
"requestType":"GiftCard",
"cardNumber":"1234567890123456",
"emailAddress":"William.harrison@example.com",
"merchantId":"AUTHMERCH#PT34",
"compCurrency":"USD",
"vendCurrency":"400 ",
"vendPaymentMethod":"EXT34",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"billToAuthServiceCountry":"US",
"cca":{
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":"SVCAUTH4444",
"authDate":1180614,
"alphaOrderNbr":"00001132",
"merchantName":" ",
"authMerchantNbr":" ",
"oasisPayType":4,
"oasisPayCode":" ",
"oasisPayTypeCode":" ",
"companyDivision":" ",
"expireMonth":0,
"expireYear":0,
"AVSResp":" ",
"chargeDesc":"SVC",
"authAmt":11.67,
"reauthCode":" ",
"mailPhoneOther":" ",
"oasisHoldRsn":" ",
"vendHoldRsn":" ",
"termPayCode":" ",
"custNbr":197,
"custLastName":"TYLER",
"custFirstName":"JOHN",
"addrLine1":"1234 EXAMPLE STREET",
"addrLine2":"SECOND ADDRESS LINE",
"billtoCity":"WORCESTER",
"billtoState":"MA",
"billtoZip":"01602",
"billtoExtraZip":"1234",
"billtoCountry":"US",
"phoneNbr":0,
"phoneType":" ",
"transDate":1180614,
"transTime":132556,
"ccPassCode":" ",
"ordNbr":1132,
"opmSeqNbr":1,
"auhSeqNbr":1,
"authService":"EXT",
"currCode":" ",
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1132,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"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":" ",
"creditCardNbr":[
],
"ccLast4":" ",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"OrderPaymentMethodDAL.updateHoldReason",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"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":"user",
"APIPassword":"password",
"APISignature":"api signature",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXT",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHPR",
"merchDiv":956785,
"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
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1132,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":"V",
"authAmt":11.67,
"depositAmt":0,
"authDate":1180614,
"sentDate":1180614,
"authNbr":"SVCAUTH4444",
"vendorResp":"100",
"vendorResp2":" ",
"AVSResp":" ",
"transactionId":"SVCAUTH4444",
"authTime":121039,
"lastModifiedPgm":"ExternalServiceBO.processAuthorizationResponse",
"selected":false
}
}
SVC Reversal Response
{
"status":"REJECT",
"reasonCode":"88"
}
Sample Credit Card (CC) Messages
CC Authorization Request and Response without Token
CC Authorization Request
{
"typeDescription":"AuthorizationRequest",
"requestType":"CreditCard",
"cardNumber":"2222222222222222",
"emailAddress":"zachary.taylor@example.com",
"merchantId":"EXCAUTHMERCH1",
"compCurrency":"USD",
"vendCurrency":"US$ ",
"vendPaymentMethod":"EXCVA",
"ecommerceIndicator":"true",
"useTokenization":"N",
"billToAuthServiceCountry":"USA",
"cca":{
"creditCardNbr":[
],
"vendorResp":"",
"vendorResp2":"",
"authNbr":"",
"authDate":0,
"alphaOrderNbr":"009000001088001",
"expireMonth":12,
"expireYear":20,
"AVSResp":"",
"chargeDesc":"",
"authAmt":12.55,
"custNbr":197,
"custLastName":"FILLMORE",
"custFirstName":"MILLARD",
"addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
"addrLine2":"999 EXAMPLE STREET ADDRESS LINE TWO",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":"",
"billtoCountry":"US",
"phoneNbr":0,
"ordNbr":1088,
"opmSeqNbr":1,
"auhSeqNbr":1,
"authService":"EXC",
"currCode":"",
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1088,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":0,
"amtBilled":0,
"amtCollected":0,
"amtCredited":0,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":3,
"expirationDate":1220,
"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":75,
"holdRsn":"CW",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"2222",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"OrderPaymentMethodDAL.updateHoldReason",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"application":"ATDP",
"batchOnline":"C",
"mediaType":"C",
"activeProductionSys":"Y",
"addrVerification":"Y",
"declineDays":10,
"selectForDeposit":"Y",
"immediateDeposit":"Y",
"immediateResp":"Y",
"industryFormat":"INDFC",
"installmentBilling":"Y",
"keepHist":"Y",
"chgDesc":"EXT CC CHARGE DESCRIPTION",
"merchantId":"external credit card",
"password":"password1!",
"receivingCode":"RECEIVE1",
"signon":"signon1",
"startUpInfo":"STARTUPINFO1!",
"subCode":"SUBCODE",
"fileSeqNbr":0,
"presenterId":"PREID1!",
"PIDPassword":"PASSWORD",
"submitterId":"SUBIDAUTH",
"SIDPassword":"PASSWORD",
"presenterIdDep":"PREDEPID1",
"PIDPasswordDep":"PASSWORD",
"submitterIdDep":"SUBIDDEP",
"SIDPasswordDep":"SIDPASSDEP",
"APIUsername":"apiusername",
"APIPassword":"password",
"APISignature":"api signature exc",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHSERV",
"merchDiv":12345,
"providerNetworkAddr":" ",
"portNbr":0,
"respTime":1000,
"deferredMerchId":"DEFMERCHID1",
"installmentMerchId":"INSTMERCHID2",
"excludeFromFlexPay":"Y",
"onLineILPProc":"CCAUTH_ONL",
"batchILPProc":"CCAUTH_BTH",
"depositILPProc":"DEPOSITS",
"svcActivationProc":"SVC_OUT",
"svcBalInqProc":"SVC_BALANC",
"primaryAuthSrv":".IL",
"requestToken":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1088,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":"S",
"authAmt":12.55,
"depositAmt":0,
"authDate":0,
"sentDate":1180611,
"authNbr":" ",
"vendorResp":" ",
"vendorResp2":" ",
"AVSResp":" ",
"transactionId":" ",
"authTime":0,
"lastModifiedPgm":" ",
"selected":false
}
}
CC Authorization Response
{
"transactionId":"AQA222277100",
"approvedAmount":201.67,
"status":"ACCEPT",
"reasonCode":"100",
"authorizationCode":"ACQA222",
"cvnResponseCode":"123",
"avsCode":"X",
"errorResponse":"",
"token":""
}
CC Authorization Request and Response with Token
CC Authorization Request (Token)
{
"typeDescription":"AuthorizationRequest",
"requestType":"CreditCard",
"cardNumber":"1234567812345678",
"emailAddress":"franklin.pierce@example.com",
"merchantId":"75EXCAUTH",
"compCurrency":"USD",
"vendCurrency":"US$ ",
"vendPaymentMethod":"75EXC",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"billToAuthServiceCountry":"USA",
"cca":{
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":" ",
"authDate":0,
"alphaOrderNbr":" ",
"merchantName":" ",
"authMerchantNbr":" ",
"oasisPayType":5,
"oasisPayCode":" ",
"oasisPayTypeCode":" ",
"companyDivision":" ",
"expireMonth":12,
"expireYear":20,
"AVSResp":" ",
"chargeDesc":" ",
"authAmt":12.55,
"reauthCode":" ",
"mailPhoneOther":" ",
"oasisHoldRsn":" ",
"vendHoldRsn":" ",
"termPayCode":" ",
"custNbr":197,
"custLastName":"BUCHANAN",
"custFirstName":"JAMES",
"addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
"addrLine2":"APART 999",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":" ",
"billtoCountry":"US",
"phoneNbr":0,
"phoneType":" ",
"transDate":1180615,
"transTime":162442,
"ccPassCode":" ",
"ordNbr":1172,
"opmSeqNbr":1,
"auhSeqNbr":1,
"authService":"EXC",
"currCode":" ",
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1172,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":12.55,
"amtBilled":0,
"amtCollected":0,
"amtCredited":0,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":3,
"expirationDate":1220,
"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":75,
"holdRsn":"CW",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"5678",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"AAR0006",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"application":"ATDP",
"batchOnline":"C",
"mediaType":"C",
"activeProductionSys":"Y",
"addrVerification":"Y",
"declineDays":10,
"selectForDeposit":"Y",
"immediateDeposit":"Y",
"immediateResp":"Y",
"industryFormat":"INDFC",
"installmentBilling":"Y",
"keepHist":"Y",
"chgDesc":"EXT CC CHARGE DESCRIPTION",
"merchantId":"external credit card",
"password":"password1!",
"receivingCode":"RECEIVE1",
"signon":"signon1",
"startUpInfo":"STARTUPINFO1!",
"subCode":"SUBCODE",
"fileSeqNbr":0,
"presenterId":"PREID1!",
"PIDPassword":"password",
"submitterId":"SUBIDAUTH",
"SIDPassword":"PASSWORD",
"presenterIdDep":"PREDEPID1",
"PIDPasswordDep":"PASSWORD",
"submitterIdDep":"SUBIDDEP",
"SIDPasswordDep":"SIDPASSDEP",
"APIUsername":"apiusername",
"APIPassword":"password",
"APISignature":"api signature exc",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":0,
"depositPhoneNbr":0,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHSERV",
"merchDiv":12345,
"providerNetworkAddr":" ",
"portNbr":0,
"respTime":1000,
"deferredMerchId":"DEFMERCHID1",
"installmentMerchId":"INSTMERCHID2",
"excludeFromFlexPay":"Y",
"onLineILPProc":"CCAUTH_ONL",
"batchILPProc":"CCAUTH_BTH",
"depositILPProc":"DEPOSITS",
"svcActivationProc":"SVC_OUT",
"svcBalInqProc":"SVC_BALANC",
"primaryAuthSrv":".IL",
"requestToken":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"LRAId":" ",
"selected":false
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1172,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":" ",
"authAmt":12.55,
"depositAmt":0,
"authDate":0,
"sentDate":1180615,
"authNbr":" ",
"vendorResp":" ",
"vendorResp2":" ",
"AVSResp":" ",
"transactionId":" ",
"authTime":0,
"lastModifiedPgm":" ",
"selected":false
}
}
CC Authorization Response (Token)
{
"transactionId":"SVCTRAN61518A",
"approvedAmount":34.05,
"status":"ACCEPT",
"reasonCode":"100",
"authorizationCode":"SVCAUT61518B",
"cvnResponseCode":"30",
"avsCode":"X",
"errorResponse":"",
"token":"9999000088881111"
}
CC Deposit Request and Response
CC Deposit Request
{
"typeDescription":"DepositRequest",
"requestType":"CreditCard",
"cardNumber":"4222222222222222",
"emailAddress":"Abraham.lincoln@example.com",
"merchantId":"EXCAUTHMERCH1",
"compCurrency":"USD",
"vendCurrency":" ",
"vendPaymentMethod":"EXCVA",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"requestAuth":"Y",
"billToAuthServiceCountry":"",
"ccd":{
"id":{
"cmp":9,
"ordNbr":1007,
"invNbr":422,
"ordPayMethodSeqNbr":1,
"LRAId":" ",
"selected":false
},
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":" ",
"vendorResp2":" ",
"authNbr":"ACQA222",
"authDate":1180606,
"alphaOrderNbr":"1007",
"merchantName":" ",
"oasisPayType":0,
"oasisPayCode":" ",
"companyDivision":" ",
"expireMonth":12,
"expireYear":20,
"AVSResp":" ",
"custLastName":"JOHNSON",
"custFirstName":"ANDREW",
"addrLine1":"1234 EXAMPLE STREET",
"addrLine2":"SECOND ADDRESS LINE",
"billtoCity":"WORCESTER",
"billtoState":"MA",
"billtoZip":"01602",
"billtoExtraZip":"1234",
"billtoCountry":"US",
"transDate":1180606,
"transTime":200655,
"longInvoiceNbr":0,
"merchDollars":0,
"freightDollars":0,
"addlFreightDollars":0,
"totalTaxDollars":0,
"GSTTaxDollars":0,
"PSTTaxDollars":0,
"addlTaxDollars":0,
"handlingDollars":0,
"totalDollars":109.3,
"depositMerchantNbr":"merch100",
"flexPaymentType":" ",
"authService":"EXC",
"payType":75,
"currCode":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1007,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":109.3,
"amtBilled":109.3,
"amtCollected":109.3,
"amtCredited":0,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":3,
"expirationDate":1220,
"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":75,
"holdRsn":" ",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"2222",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"FLR0270",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"application":"ATDP",
"batchOnline":"C",
"mediaType":"C",
"activeProductionSys":"N",
"addrVerification":"Y",
"declineDays":10,
"selectForDeposit":"Y",
"immediateDeposit":"Y",
"immediateResp":"Y",
"industryFormat":" ",
"installmentBilling":"Y",
"keepHist":"Y",
"chgDesc":"EXT CC CHARGE DESCRIPTION",
"merchantId":"external credit card",
"password":"password",
"receivingCode":" ",
"signon":" ",
"startUpInfo":" ",
"subCode":" ",
"fileSeqNbr":0,
"presenterId":" ",
"PIDPassword":"password",
"submitterId":" ",
"SIDPassword":"password",
"presenterIdDep":" ",
"PIDPasswordDep":"password",
"submitterIdDep":" ",
"SIDPasswordDep":"password",
"APIUsername":"username",
"APIPassword":"password",
"APISignature":" ",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":0,
"depositPhoneNbr":0,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"N",
"authSrvProvider":" ",
"merchDiv":0,
"providerNetworkAddr":" ",
"portNbr":0,
"respTime":1000,
"deferredMerchId":" ",
"installmentMerchId":" ",
"excludeFromFlexPay":"N",
"onLineILPProc":" ",
"batchILPProc":" ",
"depositILPProc":" ",
"svcActivationProc":" ",
"svcBalInqProc":" ",
"primaryAuthSrv":".IL",
"requestToken":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"LRAId":" ",
"selected":false
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1007,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":"A",
"authAmt":109.3,
"depositAmt":109.3,
"authDate":1180606,
"sentDate":1180606,
"authNbr":"ACQA222",
"vendorResp":"100",
"vendorResp2":" ",
"AVSResp":" ",
"transactionId":"AQA222277100",
"authTime":181051,
"lastModifiedPgm":"ExternalServiceBO.processAuthorizationResponse",
"selected":false
}
}
CC Deposit Response
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":"",
"requestAuth":"N",
"token":""
}
CC Deposit Request and Response with Authorization
CC Deposit Request (Authorization)
{
"typeDescription":"DepositRequest",
"requestType":"CreditCard",
"cardNumber":"1111111122222222",
"emailAddress":"rutherford.b.hayes@example.com",
"merchantId":"75EXCAUTH",
"compCurrency":"USD",
"vendCurrency":"US$ ",
"vendPaymentMethod":"75EXC",
"ecommerceIndicator":"false",
"useTokenization":"Y",
"requestAuth":"Y",
"billToAuthServiceCountry":"",
"ccd":{
"id":{
"cmp":9,
"ordNbr":1173,
"invNbr":549,
"ordPayMethodSeqNbr":1,
"selected":false
},
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":"SVCAUT61518B",
"authDate":1180615,
"alphaOrderNbr":" ",
"merchantName":" ",
"oasisPayType":0,
"oasisPayCode":" ",
"companyDivision":" ",
"expireMonth":9,
"expireYear":19,
"AVSResp":"X",
"custLastName":"GRANT",
"custFirstName":"ULYSSES",
"addrLine1":"30 EXAMPLE LANE",
"addrLine2":"123",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":"1234",
"billtoCountry":"US",
"transDate":1180615,
"transTime":170221,
"longInvoiceNbr":549,
"merchDollars":40,
"freightDollars":0,
"addlFreightDollars":1.67,
"totalTaxDollars":0,
"GSTTaxDollars":0,
"PSTTaxDollars":0,
"addlTaxDollars":0,
"handlingDollars":0,
"totalDollars":41.67,
"depositMerchantNbr":" ",
"flexPaymentType":" ",
"authService":"EXC",
"payType":75,
"currCode":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1173,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":41.67,
"amtBilled":41.67,
"amtCollected":41.67,
"amtCredited":0,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":3,
"expirationDate":919,
"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":75,
"holdRsn":"CW",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"1234",
"tokenized":"Y",
"verifiedToken":" ",
"bin":"123412",
"lastModifiedPgm":"FLR0270",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"application":"ATDP",
"batchOnline":"C",
"mediaType":"C",
"activeProductionSys":"Y",
"addrVerification":"Y",
"declineDays":10,
"selectForDeposit":"Y",
"immediateDeposit":"Y",
"immediateResp":"Y",
"industryFormat":"INDFC",
"installmentBilling":"Y",
"keepHist":"Y",
"chgDesc":"EXT CC CHARGE DESCRIPTION",
"merchantId":"external credit card",
"password":"password1!",
"receivingCode":"RECEIVE1",
"signon":"signon1",
"startUpInfo":"STARTUPINFO1!",
"subCode":"SUBCODE",
"fileSeqNbr":0,
"presenterId":"PREID1!",
"PIDPassword":"password",
"submitterId":"SUBIDAUTH",
"SIDPassword":"PASSWORD",
"presenterIdDep":"PREDEPID1",
"PIDPasswordDep":"password",
"submitterIdDep":"SUBIDDEP",
"SIDPasswordDep":"PASSWORD",
"APIUsername":"apiusername",
"APIPassword":"password",
"APISignature":"api signature exc",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":0,
"depositPhoneNbr":0,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHSERV",
"merchDiv":12345,
"providerNetworkAddr":" ",
"portNbr":0,
"respTime":1000,
"deferredMerchId":"DEFMERCHID1",
"installmentMerchId":"INSTMERCHID2",
"excludeFromFlexPay":"Y",
"onLineILPProc":"CCAUTH_ONL",
"batchILPProc":"CCAUTH_BTH",
"depositILPProc":"DEPOSITS",
"svcActivationProc":"SVC_OUT",
"svcBalInqProc":"SVC_BALANC",
"primaryAuthSrv":".IL",
"requestToken":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1173,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":"A",
"authAmt":21.67,
"depositAmt":21.67,
"authDate":1180615,
"sentDate":1180615,
"authNbr":"SVCAUT61518B",
"vendorResp":"100",
"vendorResp2":"30",
"AVSResp":"X",
"transactionId":"SVCTRAN61518A",
"authTime":165357,
"lastModifiedPgm":"AuthBO.changePreAuthPicksToPostAuth(2)",
"selected":false
}
}
CC Deposit Response (Authorization)
{
"transactionId":"DEPTRAN61518",
"status":"ACCEPT",
"reasonCode":"100",
"authorizationCode":"DEPAUTH61518",
"errorResponse":"",
"requestAuth":"Y",
"token":""
}
CC Return (Credit) Request and Response
CC Return (Credit) Request
{
"typeDescription":"ReturnRequest",
"requestType":"CreditCard",
"cardNumber":"4222222222222222",
"emailAddress":"james.garfield@example.com",
"merchantId":"EXCAUTHMERCH1",
"compCurrency":"USD",
"vendCurrency":" ",
"vendPaymentMethod":"EXCVA",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"billToAuthServiceCountry":"",
"ccd":{
"id":{
"cmp":9,
"ordNbr":1007,
"invNbr":426,
"ordPayMethodSeqNbr":1,
"selected":false
},
"transType":"*RETURN",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":" ",
"authDate":0,
"alphaOrderNbr":" ",
"merchantName":" ",
"oasisPayType":0,
"oasisPayCode":" ",
"companyDivision":" ",
"expireMonth":12,
"expireYear":20,
"AVSResp":" ",
"custLastName":"ARTHUR",
"custFirstName":"CHESTER",
"addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
"addrLine2":"APART 999",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":" ",
"billtoCountry":"US",
"transDate":1180606,
"transTime":211920,
"longInvoiceNbr":426,
"merchDollars":100,
"freightDollars":0,
"addlFreightDollars":0,
"totalTaxDollars":7.5,
"GSTTaxDollars":0,
"PSTTaxDollars":0,
"addlTaxDollars":0,
"handlingDollars":0,
"totalDollars":107.5,
"depositMerchantNbr":" ",
"flexPaymentType":" ",
"authService":"EXC",
"payType":75,
"currCode":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1007,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":109.3,
"amtBilled":109.3,
"amtCollected":109.3,
"amtCredited":107.5,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":3,
"expirationDate":1220,
"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":75,
"holdRsn":" ",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"2222",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"FLR0270",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"application":"ATDP",
"batchOnline":"C",
"mediaType":"C",
"activeProductionSys":"N",
"addrVerification":"Y",
"declineDays":10,
"selectForDeposit":"Y",
"immediateDeposit":"Y",
"immediateResp":"Y",
"industryFormat":" ",
"installmentBilling":"Y",
"keepHist":"Y",
"chgDesc":"EXT CC CHARGE DESCRIPTION",
"merchantId":"external credit card",
"password":" ",
"receivingCode":" ",
"signon":" ",
"startUpInfo":" ",
"subCode":" ",
"fileSeqNbr":0,
"presenterId":" ",
"PIDPassword":" ",
"submitterId":" ",
"SIDPassword":" ",
"presenterIdDep":" ",
"PIDPasswordDep":" ",
"submitterIdDep":" ",
"SIDPasswordDep":" ",
"APIUsername":"USERNAME",
"APIPassword":" ",
"APISignature":" ",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":0,
"depositPhoneNbr":0,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"N",
"authSrvProvider":" ",
"merchDiv":0,
"providerNetworkAddr":" ",
"portNbr":0,
"respTime":1000,
"deferredMerchId":" ",
"installmentMerchId":" ",
"excludeFromFlexPay":"N",
"onLineILPProc":" ",
"batchILPProc":" ",
"depositILPProc":" ",
"svcActivationProc":" ",
"svcBalInqProc":" ",
"primaryAuthSrv":".IL",
"requestToken":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
}
}
CC Return (Credit) Response
{
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":""
}
CC Reversal Request and Response
CC Reversal Request
{
"typeDescription":"ReversalRequest",
"requestType":"CreditCard",
"cardNumber":"4222222222222222",
"emailAddress":"grover.cleveland@example.com",
"merchantId":"75EXCAUTH",
"compCurrency":"USD",
"vendCurrency":"US$ ",
"vendPaymentMethod":"75EXC",
"ecommerceIndicator":"true",
"useTokenization":"N",
"billToAuthServiceCountry":"USA",
"cca":{
"transType":"*PURCH",
"creditCardNbr":[
],
"transStatus":"*RDY",
"vendorResp":"",
"vendorResp2":" ",
"authNbr":"ACQA222",
"authDate":1180612,
"alphaOrderNbr":"00001111",
"merchantName":" ",
"authMerchantNbr":" ",
"oasisPayType":5,
"oasisPayCode":" ",
"oasisPayTypeCode":" ",
"companyDivision":" ",
"expireMonth":0,
"expireYear":0,
"AVSResp":" ",
"chargeDesc":"SVC",
"authAmt":12.55,
"reauthCode":" ",
"mailPhoneOther":" ",
"oasisHoldRsn":" ",
"vendHoldRsn":" ",
"termPayCode":" ",
"custNbr":197,
"custLastName":"HARRISON",
"custFirstName":"BENJAMIN",
"addrLine1":"99 EXAMPLE STREET ADDRESS LINE ONE",
"addrLine2":"APART 999",
"billtoCity":"MANSFIELD",
"billtoState":"MA",
"billtoZip":"02048",
"billtoExtraZip":" ",
"billtoCountry":"US",
"phoneNbr":0,
"phoneType":" ",
"transDate":1180612,
"transTime":154103,
"ccPassCode":" ",
"ordNbr":1111,
"opmSeqNbr":1,
"auhSeqNbr":1,
"authService":"EXC",
"currCode":" ",
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"id":{
"cmp":9,
"ordNbr":1111,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"amtToChg":0,
"amtAuth":34.05,
"amtBilled":34.05,
"amtCollected":34.05,
"amtCredited":0,
"authDate":0,
"authNbr":" ",
"manualAuthAmt":0,
"cashApplDate":0,
"cashCtrlNbr":0,
"chgSeq":3,
"expirationDate":1220,
"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":75,
"holdRsn":" ",
"fpoPmtCode":" ",
"creditCardNbr":[
],
"ccLast4":"2222",
"tokenized":" ",
"verifiedToken":" ",
"bin":" ",
"lastModifiedPgm":"FLR0270",
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"application":"ATDP",
"batchOnline":"C",
"mediaType":"C",
"activeProductionSys":"Y",
"addrVerification":"Y",
"declineDays":10,
"selectForDeposit":"Y",
"immediateDeposit":"Y",
"immediateResp":"Y",
"industryFormat":"INDFC",
"installmentBilling":"Y",
"keepHist":"Y",
"chgDesc":"EXT CC CHARGE DESCRIPTION",
"merchantId":"external credit card",
"password":"password1!",
"receivingCode":"RECEIVE1",
"signon":"signon1",
"startUpInfo":"STARTUPINFO1!",
"subCode":"SUBCODE",
"fileSeqNbr":0,
"presenterId":"PREID1!",
"PIDPassword":"password",
"submitterId":"SUBIDAUTH",
"SIDPassword":"password",
"presenterIdDep":"PREDEPID1",
"PIDPasswordDep":"password",
"submitterIdDep":"SUBIDDEP",
"SIDPasswordDep":"password",
"APIUsername":"apiusername",
"APIPassword":"password",
"APISignature":"api signature exc",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":5085550100,
"depositPhoneNbr":5085550101,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"Y",
"authSrvProvider":"AUTHSERV",
"merchDiv":12345,
"providerNetworkAddr":" ",
"portNbr":0,
"respTime":1000,
"deferredMerchId":"DEFMERCHID1",
"installmentMerchId":"INSTMERCHID2",
"excludeFromFlexPay":"Y",
"onLineILPProc":"CCAUTH_ONL",
"batchILPProc":"CCAUTH_BTH",
"depositILPProc":"DEPOSITS",
"svcActivationProc":"SVC_OUT",
"svcBalInqProc":"SVC_BALANC",
"primaryAuthSrv":".IL",
"requestToken":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"selected":false
},
"authorizationHistory":{
"id":{
"cmp":9,
"ordNbr":1111,
"ordPayMethodSeqNbr":1,
"seqNbr":1,
"LRAId":" ",
"selected":false
},
"authSts":"V",
"authAmt":12.55,
"depositAmt":0,
"authDate":1180612,
"sentDate":1180612,
"authNbr":"ACQA222",
"vendorResp":"100",
"vendorResp2":"123",
"AVSResp":"X",
"transactionId":"AQA222277100",
"authTime":152828,
"lastModifiedPgm":"ExternalServiceBO.createAuthReversal",
"selected":false
}
}
CC Reversal Response
{
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":""
}
CC Token Request and Response
CC Token Request
{
"typeDescription":"TokenRequest",
"requestType":"CreditCard",
"cardNumber":"4222222222222222",
"emailAddress":"grover.cleveland@example.com",
"merchantId":"EXCAUTHMERCH1",
"compCurrency":"USD",
"vendCurrency":" ",
"vendPaymentMethod":"EXCVA",
"ecommerceIndicator":"true",
"useTokenization":"Y",
"billToAuthServiceCountry":"USA",
"cca":{
"creditCardNbr":[
],
"vendorResp":"",
"vendorResp2":"",
"authNbr":"",
"authDate":0,
"alphaOrderNbr":"910081",
"expireMonth":1220,
"AVSResp":"",
"chargeDesc":"",
"authAmt":0,
"custNbr":197,
"custLastName":"MCKINLEY",
"custFirstName":"WILLIAM",
"addrLine1":"1234 EXAMPLE STREET",
"addrLine2":"ADDRESS LINE 2",
"billtoCity":"WORCESTER",
"billtoState":"MA",
"billtoZip":"01602",
"billtoExtraZip":"1234",
"billtoCountry":"US",
"phoneNbr":0,
"ordNbr":1008,
"opmSeqNbr":1,
"auhSeqNbr":0,
"authService":"EXC",
"currCode":"",
"lastModifiedPgm":" ",
"selected":false
},
"orderPaymentMethod":{
"expirationDate":1220,
"payType":75,
"creditCardNbr":[
],
"selected":false
},
"authorizationService":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"application":"ATDP",
"batchOnline":"C",
"mediaType":"C",
"activeProductionSys":"N",
"addrVerification":"Y",
"declineDays":10,
"selectForDeposit":"Y",
"immediateDeposit":"Y",
"immediateResp":"Y",
"industryFormat":" ",
"installmentBilling":"Y",
"keepHist":"Y",
"chgDesc":"EXT CC CHARGE DESCRIPTION",
"merchantId":"external credit card",
"password":"password",
"receivingCode":" ",
"signon":" ",
"startUpInfo":" ",
"subCode":" ",
"fileSeqNbr":0,
"presenterId":" ",
"PIDPassword":"password",
"submitterId":" ",
"SIDPassword":"password",
"presenterIdDep":" ",
"PIDPasswordDep":"password",
"submitterIdDep":" ",
"SIDPasswordDep":"password",
"APIUsername":"password",
"APIPassword":"password",
"APISignature":" ",
"selected":false
},
"authorizationServiceExt":{
"id":{
"cmp":9,
"authService":"EXC",
"LRAId":" ",
"selected":false
},
"authPhoneNbr":0,
"depositPhoneNbr":0,
"communicationType":"P",
"respCheckFreq":5,
"testMode":"N",
"authSrvProvider":" ",
"merchDiv":0,
"providerNetworkAddr":" ",
"portNbr":0,
"respTime":1000,
"deferredMerchId":" ",
"installmentMerchId":" ",
"excludeFromFlexPay":"N",
"onLineILPProc":" ",
"batchILPProc":" ",
"depositILPProc":" ",
"svcActivationProc":" ",
"svcBalInqProc":" ",
"primaryAuthSrv":".IL",
"requestToken":"Y",
"voidAuth":"Y",
"allowReversal":"Y",
"LRAId":" ",
"selected":false
}
}
CC Token Response
{
"status":"ACCEPT",
"reasonCode":"100",
"errorResponse":"",
"token":"4343434343434343"
}
The information included in external payment service request messages is described below.
Tag |
Description |
ExternalPaymentServiceMessageRequest ExternalPaymentServiceMessageRequest{ "typeDescription": "AuthorizationRequest", "requestType": "CreditCard", "cardNumber": "", "emailAddress": "eleanor.roosevelt@example.com", "merchantId": "MERCHANT", "compCurrency": "USD", "vendCurrency": "400 ", "vendPaymentMethod": "", "ecommerceIndicator": "false", "useTokenization": "Y", "billToAuthServiceCountry": "", |
|
typeDescription |
Indicates the type of request. Credit card: Supported credit card request types are: • AuthorizationRequest: See CC Authorization Request and Response without Token and CC Authorization Request and Response with Token • DepositRequest: See CC Deposit Request and Response and CC Deposit Request and Response with Authorization • ReturnRequest: See CC Return (Credit) Request and Response • ReversalRequest: See CC Reversal Request and Response • TokenRequest: See CC Token Request and Response Stored value card: Supported stored value card request types are: • ActivateRequest: See SVC Activation Request and Response • AuthorizationRequest: See SVC Authorization Request and Response • BalanceRequest: See SVC Balance Request and Response • DepositRequest: See SVC Deposit Request and Response and SVC Deposit Request and Response (Authorization Greater than Deposit) • GenerateRequest: See SVC Generate Request and Response • RechargeRequest: See SVC Recharge Request and Response • ReturnRequest: See SVC Return Request and Response • ReversalRequest: See SVC Reversal Request and Response |
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; otherwise, not used. |
billToAuthServiceCountry |
The authorization service country, as set up through Defining Authorization Service Countries. |
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":{ |
|
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":{ |
|
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. |
LRAid |
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. |
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 |
Included in the cca container. Not currently implemented. |
mailPhoneOther |
Included in the cca container. Not currently implemented. |
oasisHoldRsn |
Included in the cca container. Not currently implemented. |
vendHoldRsn |
Included in the cca container. Not currently implemented. |
termPayCode |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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. |
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. |
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 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. |
LRAId |
|
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 |
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 |
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. |
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. |
The information included in external payment service response messages is described below. Tags that are required for individual request types are indicated.
Tag |
Description |
{ |
|
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 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. |
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. 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. 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. Required for a successful stored value card recharge request. |
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. 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. |
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. |
| External Payment Service | Contents | SCVs | Search | Glossary | Reports | Solutions | XML | Index | Purging Tables |
SO04_17 OMS 17.1 September 2018 OTN