PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

WICSubstitutionRequest

The following routes are available for this service:
POST/WICSubstitution
WICSubstitutionRequest Parameters:
NameParameterData TypeRequiredDescription
CredentialsbodyRequestorCredentialsNo
AmountbodyintNo
DiscountAmountbodyintNo
TranIdbodystringNo
ReferenceKeybodystringNo
CurrencyCodebodystringNo
DeliveryAddressbodyAvsNo
MerchantDetailsbodyMerchantDescriptorNo
WICProductsbodyList<WICProduct>No
Custom1bodystringNo
Custom2bodystringNo
Custom3bodystringNo
Custom4bodystringNo
Custom5bodystringNo
SignatureHashbodystringNo
ExtendedDatabodyExtendedDataNo
RequestorCredentials Parameters:
NameParameterData TypeRequiredDescription
MerchantIdformstringYes
UserNameformstringYes
PasswordformstringYes
VersionformstringYes
Avs Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
CountryformstringNo
EmailformstringNo
IPAddressformstringNo
TelephoneNumberformstringNo
TelephoneTypeformTelephoneTypeNo
DeliveryMethodformintNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
TelephoneType Enum:
D
H
N
W
MerchantDescriptor Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
AddressformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
CountryformstringNo
CustomerServiceNumberformstringNo
MCCformstringNo
FNSnumformstringNo
EmailformstringNo
MerchantDescriptorBase Parameters:
NameParameterData TypeRequiredDescription
DataElementsformMerchantDataElementsNo
MerchantDataElements Parameters:
NameParameterData TypeRequiredDescription
RefundSettlementTypeDetailsformintNo
SendRecurringPOSEntryModeFeatureformboolNo
UseOrgPOSCodeformboolNo
WICProduct Parameters:
NameParameterData TypeRequiredDescription
ProductCodeIndformWICProductCodeIndNo
ProductCodeformstringNo
ItemPriceformintNo
ItemQuantityformintNo
ActionCodeformWICActionCodeNo
OriginalItemPriceformintNo
OriginalItemQuantityformintNo
WICProductCodeInd Enum:
NameValue
PLU1
UPC2
WICActionCode Enum:
Approved
CategoryNotPrescribed
SubcategoryNotPrescribed
InsufficientUnits
ProduceCodeNotSubscribed
ApprovedLowerPrice
ExtendedData Parameters:
NameParameterData TypeRequiredDescription
Track2DataForEMVTransactionformstringNo
SenderInfoformSenderInfoNo
CashbackAmountformintNo
NetworkformNetworkNameNo
ReceiverInfoformReceiverInfoNo
BillPayGroupformBillPayGroupNo
WalletDataformWalletDescriptorNo
SecureDataformSecureDescriptorNo
Level2DataformLevel2DescriptorNo
PaymentFacilitatorDataformPaymentFacilitatorDescriptorNo
TokenDataformTokenDescriptorNo
OTPTranIdformstringNo
CurrentShipmentformintNo
TotalShipmentsformintNo
IsTokenRequestedformboolNo
CardonFileIndicatorformCardonFileIndicatorDescriptorNo
CardAccountUpdaterformCardAccountUpdaterInfoNo
RetryAttemptCountformintNo
TotalAuthAmountformintNo
SignatureHashVersionformstringNo
OrderTypeDetailformOrderTypeInfoNo
BillPayGroupIndicatorformBillPayGroupIndicatorNo
ChargeTypeDetailformChargeTypeInfoNo
SAFEligibleformSAFEligibleFlagNo
SenderInfo Parameters:
NameParameterData TypeRequiredDescription
ReferenceNumberformstringNo
AccountNumberformstringNo
NameformstringNoName Format FirstName{Space}LastName. For Example :- Alvaro Morata
AddressformstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
DateOfBirthformstringNoDateOfBirth Format MMDDYYYY. For Example :- 05051960
ZipformstringNo
PhoneNumberformstringNo
FundingSourceformFundingSourceTypeNo
FundingSourceType Enum:
DepositAccount
Credit
Debit
Prepaid
NetworkName Enum:
Default
NYCE
CU24
XCEL
STAR
PULS
SHZM
VISA
MAST
DISC
AMEX
ALIP
UPIN
STAC
STNE
MAES
INTL
ReceiverInfo Parameters:
NameParameterData TypeRequiredDescription
ReferenceNumberformstringNo
AccountNumberformstringNo
NameformstringNoName Format FirstName{Space}LastName. For Example :- Alvaro Morata
AddressformstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
ZipformstringNo
PhoneNumberformstringNo
BillPayGroup Enum:
Default
Single
Recurring
Installment
Deferred
WalletDescriptor Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
EncryptedDataformstringNo
ApplicationDataHashformstringNo
EphemeralPublicKeyformstringNo
PublicKeyHashformstringNo
TransactionIdformstringNo
SignatureformstringNo
VersionformstringNo
ApplicationDataformstringNo
MerchantIdentifierformstringNo
SpecialPaymentformstringNo
DigitalWalletIndicatorformDigitalWalletInfoNo
DigitalWalletInfo Enum:
Default
Staged
Passthrough
SecureDescriptor Parameters:
NameParameterData TypeRequiredDescription
CAVVformstringNo
SecureTransactionIdformstringNo
Level2Descriptor Parameters:
NameParameterData TypeRequiredDescription
TaxDetailsformTaxIndicatorNo
MerchantReferenceNumberformstringNo
MerchantTaxIdformstringNo
OrderNumberformstringNo
TaxAmountformintNo
DestinationPostalCodeformstringNo
ProductDescriptionformstringNo
TaxIndicator Enum:
Default
NoTaxInfoProvided
TaxInfoProvided
TaxExemptItem
PaymentFacilitatorDescriptor Parameters:
NameParameterData TypeRequiredDescription
PaymentFacilitatorIndicatorformstringNo
PFPhoneNumberformstringNo
SubMerchIDformstringNo
SellerIDformstringNo
TokenDescriptor Parameters:
NameParameterData TypeRequiredDescription
TokenTypeformTokenTypesNo
TokenCryptogramData1formstringNo
TokenCryptogramData2formstringNo
TokenTypes Enum:
Default
UCAF
DSRP
UCAFDSRP
VisaVerified
DigitalWallet
VisaVerifiedDigitalWallet
CardonFileIndicatorDescriptor Parameters:
NameParameterData TypeRequiredDescription
CardonFileformCardonFileInfoNo
StoredCredentialIndicatorformStoredCredentialIndicatorInfoNo
TransactionInitiateformTransactionInitiateInfoNo
ScheduleIndicatorformScheduleIndicatorInfoNo
NetworkTransactionIdformstringNo
CardonFileInfo Enum:
Default
Supported
NotSupported
StoredCredentialIndicatorInfo Enum:
Default
Initial
Subsequent
TransactionInitiateInfo Enum:
Default
Merchant
Terminal
Customer
ScheduleIndicatorInfo Enum:
Default
Scheduled
Unscheduled
CardAccountUpdaterInfo Enum:
Default
Supported
NotSupported
OrderTypeInfo Enum:
Default
Standing
Subscription
BillPayGroupIndicator Parameters:
NameParameterData TypeRequiredDescription
MITTotalPaymentCountformstringNo
MITAmountTypeformstringNo
MITAmountformstringNo
MITUniqueIDformstringNo
MITFrequencyformstringNo
MITValidationFlagformstringNo
MITValidationReferenceformstringNo
MITSequenceIndicatorformstringNo
ChargeTypeInfo Enum:
Default
PartialShipment
Delayed
NoShow
Resubmission
SAFEligibleFlag Enum:
Default
True
False
WICSubstitution Parameters:
NameParameterData TypeRequiredDescription
ApprovalCodeformstringNo
TranIdformstringNo
ErrorMessageformstringNo
ErrorCodeformstringNo
ApprovedAmountformintNo
DiscountAmountformintNo
NetworkformstringNo
EarliestBenefitExpirationDateformstringNo
WICBalancesformList<WICBalance>No
WICProductsformList<WICProduct>No
ResponseCodeformstringNo
PaysecureVersion Parameters:
NameParameterData TypeRequiredDescription
LocalDateTimeformstringNo
TokenformstringNo
ExtendedDataformExtendedResponseNo
PaysecureResponseInternal Parameters:
NameParameterData TypeRequiredDescription
TimestampsformRequestTimestampsNo
RequestTimestamps Parameters:
NameParameterData TypeRequiredDescription
AppLayerformInOutTimesNo
ParentLookupformInOutTimesNo
RetryLookupformInOutTimesNo
GetCardDataformInOutTimesNo
CardTokenizeformInOutTimesNo
CardEncryptformInOutTimesNo
DBInsertformInOutTimesNo
BackendProcessformInOutTimesNo
DBUpdateformInOutTimesNo
ParentUpdateformInOutTimesNo
NetworkformInOutTimesNo
ExtendedResponse Parameters:
NameParameterData TypeRequiredDescription
CardAccountUpdaterformCardAccountUpdaterDescriptorNo
ProductIdformstringNo
NetworkResponseCodeformstringNo
NetworkTransactionIdformstringNo
CHEmailAddrResultformstringNo
CardAccountUpdaterDescriptor Parameters:
NameParameterData TypeRequiredDescription
CardDataTypeformCardInfoTypeNo
CardNumberInfoformstringNo
ExpiryDateformstringNo
StatusformstringNo
ErrorCodeformstringNo
CardTokenformstringNo
CardInfoType Enum:
CardNumber
Token
Track
EMV
Encrypted
DPAN
ApplePay
GooglePay
SamsungPay
CPToken
EncryptedEnhanced
EncryptedJWE
WICBalance Parameters:
NameParameterData TypeRequiredDescription
WICCategoryformstringNo
WICSubcategoryformstringNo
WICQuantityformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /WICSubstitution HTTP/1.1 
Host: api.paysecure.acculynk.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Credentials":{"MerchantId":"String","UserName":"String","Password":"String","Version":"String"},"Amount":0,"DiscountAmount":0,"TranId":"String","ReferenceKey":"String","CurrencyCode":"String","DeliveryAddress":{"Address":"String","City":"String","State":"String","Zip":"String","Country":"String","Email":"String","IPAddress":"String","TelephoneNumber":"String","TelephoneType":"D","DeliveryMethod":0,"FirstName":"String","MiddleName":"String","LastName":"String"},"MerchantDetails":{"Name":"String","Address":"String","City":"String","State":"String","Zip":"String","Country":"String","CustomerServiceNumber":"String","MCC":"String","FNSnum":"String","Email":"String","DataElements":{"RefundSettlementTypeDetails":0,"SendRecurringPOSEntryModeFeature":false,"UseOrgPOSCode":false}},"WICProducts":[{"ProductCodeInd":"PLU","ProductCode":"String","ItemPrice":0,"ItemQuantity":0,"ActionCode":"Approved","OriginalItemPrice":0,"OriginalItemQuantity":0}],"Custom1":"String","Custom2":"String","Custom3":"String","Custom4":"String","Custom5":"String","SignatureHash":"String","ExtendedData":{"Track2DataForEMVTransaction":"String","SenderInfo":{"ReferenceNumber":"String","AccountNumber":"String","Name":"String","Address":"String","City":"String","State":"String","Country":"String","DateOfBirth":"String","Zip":"String","PhoneNumber":"String","FundingSource":"DepositAccount"},"CashbackAmount":0,"Network":"Default","ReceiverInfo":{"ReferenceNumber":"String","AccountNumber":"String","Name":"String","Address":"String","City":"String","State":"String","Country":"String","Zip":"String","PhoneNumber":"String"},"BillPayGroup":"Default","WalletData":{"Type":"String","EncryptedData":"String","ApplicationDataHash":"String","EphemeralPublicKey":"String","PublicKeyHash":"String","TransactionId":"String","Signature":"String","Version":"String","ApplicationData":"String","MerchantIdentifier":"String","SpecialPayment":"String","DigitalWalletIndicator":"Default"},"SecureData":{"CAVV":"String","SecureTransactionId":"String"},"Level2Data":{"TaxDetails":"Default","MerchantReferenceNumber":"String","MerchantTaxId":"String","OrderNumber":"String","TaxAmount":0,"DestinationPostalCode":"String","ProductDescription":"String"},"PaymentFacilitatorData":{"PaymentFacilitatorIndicator":"String","PFPhoneNumber":"String","SubMerchID":"String","SellerID":"String"},"TokenData":{"TokenType":"Default","TokenCryptogramData1":"String","TokenCryptogramData2":"String"},"OTPTranId":"String","CurrentShipment":0,"TotalShipments":0,"IsTokenRequested":false,"CardonFileIndicator":{"CardonFile":"Default","StoredCredentialIndicator":"Default","TransactionInitiate":"Default","ScheduleIndicator":"Default","NetworkTransactionId":"String"},"CardAccountUpdater":"Default","RetryAttemptCount":0,"TotalAuthAmount":0,"SignatureHashVersion":"String","OrderTypeDetail":"Default","BillPayGroupIndicator":{"MITTotalPaymentCount":"String","MITAmountType":"String","MITAmount":"String","MITUniqueID":"String","MITFrequency":"String","MITValidationFlag":"String","MITValidationReference":"String","MITSequenceIndicator":"String"},"ChargeTypeDetail":"Default","SAFEligible":"Default"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ApprovalCode":"String","TranId":"String","ErrorMessage":"String","ErrorCode":"String","ApprovedAmount":0,"DiscountAmount":0,"Network":"String","EarliestBenefitExpirationDate":"String","WICBalances":[{"WICCategory":"String","WICSubcategory":"String","WICQuantity":0}],"WICProducts":[{"ProductCodeInd":"PLU","ProductCode":"String","ItemPrice":0,"ItemQuantity":0,"ActionCode":"Approved","OriginalItemPrice":0,"OriginalItemQuantity":0}],"ResponseCode":"String","LocalDateTime":"String","Token":"String","ExtendedData":{"CardAccountUpdater":{"CardDataType":"CardNumber","CardNumberInfo":"String","ExpiryDate":"String","Status":"String","ErrorCode":"String","CardToken":"String"},"ProductId":"String","NetworkResponseCode":"String","NetworkTransactionId":"String","CHEmailAddrResult":"String"},"Timestamps":{"AppLayer":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"ParentLookup":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"RetryLookup":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"GetCardData":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"CardTokenize":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"CardEncrypt":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"DBInsert":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"BackendProcess":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"DBUpdate":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"ParentUpdate":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"},"Network":{"InTime":"\/Date(-62135596800000-0000)\/","OutTime":"\/Date(-62135596800000-0000)\/"}}}