PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

WICPinnedBalanceRequest

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

// @DataContract
export class InOutTimes
{

    public constructor(init?: Partial<InOutTimes>) { (Object as any).assign(this, init); }
}

// @DataContract
export class RequestTimestamps
{
    // @DataMember(EmitDefaultValue=false)
    public AppLayer: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public ParentLookup: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public RetryLookup: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public GetCardData: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public CardTokenize: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public CardEncrypt: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public DBInsert: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public BackendProcess: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public DBUpdate: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public ParentUpdate: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public Network: InOutTimes;

    public constructor(init?: Partial<RequestTimestamps>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PaysecureResponseInternal
{
    // @DataMember(EmitDefaultValue=false)
    public Timestamps: RequestTimestamps;

    public constructor(init?: Partial<PaysecureResponseInternal>) { (Object as any).assign(this, init); }
}

export enum CardInfoType
{
    CardNumber = 'CardNumber',
    Token = 'Token',
    Track = 'Track',
    EMV = 'EMV',
    Encrypted = 'Encrypted',
    DPAN = 'DPAN',
    ApplePay = 'ApplePay',
    GooglePay = 'GooglePay',
    SamsungPay = 'SamsungPay',
    CPToken = 'CPToken',
    EncryptedEnhanced = 'EncryptedEnhanced',
    EncryptedJWE = 'EncryptedJWE',
}

export class CardAccountUpdaterDescriptor
{
    public CardDataType: CardInfoType;
    public CardNumberInfo: string;
    public ExpiryDate: string;
    public Status: string;
    public ErrorCode: string;
    public CardToken: string;

    public constructor(init?: Partial<CardAccountUpdaterDescriptor>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ExtendedResponse
{
    // @DataMember(EmitDefaultValue=false)
    public CardAccountUpdater: CardAccountUpdaterDescriptor;

    // @DataMember(EmitDefaultValue=false)
    public ProductId: string;

    // @DataMember(EmitDefaultValue=false)
    public NetworkResponseCode: string;

    // @DataMember(EmitDefaultValue=false)
    public NetworkTransactionId: string;

    // @DataMember(EmitDefaultValue=false)
    public CHEmailAddrResult: string;

    public constructor(init?: Partial<ExtendedResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PaysecureVersion extends PaysecureResponseInternal
{
    // @DataMember(EmitDefaultValue=false)
    public LocalDateTime: string;

    // @DataMember(EmitDefaultValue=false)
    public Token: string;

    // @DataMember(EmitDefaultValue=false)
    public ExtendedData: ExtendedResponse;

    public constructor(init?: Partial<PaysecureVersion>) { super(init); (Object as any).assign(this, init); }
}

export class WICBalance
{
    public WICCategory: string;
    public WICSubcategory: string;
    public WICQuantity: number;

    public constructor(init?: Partial<WICBalance>) { (Object as any).assign(this, init); }
}

// @DataContract
export class WICPinnedBalance extends PaysecureVersion
{
    // @DataMember
    public ApprovalCode: string;

    // @DataMember
    public TranId: string;

    // @DataMember
    public ErrorMessage: string;

    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Network: string;

    // @DataMember
    public EarliestBenefitExpirationDate: string;

    // @DataMember
    public WICBalances: WICBalance[];

    // @DataMember
    public ResponseCode: string;

    public constructor(init?: Partial<WICPinnedBalance>) { super(init); (Object as any).assign(this, init); }
}

export class RequestorCredentials
{
    // @Required()
    public MerchantId: string;

    // @Required()
    public UserName: string;

    // @Required()
    public Password: string;

    // @Required()
    public Version: string;

    public constructor(init?: Partial<RequestorCredentials>) { (Object as any).assign(this, init); }
}

export enum Initiator
{
    Customer = 1,
    Merchant = 2,
}

export class MerchantDataElements
{
    public RefundSettlementTypeDetails: number;
    public SendRecurringPOSEntryModeFeature: boolean;
    public UseOrgPOSCode: boolean;

    public constructor(init?: Partial<MerchantDataElements>) { (Object as any).assign(this, init); }
}

export class MerchantDescriptorBase
{
    public DataElements: MerchantDataElements;

    public constructor(init?: Partial<MerchantDescriptorBase>) { (Object as any).assign(this, init); }
}

export class MerchantDescriptor extends MerchantDescriptorBase
{
    public Name: string;
    public Address: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Country: string;
    public CustomerServiceNumber: string;
    public MCC: string;
    public FNSnum: string;
    public Email: string;

    public constructor(init?: Partial<MerchantDescriptor>) { super(init); (Object as any).assign(this, init); }
}

export enum FundingSourceType
{
    DepositAccount = 'DepositAccount',
    Credit = 'Credit',
    Debit = 'Debit',
    Prepaid = 'Prepaid',
}

export class SenderInfo
{
    public ReferenceNumber: string;
    public AccountNumber: string;
    /** @description Name Format FirstName{Space}LastName. For Example :- Alvaro Morata */
    public Name: string;
    public Address: string;
    public City: string;
    public State: string;
    public Country: string;
    /** @description DateOfBirth Format MMDDYYYY. For Example :- 05051960 */
    public DateOfBirth: string;
    public Zip: string;
    public PhoneNumber: string;
    public FundingSource: FundingSourceType;

    public constructor(init?: Partial<SenderInfo>) { (Object as any).assign(this, init); }
}

export enum NetworkName
{
    Default = 'Default',
    NYCE = 'NYCE',
    CU24 = 'CU24',
    XCEL = 'XCEL',
    STAR = 'STAR',
    PULS = 'PULS',
    SHZM = 'SHZM',
    VISA = 'VISA',
    MAST = 'MAST',
    DISC = 'DISC',
    AMEX = 'AMEX',
    ALIP = 'ALIP',
    UPIN = 'UPIN',
    STAC = 'STAC',
    STNE = 'STNE',
    MAES = 'MAES',
    INTL = 'INTL',
}

export class ReceiverInfo
{
    public ReferenceNumber: string;
    public AccountNumber: string;
    /** @description Name Format FirstName{Space}LastName. For Example :- Alvaro Morata */
    public Name: string;
    public Address: string;
    public City: string;
    public State: string;
    public Country: string;
    public Zip: string;
    public PhoneNumber: string;

    public constructor(init?: Partial<ReceiverInfo>) { (Object as any).assign(this, init); }
}

export enum BillPayGroup
{
    Default = 'Default',
    Single = 'Single',
    Recurring = 'Recurring',
    Installment = 'Installment',
    Deferred = 'Deferred',
}

export enum DigitalWalletInfo
{
    Default = 'Default',
    Staged = 'Staged',
    Passthrough = 'Passthrough',
}

export class WalletDescriptor
{
    public Type: string;
    public EncryptedData: string;
    public ApplicationDataHash: string;
    public EphemeralPublicKey: string;
    public PublicKeyHash: string;
    public TransactionId: string;
    public Signature: string;
    public Version: string;
    public ApplicationData: string;
    public MerchantIdentifier: string;
    public SpecialPayment: string;
    public DigitalWalletIndicator: DigitalWalletInfo;

    public constructor(init?: Partial<WalletDescriptor>) { (Object as any).assign(this, init); }
}

export class SecureDescriptor
{
    public CAVV: string;
    public SecureTransactionId: string;

    public constructor(init?: Partial<SecureDescriptor>) { (Object as any).assign(this, init); }
}

export enum TaxIndicator
{
    Default = 'Default',
    NoTaxInfoProvided = 'NoTaxInfoProvided',
    TaxInfoProvided = 'TaxInfoProvided',
    TaxExemptItem = 'TaxExemptItem',
}

export class Level2Descriptor
{
    public TaxDetails: TaxIndicator;
    public MerchantReferenceNumber: string;
    public MerchantTaxId: string;
    public OrderNumber: string;
    public TaxAmount: number;
    public DestinationPostalCode: string;
    public ProductDescription: string;

    public constructor(init?: Partial<Level2Descriptor>) { (Object as any).assign(this, init); }
}

export class PaymentFacilitatorDescriptor
{
    public PaymentFacilitatorIndicator: string;
    public PFPhoneNumber: string;
    public SubMerchID: string;
    public SellerID: string;

    public constructor(init?: Partial<PaymentFacilitatorDescriptor>) { (Object as any).assign(this, init); }
}

export enum TokenTypes
{
    Default = 'Default',
    UCAF = 'UCAF',
    DSRP = 'DSRP',
    UCAFDSRP = 'UCAFDSRP',
    VisaVerified = 'VisaVerified',
    DigitalWallet = 'DigitalWallet',
    VisaVerifiedDigitalWallet = 'VisaVerifiedDigitalWallet',
}

export class TokenDescriptor
{
    public TokenType: TokenTypes;
    public TokenCryptogramData1: string;
    public TokenCryptogramData2: string;

    public constructor(init?: Partial<TokenDescriptor>) { (Object as any).assign(this, init); }
}

export enum CardonFileInfo
{
    Default = 'Default',
    Supported = 'Supported',
    NotSupported = 'NotSupported',
}

export enum StoredCredentialIndicatorInfo
{
    Default = 'Default',
    Initial = 'Initial',
    Subsequent = 'Subsequent',
}

export enum TransactionInitiateInfo
{
    Default = 'Default',
    Merchant = 'Merchant',
    Terminal = 'Terminal',
    Customer = 'Customer',
}

export enum ScheduleIndicatorInfo
{
    Default = 'Default',
    Scheduled = 'Scheduled',
    Unscheduled = 'Unscheduled',
}

export class CardonFileIndicatorDescriptor
{
    public CardonFile: CardonFileInfo;
    public StoredCredentialIndicator: StoredCredentialIndicatorInfo;
    public TransactionInitiate: TransactionInitiateInfo;
    public ScheduleIndicator: ScheduleIndicatorInfo;
    public NetworkTransactionId: string;

    public constructor(init?: Partial<CardonFileIndicatorDescriptor>) { (Object as any).assign(this, init); }
}

export enum CardAccountUpdaterInfo
{
    Default = 'Default',
    Supported = 'Supported',
    NotSupported = 'NotSupported',
}

export enum OrderTypeInfo
{
    Default = 'Default',
    Standing = 'Standing',
    Subscription = 'Subscription',
}

export class BillPayGroupIndicator
{
    public MITTotalPaymentCount: string;
    public MITAmountType: string;
    public MITAmount: string;
    public MITUniqueID: string;
    public MITFrequency: string;
    public MITValidationFlag: string;
    public MITValidationReference: string;
    public MITSequenceIndicator: string;

    public constructor(init?: Partial<BillPayGroupIndicator>) { (Object as any).assign(this, init); }
}

export enum ChargeTypeInfo
{
    Default = 'Default',
    PartialShipment = 'PartialShipment',
    Delayed = 'Delayed',
    NoShow = 'NoShow',
    Resubmission = 'Resubmission',
}

export enum SAFEligibleFlag
{
    Default = 'Default',
    True = 'True',
    False = 'False',
}

// @DataContract
export class ExtendedData
{
    // @DataMember
    public Track2DataForEMVTransaction: string;

    // @DataMember
    public SenderInfo: SenderInfo;

    // @DataMember
    public CashbackAmount: number;

    // @DataMember
    public Network: NetworkName;

    // @DataMember
    public ReceiverInfo: ReceiverInfo;

    // @DataMember
    public BillPayGroup: BillPayGroup;

    // @DataMember
    public WalletData: WalletDescriptor;

    // @DataMember
    public SecureData: SecureDescriptor;

    // @DataMember
    public Level2Data: Level2Descriptor;

    // @DataMember
    public PaymentFacilitatorData: PaymentFacilitatorDescriptor;

    // @DataMember
    public TokenData: TokenDescriptor;

    // @DataMember
    public OTPTranId: string;

    // @DataMember
    public CurrentShipment: number;

    // @DataMember
    public TotalShipments: number;

    // @DataMember
    public IsTokenRequested: boolean;

    // @DataMember
    public CardonFileIndicator: CardonFileIndicatorDescriptor;

    // @DataMember
    public CardAccountUpdater: CardAccountUpdaterInfo;

    // @DataMember
    public RetryAttemptCount: number;

    // @DataMember
    public TotalAuthAmount: number;

    // @DataMember
    public SignatureHashVersion: string;

    // @DataMember
    public OrderTypeDetail: OrderTypeInfo;

    // @DataMember
    public BillPayGroupIndicator: BillPayGroupIndicator;

    // @DataMember
    public ChargeTypeDetail: ChargeTypeInfo;

    // @DataMember
    public SAFEligible: SAFEligibleFlag;

    public constructor(init?: Partial<ExtendedData>) { (Object as any).assign(this, init); }
}

// @DataContract
export class WICPinnedBalanceRequest
{
    // @DataMember
    public Credentials: RequestorCredentials;

    // @DataMember
    public TranId: string;

    // @DataMember
    public ReferenceKey: string;

    // @DataMember
    public Initiator: Initiator;

    // @DataMember
    public CurrencyCode: string;

    // @DataMember
    public MerchantDetails: MerchantDescriptor;

    // @DataMember
    public Custom1: string;

    // @DataMember
    public Custom2: string;

    // @DataMember
    public Custom3: string;

    // @DataMember
    public Custom4: string;

    // @DataMember
    public Custom5: string;

    // @DataMember
    public SignatureHash: string;

    // @DataMember
    public ExtendedData: ExtendedData;

    public constructor(init?: Partial<WICPinnedBalanceRequest>) { (Object as any).assign(this, init); }
}

TypeScript WICPinnedBalanceRequest DTOs

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

HTTP + XML

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

POST /WICPinnedBalance HTTP/1.1 
Host: api.paysecure.acculynk.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WICPinnedBalanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <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>
  <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>
  <Initiator>Customer</Initiator>
  <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>
</WICPinnedBalanceRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WICPinnedBalance 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>
  <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>
</WICPinnedBalance>