| POST | /WICReturn |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@DataContract
open class WICReturnRequest
{
@DataMember
var Credentials:RequestorCredentials? = null
@DataMember
var TranId:String? = null
@DataMember
var Amount:Int? = null
@DataMember
var DiscountAmount:Int? = null
@DataMember
var ReferenceKey:String? = null
@DataMember
var CurrencyCode:String? = null
@DataMember
var MerchantDetails:MerchantDescriptor? = null
@DataMember
var WICProducts:ArrayList<WICProduct> = ArrayList<WICProduct>()
@DataMember
var Custom1:String? = null
@DataMember
var Custom2:String? = null
@DataMember
var Custom3:String? = null
@DataMember
var Custom4:String? = null
@DataMember
var Custom5:String? = null
@DataMember
var SignatureHash:String? = null
@DataMember
var ExtendedData:ExtendedData? = null
}
open class RequestorCredentials
{
@Required()
var MerchantId:String? = null
@Required()
var UserName:String? = null
@Required()
var Password:String? = null
@Required()
var Version:String? = null
}
open class MerchantDescriptor : MerchantDescriptorBase()
{
var Name:String? = null
var Address:String? = null
var City:String? = null
var State:String? = null
var Zip:String? = null
var Country:String? = null
var CustomerServiceNumber:String? = null
var MCC:String? = null
var FNSnum:String? = null
var Email:String? = null
}
open class MerchantDescriptorBase
{
var DataElements:MerchantDataElements? = null
}
open class MerchantDataElements
{
var RefundSettlementTypeDetails:Int? = null
var SendRecurringPOSEntryModeFeature:Boolean? = null
var UseOrgPOSCode:Boolean? = null
}
open class WICProduct
{
var ProductCodeInd:WICProductCodeInd? = null
var ProductCode:String? = null
var ItemPrice:Int? = null
var ItemQuantity:Int? = null
var ActionCode:WICActionCode? = null
var OriginalItemPrice:Int? = null
var OriginalItemQuantity:Int? = null
}
enum class WICProductCodeInd(val value:Int)
{
Plu(1),
Upc(2),
}
enum class WICActionCode
{
Approved,
CategoryNotPrescribed,
SubcategoryNotPrescribed,
InsufficientUnits,
ProduceCodeNotSubscribed,
ApprovedLowerPrice,
}
@DataContract
open class ExtendedData
{
@DataMember
var Track2DataForEMVTransaction:String? = null
@DataMember
var SenderInfo:SenderInfo? = null
@DataMember
var CashbackAmount:Int? = null
@DataMember
var Network:NetworkName? = null
@DataMember
var ReceiverInfo:ReceiverInfo? = null
@DataMember
var BillPayGroup:BillPayGroup? = null
@DataMember
var WalletData:WalletDescriptor? = null
@DataMember
var SecureData:SecureDescriptor? = null
@DataMember
var Level2Data:Level2Descriptor? = null
@DataMember
var PaymentFacilitatorData:PaymentFacilitatorDescriptor? = null
@DataMember
var TokenData:TokenDescriptor? = null
@DataMember
var OTPTranId:String? = null
@DataMember
var CurrentShipment:Int? = null
@DataMember
var TotalShipments:Int? = null
@DataMember
var IsTokenRequested:Boolean? = null
@DataMember
var CardonFileIndicator:CardonFileIndicatorDescriptor? = null
@DataMember
var CardAccountUpdater:CardAccountUpdaterInfo? = null
@DataMember
var RetryAttemptCount:Int? = null
@DataMember
var TotalAuthAmount:Int? = null
@DataMember
var SignatureHashVersion:String? = null
@DataMember
var OrderTypeDetail:OrderTypeInfo? = null
@DataMember
var BillPayGroupIndicator:BillPayGroupIndicator? = null
@DataMember
var ChargeTypeDetail:ChargeTypeInfo? = null
@DataMember
var SAFEligible:SAFEligibleFlag? = null
}
open class SenderInfo
{
var ReferenceNumber:String? = null
var AccountNumber:String? = null
/**
* Name Format FirstName{Space}LastName. For Example :- Alvaro Morata
*/
var Name:String? = null
var Address:String? = null
var City:String? = null
var State:String? = null
var Country:String? = null
/**
* DateOfBirth Format MMDDYYYY. For Example :- 05051960
*/
var DateOfBirth:String? = null
var Zip:String? = null
var PhoneNumber:String? = null
var FundingSource:FundingSourceType? = null
}
enum class FundingSourceType
{
DepositAccount,
Credit,
Debit,
Prepaid,
}
enum class NetworkName
{
Default,
Nyce,
CU24,
Xcel,
Star,
Puls,
Shzm,
Visa,
Mast,
Disc,
Amex,
Alip,
Upin,
Stac,
Stne,
Maes,
Intl,
}
open class ReceiverInfo
{
var ReferenceNumber:String? = null
var AccountNumber:String? = null
/**
* Name Format FirstName{Space}LastName. For Example :- Alvaro Morata
*/
var Name:String? = null
var Address:String? = null
var City:String? = null
var State:String? = null
var Country:String? = null
var Zip:String? = null
var PhoneNumber:String? = null
}
enum class BillPayGroup
{
Default,
Single,
Recurring,
Installment,
Deferred,
}
open class WalletDescriptor
{
var Type:String? = null
var EncryptedData:String? = null
var ApplicationDataHash:String? = null
var EphemeralPublicKey:String? = null
var PublicKeyHash:String? = null
var TransactionId:String? = null
var Signature:String? = null
var Version:String? = null
var ApplicationData:String? = null
var MerchantIdentifier:String? = null
var SpecialPayment:String? = null
var DigitalWalletIndicator:DigitalWalletInfo? = null
}
enum class DigitalWalletInfo
{
Default,
Staged,
Passthrough,
}
open class SecureDescriptor
{
var CAVV:String? = null
var SecureTransactionId:String? = null
}
open class Level2Descriptor
{
var TaxDetails:TaxIndicator? = null
var MerchantReferenceNumber:String? = null
var MerchantTaxId:String? = null
var OrderNumber:String? = null
var TaxAmount:Int? = null
var DestinationPostalCode:String? = null
var ProductDescription:String? = null
}
enum class TaxIndicator
{
Default,
NoTaxInfoProvided,
TaxInfoProvided,
TaxExemptItem,
}
open class PaymentFacilitatorDescriptor
{
var PaymentFacilitatorIndicator:String? = null
var PFPhoneNumber:String? = null
var SubMerchID:String? = null
var SellerID:String? = null
}
open class TokenDescriptor
{
var TokenType:TokenTypes? = null
var TokenCryptogramData1:String? = null
var TokenCryptogramData2:String? = null
}
enum class TokenTypes
{
Default,
Ucaf,
Dsrp,
Ucafdsrp,
VisaVerified,
DigitalWallet,
VisaVerifiedDigitalWallet,
}
open class CardonFileIndicatorDescriptor
{
var CardonFile:CardonFileInfo? = null
var StoredCredentialIndicator:StoredCredentialIndicatorInfo? = null
var TransactionInitiate:TransactionInitiateInfo? = null
var ScheduleIndicator:ScheduleIndicatorInfo? = null
var NetworkTransactionId:String? = null
}
enum class CardonFileInfo
{
Default,
Supported,
NotSupported,
}
enum class StoredCredentialIndicatorInfo
{
Default,
Initial,
Subsequent,
}
enum class TransactionInitiateInfo
{
Default,
Merchant,
Terminal,
Customer,
}
enum class ScheduleIndicatorInfo
{
Default,
Scheduled,
Unscheduled,
}
enum class CardAccountUpdaterInfo
{
Default,
Supported,
NotSupported,
}
enum class OrderTypeInfo
{
Default,
Standing,
Subscription,
}
open class BillPayGroupIndicator
{
var MITTotalPaymentCount:String? = null
var MITAmountType:String? = null
var MITAmount:String? = null
var MITUniqueID:String? = null
var MITFrequency:String? = null
var MITValidationFlag:String? = null
var MITValidationReference:String? = null
var MITSequenceIndicator:String? = null
}
enum class ChargeTypeInfo
{
Default,
PartialShipment,
Delayed,
NoShow,
Resubmission,
}
enum class SAFEligibleFlag
{
Default,
True,
False,
}
@DataContract
open class WICReturn : PaysecureVersion()
{
@DataMember
var TranId:String? = null
@DataMember
var ApprovalCode:String? = null
@DataMember
var ResponseCode:String? = null
@DataMember
var ApprovedAmount:Int? = null
@DataMember
var DiscountAmount:Int? = null
@DataMember
var Network:String? = null
@DataMember
var EarliestBenefitExpirationDate:String? = null
@DataMember
var WICBalances:ArrayList<WICBalance> = ArrayList<WICBalance>()
@DataMember
var WICProducts:ArrayList<WICProduct> = ArrayList<WICProduct>()
@DataMember
var ErrorMessage:String? = null
@DataMember
var ErrorCode:String? = null
}
@DataContract
open class PaysecureVersion : PaysecureResponseInternal()
{
@DataMember(EmitDefaultValue=false)
var LocalDateTime:String? = null
@DataMember(EmitDefaultValue=false)
var Token:String? = null
@DataMember(EmitDefaultValue=false)
var ExtendedData:ExtendedResponse? = null
}
@DataContract
open class PaysecureResponseInternal
{
@DataMember(EmitDefaultValue=false)
var Timestamps:RequestTimestamps? = null
}
@DataContract
open class RequestTimestamps
{
@DataMember(EmitDefaultValue=false)
var AppLayer:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var ParentLookup:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var RetryLookup:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var GetCardData:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var CardTokenize:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var CardEncrypt:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var DBInsert:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var BackendProcess:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var DBUpdate:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var ParentUpdate:InOutTimes? = null
@DataMember(EmitDefaultValue=false)
var Network:InOutTimes? = null
}
@DataContract
open class InOutTimes
{
}
@DataContract
open class ExtendedResponse
{
@DataMember(EmitDefaultValue=false)
var CardAccountUpdater:CardAccountUpdaterDescriptor? = null
@DataMember(EmitDefaultValue=false)
var ProductId:String? = null
@DataMember(EmitDefaultValue=false)
var NetworkResponseCode:String? = null
@DataMember(EmitDefaultValue=false)
var NetworkTransactionId:String? = null
@DataMember(EmitDefaultValue=false)
var CHEmailAddrResult:String? = null
}
open class CardAccountUpdaterDescriptor
{
var CardDataType:CardInfoType? = null
var CardNumberInfo:String? = null
var ExpiryDate:String? = null
var Status:String? = null
var ErrorCode:String? = null
var CardToken:String? = null
}
enum class CardInfoType
{
CardNumber,
Token,
Track,
Emv,
Encrypted,
Dpan,
ApplePay,
GooglePay,
SamsungPay,
CpToken,
EncryptedEnhanced,
EncryptedJWE,
}
open class WICBalance
{
var WICCategory:String? = null
var WICSubcategory:String? = null
var WICQuantity:Int? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
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: application/json
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":"\/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)\/"}}}