PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

AchPreAuthorizeRequest

The following routes are available for this service:
POST/ACHPreAuthorize
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class AchPreAuthorizeRequest
    {
        @DataMember
        public RequestorCredentials Credentials = null;

        @DataMember
        public ACHTokenDescriptor ACHToken = null;

        @DataMember
        public Integer Amount = null;

        @DataMember
        public String ReferenceKey = null;

        @DataMember
        public String CurrencyCode = null;

        @DataMember
        public String Custom1 = null;

        @DataMember
        public String Custom2 = null;

        @DataMember
        public String Custom3 = null;

        @DataMember
        public String Custom4 = null;

        @DataMember
        public String Custom5 = null;

        @DataMember
        public String SignatureHash = null;

        @DataMember
        public ACHExtendedData ExtendedData = null;

        @DataMember
        public RecurringPaymentType RecurringPayment = null;
        
        public RequestorCredentials getCredentials() { return Credentials; }
        public AchPreAuthorizeRequest setCredentials(RequestorCredentials value) { this.Credentials = value; return this; }
        public ACHTokenDescriptor getAchToken() { return ACHToken; }
        public AchPreAuthorizeRequest setAchToken(ACHTokenDescriptor value) { this.ACHToken = value; return this; }
        public Integer getAmount() { return Amount; }
        public AchPreAuthorizeRequest setAmount(Integer value) { this.Amount = value; return this; }
        public String getReferenceKey() { return ReferenceKey; }
        public AchPreAuthorizeRequest setReferenceKey(String value) { this.ReferenceKey = value; return this; }
        public String getCurrencyCode() { return CurrencyCode; }
        public AchPreAuthorizeRequest setCurrencyCode(String value) { this.CurrencyCode = value; return this; }
        public String getCustom1() { return Custom1; }
        public AchPreAuthorizeRequest setCustom1(String value) { this.Custom1 = value; return this; }
        public String getCustom2() { return Custom2; }
        public AchPreAuthorizeRequest setCustom2(String value) { this.Custom2 = value; return this; }
        public String getCustom3() { return Custom3; }
        public AchPreAuthorizeRequest setCustom3(String value) { this.Custom3 = value; return this; }
        public String getCustom4() { return Custom4; }
        public AchPreAuthorizeRequest setCustom4(String value) { this.Custom4 = value; return this; }
        public String getCustom5() { return Custom5; }
        public AchPreAuthorizeRequest setCustom5(String value) { this.Custom5 = value; return this; }
        public String getSignatureHash() { return SignatureHash; }
        public AchPreAuthorizeRequest setSignatureHash(String value) { this.SignatureHash = value; return this; }
        public ACHExtendedData getExtendedData() { return ExtendedData; }
        public AchPreAuthorizeRequest setExtendedData(ACHExtendedData value) { this.ExtendedData = value; return this; }
        public RecurringPaymentType getRecurringPayment() { return RecurringPayment; }
        public AchPreAuthorizeRequest setRecurringPayment(RecurringPaymentType value) { this.RecurringPayment = value; return this; }
    }

    public static class RequestorCredentials
    {
        @Required()
        public String MerchantId = null;

        @Required()
        public String UserName = null;

        @Required()
        public String Password = null;

        @Required()
        public String Version = null;
        
        public String getMerchantId() { return MerchantId; }
        public RequestorCredentials setMerchantId(String value) { this.MerchantId = value; return this; }
        public String getUserName() { return UserName; }
        public RequestorCredentials setUserName(String value) { this.UserName = value; return this; }
        public String getPassword() { return Password; }
        public RequestorCredentials setPassword(String value) { this.Password = value; return this; }
        public String getVersion() { return Version; }
        public RequestorCredentials setVersion(String value) { this.Version = value; return this; }
    }

    public static class ACHTokenDescriptor
    {
        public ACHType ACHTokenType = null;
        public String ACHTokenData = null;
        
        public ACHType getAchTokenType() { return ACHTokenType; }
        public ACHTokenDescriptor setAchTokenType(ACHType value) { this.ACHTokenType = value; return this; }
        public String getAchTokenData() { return ACHTokenData; }
        public ACHTokenDescriptor setAchTokenData(String value) { this.ACHTokenData = value; return this; }
    }

    public static enum ACHType
    {
        Token,
        CpToken;
    }

    @DataContract
    public static class ACHExtendedData
    {
        @DataMember
        public Integer CashbackAmount = null;

        @DataMember
        public String ConnectPaySubScriberId = null;

        @DataMember
        public String OrganizationId = null;

        @DataMember
        public String DeviceFingerPrint = null;

        @DataMember
        public String MerchantSessionId = null;

        @DataMember
        public String CurrencyCode = null;

        @DataMember
        public String PaymentType = null;

        @DataMember
        public Boolean VerifyCustomer = null;

        @DataMember
        public String CustomerExternalId = null;

        @DataMember
        public String Description = null;

        @DataMember
        public String CustomerName = null;

        @DataMember
        public String AddressLine1 = null;

        @DataMember
        public String AddressLine2 = null;

        @DataMember
        public String City = null;

        @DataMember
        public String State = null;

        @DataMember
        public String Zip = null;

        @DataMember
        public String Country = null;

        @DataMember
        public String Email = null;

        @DataMember
        public String TelephoneNumber = null;

        @DataMember
        public String ReturnUrl = null;

        @DataMember
        public String CancelUrl = null;

        @DataMember
        public String EstablishData = null;

        @DataMember
        public String RedirectUrl = null;

        @DataMember
        public Integer RetryAttemptCount = null;

        @DataMember
        public String SignatureHashVersion = null;

        @DataMember
        public Date DeadlineHashDate = null;
        
        public Integer getCashbackAmount() { return CashbackAmount; }
        public ACHExtendedData setCashbackAmount(Integer value) { this.CashbackAmount = value; return this; }
        public String getConnectPaySubScriberId() { return ConnectPaySubScriberId; }
        public ACHExtendedData setConnectPaySubScriberId(String value) { this.ConnectPaySubScriberId = value; return this; }
        public String getOrganizationId() { return OrganizationId; }
        public ACHExtendedData setOrganizationId(String value) { this.OrganizationId = value; return this; }
        public String getDeviceFingerPrint() { return DeviceFingerPrint; }
        public ACHExtendedData setDeviceFingerPrint(String value) { this.DeviceFingerPrint = value; return this; }
        public String getMerchantSessionId() { return MerchantSessionId; }
        public ACHExtendedData setMerchantSessionId(String value) { this.MerchantSessionId = value; return this; }
        public String getCurrencyCode() { return CurrencyCode; }
        public ACHExtendedData setCurrencyCode(String value) { this.CurrencyCode = value; return this; }
        public String getPaymentType() { return PaymentType; }
        public ACHExtendedData setPaymentType(String value) { this.PaymentType = value; return this; }
        public Boolean isVerifyCustomer() { return VerifyCustomer; }
        public ACHExtendedData setVerifyCustomer(Boolean value) { this.VerifyCustomer = value; return this; }
        public String getCustomerExternalId() { return CustomerExternalId; }
        public ACHExtendedData setCustomerExternalId(String value) { this.CustomerExternalId = value; return this; }
        public String getDescription() { return Description; }
        public ACHExtendedData setDescription(String value) { this.Description = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public ACHExtendedData setCustomerName(String value) { this.CustomerName = value; return this; }
        public String getAddressLine1() { return AddressLine1; }
        public ACHExtendedData setAddressLine1(String value) { this.AddressLine1 = value; return this; }
        public String getAddressLine2() { return AddressLine2; }
        public ACHExtendedData setAddressLine2(String value) { this.AddressLine2 = value; return this; }
        public String getCity() { return City; }
        public ACHExtendedData setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public ACHExtendedData setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public ACHExtendedData setZip(String value) { this.Zip = value; return this; }
        public String getCountry() { return Country; }
        public ACHExtendedData setCountry(String value) { this.Country = value; return this; }
        public String getEmail() { return Email; }
        public ACHExtendedData setEmail(String value) { this.Email = value; return this; }
        public String getTelephoneNumber() { return TelephoneNumber; }
        public ACHExtendedData setTelephoneNumber(String value) { this.TelephoneNumber = value; return this; }
        public String getReturnUrl() { return ReturnUrl; }
        public ACHExtendedData setReturnUrl(String value) { this.ReturnUrl = value; return this; }
        public String getCancelUrl() { return CancelUrl; }
        public ACHExtendedData setCancelUrl(String value) { this.CancelUrl = value; return this; }
        public String getEstablishData() { return EstablishData; }
        public ACHExtendedData setEstablishData(String value) { this.EstablishData = value; return this; }
        public String getRedirectUrl() { return RedirectUrl; }
        public ACHExtendedData setRedirectUrl(String value) { this.RedirectUrl = value; return this; }
        public Integer getRetryAttemptCount() { return RetryAttemptCount; }
        public ACHExtendedData setRetryAttemptCount(Integer value) { this.RetryAttemptCount = value; return this; }
        public String getSignatureHashVersion() { return SignatureHashVersion; }
        public ACHExtendedData setSignatureHashVersion(String value) { this.SignatureHashVersion = value; return this; }
        public Date getDeadlineHashDate() { return DeadlineHashDate; }
        public ACHExtendedData setDeadlineHashDate(Date value) { this.DeadlineHashDate = value; return this; }
    }

    public static enum RecurringPaymentType
    {
        Single,
        Recurring;
    }

    @DataContract
    public static class AchPreAuthorize extends AchPaysecureVersion
    {
        @DataMember
        public String TranId = null;

        @DataMember
        public String ApprovalCode = null;

        @DataMember
        public String ResponseCode = null;

        @DataMember
        public String Network = null;

        @DataMember
        public Integer ApprovedAmount = null;

        @DataMember
        public String ErrorMessage = null;

        @DataMember
        public String ErrorCode = null;

        @DataMember(EmitDefaultValue=false)
        public AchProviderResponse AchProviderDetails = null;
        
        public String getTranId() { return TranId; }
        public AchPreAuthorize setTranId(String value) { this.TranId = value; return this; }
        public String getApprovalCode() { return ApprovalCode; }
        public AchPreAuthorize setApprovalCode(String value) { this.ApprovalCode = value; return this; }
        public String getResponseCode() { return ResponseCode; }
        public AchPreAuthorize setResponseCode(String value) { this.ResponseCode = value; return this; }
        public String getNetwork() { return Network; }
        public AchPreAuthorize setNetwork(String value) { this.Network = value; return this; }
        public Integer getApprovedAmount() { return ApprovedAmount; }
        public AchPreAuthorize setApprovedAmount(Integer value) { this.ApprovedAmount = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public AchPreAuthorize setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public AchPreAuthorize setErrorCode(String value) { this.ErrorCode = value; return this; }
        public AchProviderResponse getAchProviderDetails() { return AchProviderDetails; }
        public AchPreAuthorize setAchProviderDetails(AchProviderResponse value) { this.AchProviderDetails = value; return this; }
    }

    @DataContract
    public static class AchPaysecureVersion extends PaysecureResponseInternal
    {
        @DataMember(EmitDefaultValue=false)
        public String LocalDateTime = null;

        @DataMember(EmitDefaultValue=false)
        public ACHExtendedDataResponse ExtendedData = null;
        
        public String getLocalDateTime() { return LocalDateTime; }
        public AchPaysecureVersion setLocalDateTime(String value) { this.LocalDateTime = value; return this; }
        public ACHExtendedDataResponse getExtendedData() { return ExtendedData; }
        public AchPaysecureVersion setExtendedData(ACHExtendedDataResponse value) { this.ExtendedData = value; return this; }
    }

    @DataContract
    public static class PaysecureResponseInternal
    {
        @DataMember(EmitDefaultValue=false)
        public RequestTimestamps Timestamps = null;
        
        public RequestTimestamps getTimestamps() { return Timestamps; }
        public PaysecureResponseInternal setTimestamps(RequestTimestamps value) { this.Timestamps = value; return this; }
    }

    @DataContract
    public static class RequestTimestamps
    {
        @DataMember(EmitDefaultValue=false)
        public InOutTimes AppLayer = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes ParentLookup = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes RetryLookup = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes GetCardData = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes CardTokenize = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes CardEncrypt = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes DBInsert = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes BackendProcess = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes DBUpdate = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes ParentUpdate = null;

        @DataMember(EmitDefaultValue=false)
        public InOutTimes Network = null;
        
        public InOutTimes getAppLayer() { return AppLayer; }
        public RequestTimestamps setAppLayer(InOutTimes value) { this.AppLayer = value; return this; }
        public InOutTimes getParentLookup() { return ParentLookup; }
        public RequestTimestamps setParentLookup(InOutTimes value) { this.ParentLookup = value; return this; }
        public InOutTimes getRetryLookup() { return RetryLookup; }
        public RequestTimestamps setRetryLookup(InOutTimes value) { this.RetryLookup = value; return this; }
        public InOutTimes getGetCardData() { return GetCardData; }
        public RequestTimestamps setGetCardData(InOutTimes value) { this.GetCardData = value; return this; }
        public InOutTimes getCardTokenize() { return CardTokenize; }
        public RequestTimestamps setCardTokenize(InOutTimes value) { this.CardTokenize = value; return this; }
        public InOutTimes getCardEncrypt() { return CardEncrypt; }
        public RequestTimestamps setCardEncrypt(InOutTimes value) { this.CardEncrypt = value; return this; }
        public InOutTimes getDbInsert() { return DBInsert; }
        public RequestTimestamps setDbInsert(InOutTimes value) { this.DBInsert = value; return this; }
        public InOutTimes getBackendProcess() { return BackendProcess; }
        public RequestTimestamps setBackendProcess(InOutTimes value) { this.BackendProcess = value; return this; }
        public InOutTimes getDbUpdate() { return DBUpdate; }
        public RequestTimestamps setDbUpdate(InOutTimes value) { this.DBUpdate = value; return this; }
        public InOutTimes getParentUpdate() { return ParentUpdate; }
        public RequestTimestamps setParentUpdate(InOutTimes value) { this.ParentUpdate = value; return this; }
        public InOutTimes getNetwork() { return Network; }
        public RequestTimestamps setNetwork(InOutTimes value) { this.Network = value; return this; }
    }

    @DataContract
    public static class InOutTimes
    {
        
    }

    @DataContract
    public static class ACHExtendedDataResponse
    {
        @DataMember(EmitDefaultValue=false)
        public String NetworkResponseCode = null;

        @DataMember(EmitDefaultValue=false)
        public String NetworkErrorCode = null;

        @DataMember(EmitDefaultValue=false)
        public String DeclineReferenceCode = null;

        @DataMember(EmitDefaultValue=false)
        public String NetworkTransactionId = null;
        
        public String getNetworkResponseCode() { return NetworkResponseCode; }
        public ACHExtendedDataResponse setNetworkResponseCode(String value) { this.NetworkResponseCode = value; return this; }
        public String getNetworkErrorCode() { return NetworkErrorCode; }
        public ACHExtendedDataResponse setNetworkErrorCode(String value) { this.NetworkErrorCode = value; return this; }
        public String getDeclineReferenceCode() { return DeclineReferenceCode; }
        public ACHExtendedDataResponse setDeclineReferenceCode(String value) { this.DeclineReferenceCode = value; return this; }
        public String getNetworkTransactionId() { return NetworkTransactionId; }
        public ACHExtendedDataResponse setNetworkTransactionId(String value) { this.NetworkTransactionId = value; return this; }
    }

    @DataContract
    public static class AchProviderResponse
    {
        @DataMember
        public String NetworkResponseCode = null;

        @DataMember
        public Integer TransactionStatusCode = null;
        
        public String getNetworkResponseCode() { return NetworkResponseCode; }
        public AchProviderResponse setNetworkResponseCode(String value) { this.NetworkResponseCode = value; return this; }
        public Integer getTransactionStatusCode() { return TransactionStatusCode; }
        public AchProviderResponse setTransactionStatusCode(Integer value) { this.TransactionStatusCode = value; return this; }
    }

}

Java AchPreAuthorizeRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Credentials":{"MerchantId":"String","UserName":"String","Password":"String","Version":"String"},"ACHToken":{"ACHTokenType":"Token","ACHTokenData":"String"},"Amount":0,"ReferenceKey":"String","CurrencyCode":"String","Custom1":"String","Custom2":"String","Custom3":"String","Custom4":"String","Custom5":"String","SignatureHash":"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":"\/Date(-62135596800000-0000)\/"},"RecurringPayment":"Single"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TranId":"String","ApprovalCode":"String","ResponseCode":"String","Network":"String","ApprovedAmount":0,"ErrorMessage":"String","ErrorCode":"String","AchProviderDetails":{"NetworkResponseCode":"String","TransactionStatusCode":0},"LocalDateTime":"String","ExtendedData":{"NetworkResponseCode":"String","NetworkErrorCode":"String","DeclineReferenceCode":"String","NetworkTransactionId":"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)\/"}}}