POST | /WICSubstitution |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Credentials | body | RequestorCredentials | No | |
Amount | body | int | No | |
DiscountAmount | body | int | No | |
TranId | body | string | No | |
ReferenceKey | body | string | No | |
CurrencyCode | body | string | No | |
DeliveryAddress | body | Avs | No | |
MerchantDetails | body | MerchantDescriptor | No | |
WICProducts | body | List<WICProduct> | No | |
Custom1 | body | string | No | |
Custom2 | body | string | No | |
Custom3 | body | string | No | |
Custom4 | body | string | No | |
Custom5 | body | string | No | |
SignatureHash | body | string | No | |
ExtendedData | body | ExtendedData | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MerchantId | form | string | Yes | |
UserName | form | string | Yes | |
Password | form | string | Yes | |
Version | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
form | string | No | ||
IPAddress | form | string | No | |
TelephoneNumber | form | string | No | |
TelephoneType | form | TelephoneType | No | |
DeliveryMethod | form | int | No | |
FirstName | form | string | No | |
MiddleName | form | string | No | |
LastName | form | string | No |
D | |
H | |
N | |
W |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
CustomerServiceNumber | form | string | No | |
MCC | form | string | No | |
FNSnum | form | string | No | |
form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DataElements | form | MerchantDataElements | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RefundSettlementTypeDetails | form | int | No | |
SendRecurringPOSEntryModeFeature | form | bool | No | |
UseOrgPOSCode | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductCodeInd | form | WICProductCodeInd | No | |
ProductCode | form | string | No | |
ItemPrice | form | int | No | |
ItemQuantity | form | int | No | |
ActionCode | form | WICActionCode | No | |
OriginalItemPrice | form | int | No | |
OriginalItemQuantity | form | int | No |
Name | Value | |
---|---|---|
PLU | 1 | |
UPC | 2 |
Approved | |
CategoryNotPrescribed | |
SubcategoryNotPrescribed | |
InsufficientUnits | |
ProduceCodeNotSubscribed | |
ApprovedLowerPrice |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Track2DataForEMVTransaction | form | string | No | |
SenderInfo | form | SenderInfo | No | |
CashbackAmount | form | int | No | |
Network | form | NetworkName | No | |
ReceiverInfo | form | ReceiverInfo | No | |
BillPayGroup | form | BillPayGroup | No | |
WalletData | form | WalletDescriptor | No | |
SecureData | form | SecureDescriptor | No | |
Level2Data | form | Level2Descriptor | No | |
PaymentFacilitatorData | form | PaymentFacilitatorDescriptor | No | |
TokenData | form | TokenDescriptor | No | |
OTPTranId | form | string | No | |
CurrentShipment | form | int | No | |
TotalShipments | form | int | No | |
IsTokenRequested | form | bool | No | |
CardonFileIndicator | form | CardonFileIndicatorDescriptor | No | |
CardAccountUpdater | form | CardAccountUpdaterInfo | No | |
RetryAttemptCount | form | int | No | |
TotalAuthAmount | form | int | No | |
SignatureHashVersion | form | string | No | |
OrderTypeDetail | form | OrderTypeInfo | No | |
BillPayGroupIndicator | form | BillPayGroupIndicator | No | |
ChargeTypeDetail | form | ChargeTypeInfo | No | |
SAFEligible | form | SAFEligibleFlag | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReferenceNumber | form | string | No | |
AccountNumber | form | string | No | |
Name | form | string | No | Name Format FirstName{Space}LastName. For Example :- Alvaro Morata |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Country | form | string | No | |
DateOfBirth | form | string | No | DateOfBirth Format MMDDYYYY. For Example :- 05051960 |
Zip | form | string | No | |
PhoneNumber | form | string | No | |
FundingSource | form | FundingSourceType | No |
DepositAccount | |
Credit | |
Debit | |
Prepaid |
Default | |
NYCE | |
CU24 | |
XCEL | |
STAR | |
PULS | |
SHZM | |
VISA | |
MAST | |
DISC | |
AMEX | |
ALIP | |
UPIN | |
STAC | |
STNE | |
MAES | |
INTL |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReferenceNumber | form | string | No | |
AccountNumber | form | string | No | |
Name | form | string | No | Name Format FirstName{Space}LastName. For Example :- Alvaro Morata |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Country | form | string | No | |
Zip | form | string | No | |
PhoneNumber | form | string | No |
Default | |
Single | |
Recurring | |
Installment | |
Deferred |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | string | No | |
EncryptedData | form | string | No | |
ApplicationDataHash | form | string | No | |
EphemeralPublicKey | form | string | No | |
PublicKeyHash | form | string | No | |
TransactionId | form | string | No | |
Signature | form | string | No | |
Version | form | string | No | |
ApplicationData | form | string | No | |
MerchantIdentifier | form | string | No | |
SpecialPayment | form | string | No | |
DigitalWalletIndicator | form | DigitalWalletInfo | No |
Default | |
Staged | |
Passthrough |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CAVV | form | string | No | |
SecureTransactionId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TaxDetails | form | TaxIndicator | No | |
MerchantReferenceNumber | form | string | No | |
MerchantTaxId | form | string | No | |
OrderNumber | form | string | No | |
TaxAmount | form | int | No | |
DestinationPostalCode | form | string | No | |
ProductDescription | form | string | No |
Default | |
NoTaxInfoProvided | |
TaxInfoProvided | |
TaxExemptItem |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PaymentFacilitatorIndicator | form | string | No | |
PFPhoneNumber | form | string | No | |
SubMerchID | form | string | No | |
SellerID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TokenType | form | TokenTypes | No | |
TokenCryptogramData1 | form | string | No | |
TokenCryptogramData2 | form | string | No |
Default | |
UCAF | |
DSRP | |
UCAFDSRP | |
VisaVerified | |
DigitalWallet | |
VisaVerifiedDigitalWallet |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardonFile | form | CardonFileInfo | No | |
StoredCredentialIndicator | form | StoredCredentialIndicatorInfo | No | |
TransactionInitiate | form | TransactionInitiateInfo | No | |
ScheduleIndicator | form | ScheduleIndicatorInfo | No | |
NetworkTransactionId | form | string | No |
Default | |
Supported | |
NotSupported |
Default | |
Initial | |
Subsequent |
Default | |
Merchant | |
Terminal | |
Customer |
Default | |
Scheduled | |
Unscheduled |
Default | |
Supported | |
NotSupported |
Default | |
Standing | |
Subscription |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MITTotalPaymentCount | form | string | No | |
MITAmountType | form | string | No | |
MITAmount | form | string | No | |
MITUniqueID | form | string | No | |
MITFrequency | form | string | No | |
MITValidationFlag | form | string | No | |
MITValidationReference | form | string | No | |
MITSequenceIndicator | form | string | No |
Default | |
PartialShipment | |
Delayed | |
NoShow | |
Resubmission |
Default | |
True | |
False |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApprovalCode | form | string | No | |
TranId | form | string | No | |
ErrorMessage | form | string | No | |
ErrorCode | form | string | No | |
ApprovedAmount | form | int | No | |
DiscountAmount | form | int | No | |
Network | form | string | No | |
EarliestBenefitExpirationDate | form | string | No | |
WICBalances | form | List<WICBalance> | No | |
WICProducts | form | List<WICProduct> | No | |
ResponseCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LocalDateTime | form | string | No | |
Token | form | string | No | |
ExtendedData | form | ExtendedResponse | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Timestamps | form | RequestTimestamps | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AppLayer | form | InOutTimes | No | |
ParentLookup | form | InOutTimes | No | |
RetryLookup | form | InOutTimes | No | |
GetCardData | form | InOutTimes | No | |
CardTokenize | form | InOutTimes | No | |
CardEncrypt | form | InOutTimes | No | |
DBInsert | form | InOutTimes | No | |
BackendProcess | form | InOutTimes | No | |
DBUpdate | form | InOutTimes | No | |
ParentUpdate | form | InOutTimes | No | |
Network | form | InOutTimes | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardAccountUpdater | form | CardAccountUpdaterDescriptor | No | |
ProductId | form | string | No | |
NetworkResponseCode | form | string | No | |
NetworkTransactionId | form | string | No | |
CHEmailAddrResult | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardDataType | form | CardInfoType | No | |
CardNumberInfo | form | string | No | |
ExpiryDate | form | string | No | |
Status | form | string | No | |
ErrorCode | form | string | No | |
CardToken | form | string | No |
CardNumber | |
Token | |
Track | |
EMV | |
Encrypted | |
DPAN | |
ApplePay | |
GooglePay | |
SamsungPay | |
CPToken | |
EncryptedEnhanced | |
EncryptedJWE |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
WICCategory | form | string | No | |
WICSubcategory | form | string | No | |
WICQuantity | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<WICSubstitutionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Amount>0</Amount>
<Credentials>
<MerchantId>String</MerchantId>
<Password>String</Password>
<UserName>String</UserName>
<Version>String</Version>
</Credentials>
<CurrencyCode>String</CurrencyCode>
<Custom1>String</Custom1>
<Custom2>String</Custom2>
<Custom3>String</Custom3>
<Custom4>String</Custom4>
<Custom5>String</Custom5>
<DeliveryAddress>
<Address>String</Address>
<City>String</City>
<Country>String</Country>
<DeliveryMethod>0</DeliveryMethod>
<Email>String</Email>
<FirstName>String</FirstName>
<IPAddress>String</IPAddress>
<LastName>String</LastName>
<MiddleName>String</MiddleName>
<State>String</State>
<TelephoneNumber>String</TelephoneNumber>
<TelephoneType>D</TelephoneType>
<Zip>String</Zip>
</DeliveryAddress>
<DiscountAmount>0</DiscountAmount>
<ExtendedData>
<BillPayGroup>Default</BillPayGroup>
<BillPayGroupIndicator>
<MITAmount>String</MITAmount>
<MITAmountType>String</MITAmountType>
<MITFrequency>String</MITFrequency>
<MITSequenceIndicator>String</MITSequenceIndicator>
<MITTotalPaymentCount>String</MITTotalPaymentCount>
<MITUniqueID>String</MITUniqueID>
<MITValidationFlag>String</MITValidationFlag>
<MITValidationReference>String</MITValidationReference>
</BillPayGroupIndicator>
<CardAccountUpdater>Default</CardAccountUpdater>
<CardonFileIndicator>
<CardonFile>Default</CardonFile>
<NetworkTransactionId>String</NetworkTransactionId>
<ScheduleIndicator>Default</ScheduleIndicator>
<StoredCredentialIndicator>Default</StoredCredentialIndicator>
<TransactionInitiate>Default</TransactionInitiate>
</CardonFileIndicator>
<CashbackAmount>0</CashbackAmount>
<ChargeTypeDetail>Default</ChargeTypeDetail>
<CurrentShipment>0</CurrentShipment>
<IsTokenRequested>false</IsTokenRequested>
<Level2Data>
<DestinationPostalCode>String</DestinationPostalCode>
<MerchantReferenceNumber>String</MerchantReferenceNumber>
<MerchantTaxId>String</MerchantTaxId>
<OrderNumber>String</OrderNumber>
<ProductDescription>String</ProductDescription>
<TaxAmount>0</TaxAmount>
<TaxDetails>Default</TaxDetails>
</Level2Data>
<Network>Default</Network>
<OTPTranId>String</OTPTranId>
<OrderTypeDetail>Default</OrderTypeDetail>
<PaymentFacilitatorData>
<PFPhoneNumber>String</PFPhoneNumber>
<PaymentFacilitatorIndicator>String</PaymentFacilitatorIndicator>
<SellerID>String</SellerID>
<SubMerchID>String</SubMerchID>
</PaymentFacilitatorData>
<ReceiverInfo>
<AccountNumber>String</AccountNumber>
<Address>String</Address>
<City>String</City>
<Country>String</Country>
<Name>String</Name>
<PhoneNumber>String</PhoneNumber>
<ReferenceNumber>String</ReferenceNumber>
<State>String</State>
<Zip>String</Zip>
</ReceiverInfo>
<RetryAttemptCount>0</RetryAttemptCount>
<SAFEligible>Default</SAFEligible>
<SecureData>
<CAVV>String</CAVV>
<SecureTransactionId>String</SecureTransactionId>
</SecureData>
<SenderInfo>
<AccountNumber>String</AccountNumber>
<Address>String</Address>
<City>String</City>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<FundingSource>DepositAccount</FundingSource>
<Name>String</Name>
<PhoneNumber>String</PhoneNumber>
<ReferenceNumber>String</ReferenceNumber>
<State>String</State>
<Zip>String</Zip>
</SenderInfo>
<SignatureHashVersion>String</SignatureHashVersion>
<TokenData>
<TokenCryptogramData1>String</TokenCryptogramData1>
<TokenCryptogramData2>String</TokenCryptogramData2>
<TokenType>Default</TokenType>
</TokenData>
<TotalAuthAmount>0</TotalAuthAmount>
<TotalShipments>0</TotalShipments>
<Track2DataForEMVTransaction>String</Track2DataForEMVTransaction>
<WalletData>
<ApplicationData>String</ApplicationData>
<ApplicationDataHash>String</ApplicationDataHash>
<DigitalWalletIndicator>Default</DigitalWalletIndicator>
<EncryptedData>String</EncryptedData>
<EphemeralPublicKey>String</EphemeralPublicKey>
<MerchantIdentifier>String</MerchantIdentifier>
<PublicKeyHash>String</PublicKeyHash>
<Signature>String</Signature>
<SpecialPayment>String</SpecialPayment>
<TransactionId>String</TransactionId>
<Type>String</Type>
<Version>String</Version>
</WalletData>
</ExtendedData>
<MerchantDetails>
<DataElements>
<RefundSettlementTypeDetails>0</RefundSettlementTypeDetails>
<SendRecurringPOSEntryModeFeature>false</SendRecurringPOSEntryModeFeature>
<UseOrgPOSCode>false</UseOrgPOSCode>
</DataElements>
<Address>String</Address>
<City>String</City>
<Country>String</Country>
<CustomerServiceNumber>String</CustomerServiceNumber>
<Email>String</Email>
<FNSnum>String</FNSnum>
<MCC>String</MCC>
<Name>String</Name>
<State>String</State>
<Zip>String</Zip>
</MerchantDetails>
<ReferenceKey>String</ReferenceKey>
<SignatureHash>String</SignatureHash>
<TranId>String</TranId>
<WICProducts>
<WICProduct>
<ActionCode>Approved</ActionCode>
<ItemPrice>0</ItemPrice>
<ItemQuantity>0</ItemQuantity>
<OriginalItemPrice>0</OriginalItemPrice>
<OriginalItemQuantity>0</OriginalItemQuantity>
<ProductCode>String</ProductCode>
<ProductCodeInd>PLU</ProductCodeInd>
</WICProduct>
</WICProducts>
</WICSubstitutionRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <WICSubstitution xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Timestamps> <AppLayer> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </AppLayer> <BackendProcess> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </BackendProcess> <CardEncrypt> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </CardEncrypt> <CardTokenize> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </CardTokenize> <DBInsert> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </DBInsert> <DBUpdate> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </DBUpdate> <GetCardData> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </GetCardData> <Network> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </Network> <ParentLookup> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </ParentLookup> <ParentUpdate> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </ParentUpdate> <RetryLookup> <InTime>0001-01-01T00:00:00</InTime> <OutTime>0001-01-01T00:00:00</OutTime> </RetryLookup> </Timestamps> <ExtendedData> <CHEmailAddrResult>String</CHEmailAddrResult> <CardAccountUpdater> <CardDataType>CardNumber</CardDataType> <CardNumberInfo>String</CardNumberInfo> <CardToken>String</CardToken> <ErrorCode>String</ErrorCode> <ExpiryDate>String</ExpiryDate> <Status>String</Status> </CardAccountUpdater> <NetworkResponseCode>String</NetworkResponseCode> <NetworkTransactionId>String</NetworkTransactionId> <ProductId>String</ProductId> </ExtendedData> <LocalDateTime>String</LocalDateTime> <Token>String</Token> <ApprovalCode>String</ApprovalCode> <ApprovedAmount>0</ApprovedAmount> <DiscountAmount>0</DiscountAmount> <EarliestBenefitExpirationDate>String</EarliestBenefitExpirationDate> <ErrorCode>String</ErrorCode> <ErrorMessage>String</ErrorMessage> <Network>String</Network> <ResponseCode>String</ResponseCode> <TranId>String</TranId> <WICBalances> <WICBalance> <WICCategory>String</WICCategory> <WICQuantity>0</WICQuantity> <WICSubcategory>String</WICSubcategory> </WICBalance> </WICBalances> <WICProducts> <WICProduct> <ActionCode>Approved</ActionCode> <ItemPrice>0</ItemPrice> <ItemQuantity>0</ItemQuantity> <OriginalItemPrice>0</OriginalItemPrice> <OriginalItemQuantity>0</OriginalItemQuantity> <ProductCode>String</ProductCode> <ProductCodeInd>PLU</ProductCodeInd> </WICProduct> </WICProducts> </WICSubstitution>