PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

AchPreAuthorizeRequest

The following routes are available for this service:
POST/ACHPreAuthorize
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Paysecure.ServiceModel
Imports Paysecure.ServiceModel.Types

Namespace Global

    Namespace Paysecure.ServiceModel

        <DataContract>
        Public Partial Class AchPreAuthorize
            Inherits AchPaysecureVersion
            <DataMember>
            Public Overridable Property TranId As String

            <DataMember>
            Public Overridable Property ApprovalCode As String

            <DataMember>
            Public Overridable Property ResponseCode As String

            <DataMember>
            Public Overridable Property Network As String

            <DataMember>
            Public Overridable Property ApprovedAmount As Integer

            <DataMember>
            Public Overridable Property ErrorMessage As String

            <DataMember>
            Public Overridable Property ErrorCode As String

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property AchProviderDetails As AchProviderResponse
        End Class

        <DataContract>
        Public Partial Class AchPreAuthorizeRequest
            <DataMember>
            Public Overridable Property Credentials As RequestorCredentials

            <DataMember>
            Public Overridable Property ACHToken As ACHTokenDescriptor

            <DataMember>
            Public Overridable Property Amount As Integer

            <DataMember>
            Public Overridable Property ReferenceKey As String

            <DataMember>
            Public Overridable Property CurrencyCode As String

            <DataMember>
            Public Overridable Property Custom1 As String

            <DataMember>
            Public Overridable Property Custom2 As String

            <DataMember>
            Public Overridable Property Custom3 As String

            <DataMember>
            Public Overridable Property Custom4 As String

            <DataMember>
            Public Overridable Property Custom5 As String

            <DataMember>
            Public Overridable Property SignatureHash As String

            <DataMember>
            Public Overridable Property ExtendedData As ACHExtendedData

            <DataMember>
            Public Overridable Property RecurringPayment As RecurringPaymentType
        End Class
    End Namespace

    Namespace Paysecure.ServiceModel.Types

        <DataContract>
        Public Partial Class ACHExtendedData
            <DataMember>
            Public Overridable Property CashbackAmount As Integer

            <DataMember>
            Public Overridable Property ConnectPaySubScriberId As String

            <DataMember>
            Public Overridable Property OrganizationId As String

            <DataMember>
            Public Overridable Property DeviceFingerPrint As String

            <DataMember>
            Public Overridable Property MerchantSessionId As String

            <DataMember>
            Public Overridable Property CurrencyCode As String

            <DataMember>
            Public Overridable Property PaymentType As String

            <DataMember>
            Public Overridable Property VerifyCustomer As Boolean

            <DataMember>
            Public Overridable Property CustomerExternalId As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property CustomerName As String

            <DataMember>
            Public Overridable Property AddressLine1 As String

            <DataMember>
            Public Overridable Property AddressLine2 As String

            <DataMember>
            Public Overridable Property City As String

            <DataMember>
            Public Overridable Property State As String

            <DataMember>
            Public Overridable Property Zip As String

            <DataMember>
            Public Overridable Property Country As String

            <DataMember>
            Public Overridable Property Email As String

            <DataMember>
            Public Overridable Property TelephoneNumber As String

            <DataMember>
            Public Overridable Property ReturnUrl As String

            <DataMember>
            Public Overridable Property CancelUrl As String

            <DataMember>
            Public Overridable Property EstablishData As String

            <DataMember>
            Public Overridable Property RedirectUrl As String

            <DataMember>
            Public Overridable Property RetryAttemptCount As Integer

            <DataMember>
            Public Overridable Property SignatureHashVersion As String

            <DataMember>
            Public Overridable Property DeadlineHashDate As Nullable(Of Date)
        End Class

        <DataContract>
        Public Partial Class ACHExtendedDataResponse
            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property NetworkResponseCode As String

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property NetworkErrorCode As String

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property DeclineReferenceCode As String

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property NetworkTransactionId As String
        End Class

        <DataContract>
        Public Partial Class AchPaysecureVersion
            Inherits PaysecureResponseInternal
            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property LocalDateTime As String

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property ExtendedData As ACHExtendedDataResponse
        End Class

        <DataContract>
        Public Partial Class AchProviderResponse
            <DataMember>
            Public Overridable Property NetworkResponseCode As String

            <DataMember>
            Public Overridable Property TransactionStatusCode As Integer
        End Class

        Public Partial Class ACHTokenDescriptor
            Public Overridable Property ACHTokenType As ACHType
            Public Overridable Property ACHTokenData As String
        End Class

        Public Enum ACHType
            Token
            CPToken
        End Enum

        <DataContract>
        Public Partial Class InOutTimes
        End Class

        <DataContract>
        Public Partial Class PaysecureResponseInternal
            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property Timestamps As RequestTimestamps
        End Class

        Public Enum RecurringPaymentType
            Single
            Recurring
        End Enum

        Public Partial Class RequestorCredentials
            <Required>
            Public Overridable Property MerchantId As String

            <Required>
            Public Overridable Property UserName As String

            <Required>
            Public Overridable Property Password As String

            <Required>
            Public Overridable Property Version As String
        End Class

        <DataContract>
        Public Partial Class RequestTimestamps
            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property AppLayer As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property ParentLookup As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property RetryLookup As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property GetCardData As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property CardTokenize As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property CardEncrypt As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property DBInsert As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property BackendProcess As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property DBUpdate As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property ParentUpdate As InOutTimes

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property Network As InOutTimes
        End Class
    End Namespace
