PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

CreateACHTokenRequest

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

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

    // @DataMember
    public var sessionId: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(){}
}

// @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 CreateACHToken : PaysecureResponseInternal
{
    // @DataMember
    public var achToken:String

    // @DataMember
    public var bankName:String

    // @DataMember
    public var accountNumberLast4:String

    // @DataMember
    public var achHash:String

    // @DataMember
    public var accountType:String

    // @DataMember
    public var accountName:String

    // @DataMember
    public var bankId:String

    // @DataMember
    public var accountStatus:String

    // @DataMember
    public var userInformation:UserInformation

    // @DataMember
    public var responseCode:String

    // @DataMember
    public var errorMessage:String

    // @DataMember
    public var errorCode:String

    // @DataMember
    public var extendedData:ACHExtendedDataResponse

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

    private enum CodingKeys : String, CodingKey {
        case achToken
        case bankName
        case accountNumberLast4
        case achHash
        case accountType
        case accountName
        case bankId
        case accountStatus
        case userInformation
        case responseCode
        case errorMessage
        case errorCode
        case extendedData
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        achToken = try container.decodeIfPresent(String.self, forKey: .achToken)
        bankName = try container.decodeIfPresent(String.self, forKey: .bankName)
        accountNumberLast4 = try container.decodeIfPresent(String.self, forKey: .accountNumberLast4)
        achHash = try container.decodeIfPresent(String.self, forKey: .achHash)
        accountType = try container.decodeIfPresent(String.self, forKey: .accountType)
        accountName = try container.decodeIfPresent(String.self, forKey: .accountName)
        bankId = try container.decodeIfPresent(String.self, forKey: .bankId)
        accountStatus = try container.decodeIfPresent(String.self, forKey: .accountStatus)
        userInformation = try container.decodeIfPresent(UserInformation.self, forKey: .userInformation)
        responseCode = try container.decodeIfPresent(String.self, forKey: .responseCode)
        errorMessage = try container.decodeIfPresent(String.self, forKey: .errorMessage)
        errorCode = try container.decodeIfPresent(String.self, forKey: .errorCode)
        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 achToken != nil { try container.encode(achToken, forKey: .achToken) }
        if bankName != nil { try container.encode(bankName, forKey: .bankName) }
        if accountNumberLast4 != nil { try container.encode(accountNumberLast4, forKey: .accountNumberLast4) }
        if achHash != nil { try container.encode(achHash, forKey: .achHash) }
        if accountType != nil { try container.encode(accountType, forKey: .accountType) }
        if accountName != nil { try container.encode(accountName, forKey: .accountName) }
        if bankId != nil { try container.encode(bankId, forKey: .bankId) }
        if accountStatus != nil { try container.encode(accountStatus, forKey: .accountStatus) }
        if userInformation != nil { try container.encode(userInformation, forKey: .userInformation) }
        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 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 UserInformation : Codable
{
    // @DataMember
    public var name:[String] = []

    // @DataMember
    public var phone:[String] = []

    // @DataMember
    public var email:[String] = []

    // @DataMember
    public var address:[AddressDetails] = []

    required public init(){}
}

// @DataContract
public class AddressDetails : Codable
{
    // @DataMember
    public var address1:String

    // @DataMember
    public var address2:String

    // @DataMember
    public var city:String

    // @DataMember
    public var state:String

    // @DataMember
    public var zip:String

    // @DataMember
    public var country:String

    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(){}
}


Swift CreateACHTokenRequest DTOs

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

HTTP + JSV

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

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

{
	Credentials: 
	{
		MerchantId: String,
		UserName: String,
		Password: String,
		Version: String
	},
	SessionId: String,
	ExtendedData: 
	{
		CashbackAmount: 0,
		ConnectPaySubScriberId: String,
		OrganizationId: String,
		DeviceFingerPrint: String,
		MerchantSessionId: String,
		CurrencyCode: String,
		PaymentType: String,
		VerifyCustomer: False,
		CustomerExternalId: String,
		Description: String,
		CustomerName: String,
		AddressLine1: String,
		AddressLine2: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		Email: String,
		TelephoneNumber: String,
		ReturnUrl: String,
		CancelUrl: String,
		EstablishData: String,
		RedirectUrl: String,
		RetryAttemptCount: 0,
		SignatureHashVersion: String,
		DeadlineHashDate: 0001-01-01
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ACHToken: String,
	BankName: String,
	AccountNumberLast4: String,
	ACHHash: String,
	AccountType: String,
	AccountName: String,
	BankId: String,
	AccountStatus: String,
	UserInformation: 
	{
		Name: 
		[
			String
		],
		Phone: 
		[
			String
		],
		Email: 
		[
			String
		],
		Address: 
		[
			{
				Address1: String,
				Address2: String,
				City: String,
				State: String,
				Zip: String,
				Country: String
			}
		]
	},
	ResponseCode: String,
	ErrorMessage: String,
	ErrorCode: String,
	ExtendedData: 
	{
		NetworkResponseCode: String,
		NetworkErrorCode: String,
		DeclineReferenceCode: String,
		NetworkTransactionId: String
	},
	Timestamps: 
	{
		AppLayer: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		ParentLookup: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		RetryLookup: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		GetCardData: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		CardTokenize: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		CardEncrypt: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		DBInsert: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		BackendProcess: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		DBUpdate: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		ParentUpdate: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		Network: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		}
	}
}