PaySecure Pinless Web Services 2023:07:03:07

WICReturnRequest

The following routes are available for this service:
POST	/WICReturn

**WICReturnRequest** Parameters:
Name	Parameter	Data Type	Required
Credentials	body	RequestorCredentials	No
TranId	body	string	No
Amount	body	int	No
DiscountAmount	body	int	No
ReferenceKey	body	string	No
CurrencyCode	body	string	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

**RequestorCredentials** Parameters:
Name	Parameter	Data Type	Required
MerchantId	form	string	Yes
UserName	form	string	Yes
Password	form	string	Yes
Version	form	string	Yes

**MerchantDescriptor** Parameters:
Name	Parameter	Data Type	Required
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
Email	form	string	No

**MerchantDescriptorBase** Parameters:
Name	Parameter	Data Type	Required	Description
DataElements	form	MerchantDataElements	No

**MerchantDataElements** Parameters:
Name	Parameter	Data Type	Required
RefundSettlementTypeDetails	form	int	No
SendRecurringPOSEntryModeFeature	form	bool	No
UseOrgPOSCode	form	bool	No

**WICProduct** Parameters:
Name	Parameter	Data Type	Required
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

**WICProductCodeInd** Enum:
Name	Value
PLU	1
UPC	2

**WICActionCode** Enum:
Approved
CategoryNotPrescribed
SubcategoryNotPrescribed
InsufficientUnits
ProduceCodeNotSubscribed
ApprovedLowerPrice

**ExtendedData** Parameters:
Name	Parameter	Data Type	Required
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

**SenderInfo** Parameters:
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

**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:
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

**BillPayGroup** Enum:
Default
Single
Recurring
Installment
Deferred

**WalletDescriptor** Parameters:
Name	Parameter	Data Type	Required
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

**DigitalWalletInfo** Enum:
Default
Staged
Passthrough

**SecureDescriptor** Parameters:
Name	Parameter	Data Type	Required	Description
CAVV	form	string	No
SecureTransactionId	form	string	No

**Level2Descriptor** Parameters:
Name	Parameter	Data Type	Required
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

**TaxIndicator** Enum:
Default
NoTaxInfoProvided
TaxInfoProvided
TaxExemptItem

**PaymentFacilitatorDescriptor** Parameters:
Name	Parameter	Data Type	Required
PaymentFacilitatorIndicator	form	string	No
PFPhoneNumber	form	string	No
SubMerchID	form	string	No
SellerID	form	string	No

**TokenDescriptor** Parameters:
Name	Parameter	Data Type	Required
TokenType	form	TokenTypes	No
TokenCryptogramData1	form	string	No
TokenCryptogramData2	form	string	No

**TokenTypes** Enum:
Default
UCAF
DSRP
UCAFDSRP
VisaVerified
DigitalWallet
VisaVerifiedDigitalWallet

**CardonFileIndicatorDescriptor** Parameters:
Name	Parameter	Data Type	Required
CardonFile	form	CardonFileInfo	No
StoredCredentialIndicator	form	StoredCredentialIndicatorInfo	No
TransactionInitiate	form	TransactionInitiateInfo	No
ScheduleIndicator	form	ScheduleIndicatorInfo	No
NetworkTransactionId	form	string	No

**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:
Name	Parameter	Data Type	Required
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

**ChargeTypeInfo** Enum:
Default
PartialShipment
Delayed
NoShow
Resubmission

**SAFEligibleFlag** Enum:
Default
True
False

**WICReturn** Parameters:
Name	Parameter	Data Type	Required
TranId	form	string	No
ApprovalCode	form	string	No
ResponseCode	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
ErrorMessage	form	string	No
ErrorCode	form	string	No

**PaysecureVersion** Parameters:
Name	Parameter	Data Type	Required
LocalDateTime	form	string	No
Token	form	string	No
ExtendedData	form	ExtendedResponse	No

**PaysecureResponseInternal** Parameters:
Name	Parameter	Data Type	Required	Description
Timestamps	form	RequestTimestamps	No

**RequestTimestamps** Parameters:
Name	Parameter	Data Type	Required
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

**ExtendedResponse** Parameters:
Name	Parameter	Data Type	Required
CardAccountUpdater	form	CardAccountUpdaterDescriptor	No
ProductId	form	string	No
NetworkResponseCode	form	string	No
NetworkTransactionId	form	string	No
CHEmailAddrResult	form	string	No

**CardAccountUpdaterDescriptor** Parameters:
Name	Parameter	Data Type	Required
CardDataType	form	CardInfoType	No
CardNumberInfo	form	string	No
ExpiryDate	form	string	No
Status	form	string	No
ErrorCode	form	string	No
CardToken	form	string	No

**CardInfoType** Enum:
CardNumber
Token
Track
EMV
Encrypted
DPAN
ApplePay
GooglePay
SamsungPay
CPToken
EncryptedEnhanced
EncryptedJWE

**WICBalance** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + JSV

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

POST /WICReturn 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
	},
	TranId: String,
	Amount: 0,
	DiscountAmount: 0,
	ReferenceKey: String,
	CurrencyCode: 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

{
	TranId: String,
	ApprovalCode: String,
	ResponseCode: 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
		}
	],
	ErrorMessage: String,
	ErrorCode: 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
		}
	}
}