End Namespace

VB.NET AchPreAuthorizeRequest 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 /ACHPreAuthorize HTTP/1.1 
Host: api.paysecure.acculynk.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchPreAuthorizeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ACHToken>
    <ACHTokenData>String</ACHTokenData>
    <ACHTokenType>Token</ACHTokenType>
  </ACHToken>
  <Amount>0</Amount>
  <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>
    <AddressLine1>String</AddressLine1>
    <AddressLine2>String</AddressLine2>
    <CancelUrl>String</CancelUrl>
    <CashbackAmount>0</CashbackAmount>
    <City>String</City>
    <ConnectPaySubScriberId>String</ConnectPaySubScriberId>
    <Country>String</Country>
    <CurrencyCode>String</CurrencyCode>
    <CustomerExternalId>String</CustomerExternalId>
    <CustomerName>String</CustomerName>
    <DeadlineHashDate>0001-01-01T00:00:00</DeadlineHashDate>
    <Description>String</Description>
    <DeviceFingerPrint>String</DeviceFingerPrint>
    <Email>String</Email>
    <EstablishData>String</EstablishData>
    <MerchantSessionId>String</MerchantSessionId>
    <OrganizationId>String</OrganizationId>
    <PaymentType>String</PaymentType>
    <RedirectUrl>String</RedirectUrl>
    <RetryAttemptCount>0</RetryAttemptCount>
    <ReturnUrl>String</ReturnUrl>
    <SignatureHashVersion>String</SignatureHashVersion>
    <State>String</State>
    <TelephoneNumber>String</TelephoneNumber>
    <VerifyCustomer>false</VerifyCustomer>
    <Zip>String</Zip>
  </ExtendedData>
  <RecurringPayment>Single</RecurringPayment>
  <ReferenceKey>String</ReferenceKey>
  <SignatureHash>String</SignatureHash>
</AchPreAuthorizeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AchPreAuthorize 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>
    <DeclineReferenceCode>String</DeclineReferenceCode>
    <NetworkErrorCode>String</NetworkErrorCode>
    <NetworkResponseCode>String</NetworkResponseCode>
    <NetworkTransactionId>String</NetworkTransactionId>
  </ExtendedData>
  <LocalDateTime>String</LocalDateTime>
  <AchProviderDetails>
    <NetworkResponseCode>String</NetworkResponseCode>
    <TransactionStatusCode>0</TransactionStatusCode>
  </AchProviderDetails>
  <ApprovalCode>String</ApprovalCode>
  <ApprovedAmount>0</ApprovedAmount>
  <ErrorCode>String</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <Network>String</Network>
  <ResponseCode>String</ResponseCode>
  <TranId>String</TranId>
</AchPreAuthorize>