POST | /WICSale |
---|
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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /WICSale HTTP/1.1
Host: api.paysecure.acculynk.net
Accept: text/jsv
Content-Type: text/jsv
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/jsv 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: 0001-01-01, OutTime: 0001-01-01 }, ParentLookup: { InTime: 0001-01-01, OutTime: 0001-01-01 }, RetryLookup: { InTime: 0001-01-01, OutTime: 0001-01-01 }, GetCardData: { InTime: 0001-01-01, OutTime: 0001-01-01 }, CardTokenize: { InTime: 0001-01-01, OutTime: 0001-01-01 }, CardEncrypt: { InTime: 0001-01-01, OutTime: 0001-01-01 }, DBInsert: { InTime: 0001-01-01, OutTime: 0001-01-01 }, BackendProcess: { InTime: 0001-01-01, OutTime: 0001-01-01 }, DBUpdate: { InTime: 0001-01-01, OutTime: 0001-01-01 }, ParentUpdate: { InTime: 0001-01-01, OutTime: 0001-01-01 }, Network: { InTime: 0001-01-01, OutTime: 0001-01-01 } } }