PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

AchPreAuthVoidRequest

The following routes are available for this service:
POST/ACHPreAuthVoid
import Foundation
import ServiceStack

// @DataContract
public class AchPreAuthVoidRequest : Codable
{
    // @DataMember
    public var credentials:RequestorCredentials

    // @DataMember
    public var originalData:OriginalTransaction

    // @DataMember
    public var referenceKey:String

    // @DataMember
    public var custom1:String

    // @DataMember
    public var custom2:String

    // @DataMember
    public var custom3:String

    // @DataMember
    public var custom4:String

    // @DataMember
    public var custom5:String

    // @DataMember
    public var signatureHash:String

    // @DataMember
    public var extendedData:ACHExtendedData

    required public init(){}
}

public class RequestorCredentials : Codable
{
    // @Required()
    public var merchantId:String?

    // @Required()
    public var userName:String?

    // @Required()
    public var password:String?

    // @Required()
    public var version:String?

    required public init(){}
}

public class OriginalTransaction : Codable
{
    public var originalIdentifierType:OriginalDataType
    public var originalDataIdentifier:String

    required public init(){}
}

public enum OriginalDataType : Int, Codable
{
    case TransactionId = 1
    case ReferenceKey = 2
    case ExternalId = 3
    case InternalTransactionId = 4
}

// @DataContract
public class ACHExtendedData : Codable
{
    // @DataMember
    public var cashbackAmount:Int

    // @DataMember
    public var connectPaySubScriberId:String

    // @DataMember
    public var organizationId:String

    // @DataMember
    public var deviceFingerPrint:String

    // @DataMember
    public var merchantSessionId:String

    // @DataMember
    public var currencyCode:String

    // @DataMember
    public var paymentType:String

    // @DataMember
    public var verifyCustomer:Bool

    // @DataMember
    public var customerExternalId:String

    // @DataMember
    public var Description:String

    // @DataMember
    public var customerName:String

    // @DataMember
    public var addressLine1:String

    // @DataMember
    public var addressLine2:String

    // @DataMember
    public var city:String

    // @DataMember
    public var state:String

    // @DataMember
    public var zip:String

    // @DataMember
    public var country:String

    // @DataMember
    public var email:String

    // @DataMember
    public var telephoneNumber:String

    // @DataMember
    public var returnUrl:String

    // @DataMember
    public var cancelUrl:String

    // @DataMember
    public var establishData:String

    // @DataMember
    public var redirectUrl:String

    // @DataMember
    public var retryAttemptCount:Int

    // @DataMember
    public var signatureHashVersion:String

    // @DataMember
    public var deadlineHashDate:Date?

    required public init(){}
}

// @DataContract
public class AchPreAuthVoid : AchPaysecureVersion
{
    // @DataMember
    public var tranId:String

    // @DataMember
    public var responseCode:String

    // @DataMember
    public var errorMessage:String

    // @DataMember
    public var errorCode:String

    // @DataMember(EmitDefaultValue=false)
    public var achProviderDetails:AchProviderResponse

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case tranId
        case responseCode
        case errorMessage
        case errorCode
        case achProviderDetails
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        tranId = try container.decodeIfPresent(String.self, forKey: .tranId)
        responseCode = try container.decodeIfPresent(String.self, forKey: .responseCode)
        errorMessage = try container.decodeIfPresent(String.self, forKey: .errorMessage)
        errorCode = try container.decodeIfPresent(String.self, forKey: .errorCode)
        achProviderDetails = try container.decodeIfPresent(AchProviderResponse.self, forKey: .achProviderDetails)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if tranId != nil { try container.encode(tranId, forKey: .tranId) }
        if responseCode != nil { try container.encode(responseCode, forKey: .responseCode) }
        if errorMessage != nil { try container.encode(errorMessage, forKey: .errorMessage) }
        if errorCode != nil { try container.encode(errorCode, forKey: .errorCode) }
        if achProviderDetails != nil { try container.encode(achProviderDetails, forKey: .achProviderDetails) }
    }
}

// @DataContract
public class AchPaysecureVersion : PaysecureResponseInternal
{
    // @DataMember(EmitDefaultValue=false)
    public var localDateTime:String

    // @DataMember(EmitDefaultValue=false)
    public var extendedData:ACHExtendedDataResponse

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case localDateTime
        case extendedData
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        localDateTime = try container.decodeIfPresent(String.self, forKey: .localDateTime)
        extendedData = try container.decodeIfPresent(ACHExtendedDataResponse.self, forKey: .extendedData)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if localDateTime != nil { try container.encode(localDateTime, forKey: .localDateTime) }
        if extendedData != nil { try container.encode(extendedData, forKey: .extendedData) }
    }
}

// @DataContract
public class PaysecureResponseInternal : Codable
{
    // @DataMember(EmitDefaultValue=false)
    public var timestamps:RequestTimestamps

    required public init(){}
}

// @DataContract
public class RequestTimestamps : Codable
{
    // @DataMember(EmitDefaultValue=false)
    public var appLayer:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var parentLookup:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var retryLookup:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var getCardData:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var cardTokenize:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var cardEncrypt:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var dbInsert:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var backendProcess:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var dbUpdate:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var parentUpdate:InOutTimes

    // @DataMember(EmitDefaultValue=false)
    public var network:InOutTimes

    required public init(){}
}

// @DataContract
public class InOutTimes : Codable
{
    required public init(){}
}

// @DataContract
public class ACHExtendedDataResponse : Codable
{
    // @DataMember(EmitDefaultValue=false)
    public var networkResponseCode:String

    // @DataMember(EmitDefaultValue=false)
    public var networkErrorCode:String

    // @DataMember(EmitDefaultValue=false)
    public var declineReferenceCode:String

    // @DataMember(EmitDefaultValue=false)
    public var networkTransactionId:String

    required public init(){}
}

// @DataContract
public class AchProviderResponse : Codable
{
    // @DataMember
    public var networkResponseCode:String

    // @DataMember
    public var transactionStatusCode:Int

    required public init(){}
}

Swift AchPreAuthVoidRequest 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 /ACHPreAuthVoid HTTP/1.1 
Host: api.paysecure.acculynk.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchPreAuthVoidRequest 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>
  <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>
  <OriginalData>
    <OriginalDataIdentifier>String</OriginalDataIdentifier>
    <OriginalIdentifierType>TransactionId</OriginalIdentifierType>
  </OriginalData>
  <ReferenceKey>String</ReferenceKey>
  <SignatureHash>String</SignatureHash>
</AchPreAuthVoidRequest>

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

<AchPreAuthVoid 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>
  <ErrorCode>String</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <ResponseCode>String</ResponseCode>
  <TranId>String</TranId>
</AchPreAuthVoid>