PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

IPDAuthorizeRequest

// @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 IPDAuthorize extends PaysecureVersion
{
    // @DataMember
    public ApprovalCode: string;

    // @DataMember
    public TranId: string;

    // @DataMember
    public ErrorMessage: string;

    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Network: string;

    // @DataMember
    public CVN: string;

    // @DataMember
    public AVS: string;

    // @DataMember
    public RemainingBalance: number;

    // @DataMember
    public ApprovedAmount: number;

    // @DataMember
    public BalanceCurrencyCode: string;

    // @DataMember
    public ResponseCode: string;

    // @DataMember
    public RetrievalReferenceNumber: string;

    public constructor(init?: Partial<IPDAuthorize>) { 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 TelephoneType
{
    D = 'D',
    H = 'H',
    N = 'N',
    W = 'W',
}

export class Avs
{
    public Address: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Country: string;
    public Email: string;
    public IPAddress: string;
    public TelephoneNumber: string;
    public TelephoneType: TelephoneType;
    public DeliveryMethod: number;
    public FirstName: string;
    public MiddleName: string;
    public LastName: string;

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

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 IPDAuthorizeRequest
{
    // @DataMember
    public Credentials: RequestorCredentials;

    // @DataMember
    public Amount: number;

    // @DataMember
    public CurrencyCode: string;

    // @DataMember
    public TranId: string;

    // @DataMember
    public ReferenceKey: string;

    // @DataMember
    public CVN: string;

    // @DataMember
    public AVS: Avs;

    // @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<IPDAuthorizeRequest>) { (Object as any).assign(this, init); }
}

TypeScript IPDAuthorizeRequest DTOs

POST /IPDAuthorize HTTP/1.1 
Host: api.paysecure.acculynk.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Credentials":{"MerchantId":"String","UserName":"String","Password":"String","Version":"String"},"Amount":0,"CurrencyCode":"String","TranId":"String","ReferenceKey":"String","CVN":"String","AVS":{"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}},"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/jsonl
Content-Length: length

{"ApprovalCode":"String","TranId":"String","ErrorMessage":"String","ErrorCode":"String","Network":"String","CVN":"String","AVS":"String","RemainingBalance":0,"ApprovedAmount":0,"BalanceCurrencyCode":"String","ResponseCode":"String","RetrievalReferenceNumber":"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)\/"}}}