PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

AchRefundRequest

import Foundation
import ServiceStack

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

    // @DataMember
    public var tranId:String

    // @DataMember
    public var amount:Int

    // @DataMember
    public var referenceKey:String

    // @DataMember
    public var merchantDetails:MerchantDescriptor

    // @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 avs:Avs

    // @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 MerchantDescriptor : MerchantDescriptorBase
{
    public var name:String
    public var address:String
    public var city:String
    public var state:String
    public var zip:String
    public var country:String
    public var customerServiceNumber:String
    public var mcc:String
    public var fnSnum:String
    public var email:String

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

    private enum CodingKeys : String, CodingKey {
        case name
        case address
        case city
        case state
        case zip
        case country
        case customerServiceNumber
        case mcc
        case fnSnum
        case email
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        address = try container.decodeIfPresent(String.self, forKey: .address)
        city = try container.decodeIfPresent(String.self, forKey: .city)
        state = try container.decodeIfPresent(String.self, forKey: .state)
        zip = try container.decodeIfPresent(String.self, forKey: .zip)
        country = try container.decodeIfPresent(String.self, forKey: .country)
        customerServiceNumber = try container.decodeIfPresent(String.self, forKey: .customerServiceNumber)
        mcc = try container.decodeIfPresent(String.self, forKey: .mcc)
        fnSnum = try container.decodeIfPresent(String.self, forKey: .fnSnum)
        email = try container.decodeIfPresent(String.self, forKey: .email)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if name != nil { try container.encode(name, forKey: .name) }
        if address != nil { try container.encode(address, forKey: .address) }
        if city != nil { try container.encode(city, forKey: .city) }
        if state != nil { try container.encode(state, forKey: .state) }
        if zip != nil { try container.encode(zip, forKey: .zip) }
        if country != nil { try container.encode(country, forKey: .country) }
        if customerServiceNumber != nil { try container.encode(customerServiceNumber, forKey: .customerServiceNumber) }
        if mcc != nil { try container.encode(mcc, forKey: .mcc) }
        if fnSnum != nil { try container.encode(fnSnum, forKey: .fnSnum) }
        if email != nil { try container.encode(email, forKey: .email) }
    }
}

public class MerchantDescriptorBase : Codable
{
    public var dataElements:MerchantDataElements

    required public init(){}
}

public class MerchantDataElements : Codable
{
    public var refundSettlementTypeDetails:Int
    public var sendRecurringPOSEntryModeFeature:Bool
    public var useOrgPOSCode:Bool

    required public init(){}
}

public class Avs : Codable
{
    public var address:String
    public var city:String
    public var state:String
    public var zip:String
    public var country:String
    public var email:String
    public var ipAddress:String
    public var telephoneNumber:String
    public var telephoneType:TelephoneType
    public var deliveryMethod:Int
    public var firstName:String
    public var middleName:String
    public var lastName:String

    required public init(){}
}

public enum TelephoneType : String, Codable
{
    case D
    case H
    case N
    case W
}

// @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 Refund : PaysecureVersion
{
    // @DataMember
    public var tranId:String

    // @DataMember
    public var approvalCode:String

    // @DataMember
    public var responseCode:String

    // @DataMember
    public var network:String

    // @DataMember
    public var errorMessage:String

    // @DataMember
    public var errorCode:String

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

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

    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)
        approvalCode = try container.decodeIfPresent(String.self, forKey: .approvalCode)
        responseCode = try container.decodeIfPresent(String.self, forKey: .responseCode)
        network = try container.decodeIfPresent(String.self, forKey: .network)
        errorMessage = try container.decodeIfPresent(String.self, forKey: .errorMessage)
        errorCode = try container.decodeIfPresent(String.self, forKey: .errorCode)
    }

    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 approvalCode != nil { try container.encode(approvalCode, forKey: .approvalCode) }
        if responseCode != nil { try container.encode(responseCode, forKey: .responseCode) }
        if network != nil { try container.encode(network, forKey: .network) }
        if errorMessage != nil { try container.encode(errorMessage, forKey: .errorMessage) }
        if errorCode != nil { try container.encode(errorCode, forKey: .errorCode) }
    }
}

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

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

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

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

    private enum CodingKeys : String, CodingKey {
        case localDateTime
        case token
        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)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        extendedData = try container.decodeIfPresent(ExtendedResponse.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 token != nil { try container.encode(token, forKey: .token) }
        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 ExtendedResponse : Codable
{
    // @DataMember(EmitDefaultValue=false)
    public var cardAccountUpdater:CardAccountUpdaterDescriptor

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

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

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

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

    required public init(){}
}

public class CardAccountUpdaterDescriptor : Codable
{
    public var cardDataType:CardInfoType
    public var cardNumberInfo:String
    public var expiryDate:String
    public var status:String
    public var errorCode:String
    public var cardToken:String

    required public init(){}
}

public enum CardInfoType : String, Codable
{
    case CardNumber
    case Token
    case Track
    case EMV
    case Encrypted
    case DPAN
    case ApplePay
    case GooglePay
    case SamsungPay
    case CPToken
    case EncryptedEnhanced
    case EncryptedJWE
}

Swift AchRefundRequest DTOs

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

<AchRefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <AVS>
    <Address>String</Address>
    <City>String</City>
    <Country>String</Country>
    <DeliveryMethod>0</DeliveryMethod>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <IPAddress>String</IPAddress>
    <LastName>String</LastName>
    <MiddleName>String</MiddleName>
    <State>String</State>
    <TelephoneNumber>String</TelephoneNumber>
    <TelephoneType>D</TelephoneType>
    <Zip>String</Zip>
  </AVS>
  <Amount>0</Amount>
  <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>
  <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>
</AchRefundRequest>

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

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