PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

AchPreAuthCaptureRequest

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

public class dtos
{

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

        @DataMember
        public String TranId = null;

        @DataMember
        public Integer Amount = null;

        @DataMember
        public String ReferenceKey = null;

        @DataMember
        public MerchantDescriptor MerchantDetails = 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;
        
        public RequestorCredentials getCredentials() { return Credentials; }
        public AchPreAuthCaptureRequest setCredentials(RequestorCredentials value) { this.Credentials = value; return this; }
        public String getTranId() { return TranId; }
        public AchPreAuthCaptureRequest setTranId(String value) { this.TranId = value; return this; }
        public Integer getAmount() { return Amount; }
        public AchPreAuthCaptureRequest setAmount(Integer value) { this.Amount = value; return this; }
        public String getReferenceKey() { return ReferenceKey; }
        public AchPreAuthCaptureRequest setReferenceKey(String value) { this.ReferenceKey = value; return this; }
        public MerchantDescriptor getMerchantDetails() { return MerchantDetails; }
        public AchPreAuthCaptureRequest setMerchantDetails(MerchantDescriptor value) { this.MerchantDetails = value; return this; }
        public String getCustom1() { return Custom1; }
        public AchPreAuthCaptureRequest setCustom1(String value) { this.Custom1 = value; return this; }
        public String getCustom2() { return Custom2; }
        public AchPreAuthCaptureRequest setCustom2(String value) { this.Custom2 = value; return this; }
        public String getCustom3() { return Custom3; }
        public AchPreAuthCaptureRequest setCustom3(String value) { this.Custom3 = value; return this; }
        public String getCustom4() { return Custom4; }
        public AchPreAuthCaptureRequest setCustom4(String value) { this.Custom4 = value; return this; }
        public String getCustom5() { return Custom5; }
        public AchPreAuthCaptureRequest setCustom5(String value) { this.Custom5 = value; return this; }
        public String getSignatureHash() { return SignatureHash; }
        public AchPreAuthCaptureRequest setSignatureHash(String value) { this.SignatureHash = value; return this; }
        public ACHExtendedData getExtendedData() { return ExtendedData; }
        public AchPreAuthCaptureRequest setExtendedData(ACHExtendedData value) { this.ExtendedData = 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 MerchantDescriptor extends MerchantDescriptorBase
    {
        public String Name = null;
        public String Address = null;
        public String City = null;
        public String State = null;
        public String Zip = null;
        public String Country = null;
        public String CustomerServiceNumber = null;
        public String MCC = null;
        public String FNSnum = null;
        public String Email = null;
        
        public String getName() { return Name; }
        public MerchantDescriptor setName(String value) { this.Name = value; return this; }
        public String getAddress() { return Address; }
        public MerchantDescriptor setAddress(String value) { this.Address = value; return this; }
        public String getCity() { return City; }
        public MerchantDescriptor setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public MerchantDescriptor setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public MerchantDescriptor setZip(String value) { this.Zip = value; return this; }
        public String getCountry() { return Country; }
        public MerchantDescriptor setCountry(String value) { this.Country = value; return this; }
        public String getCustomerServiceNumber() { return CustomerServiceNumber; }
        public MerchantDescriptor setCustomerServiceNumber(String value) { this.CustomerServiceNumber = value; return this; }
        public String getMcc() { return MCC; }
        public MerchantDescriptor setMcc(String value) { this.MCC = value; return this; }
        public String getFnSnum() { return FNSnum; }
        public MerchantDescriptor setFnSnum(String value) { this.FNSnum = value; return this; }
        public String getEmail() { return Email; }
        public MerchantDescriptor setEmail(String value) { this.Email = value; return this; }
    }

    public static class MerchantDescriptorBase
    {
        public MerchantDataElements DataElements = null;
        
        public MerchantDataElements getDataElements() { return DataElements; }
        public MerchantDescriptorBase setDataElements(MerchantDataElements value) { this.DataElements = value; return this; }
    }

    public static class MerchantDataElements
    {
        public Integer RefundSettlementTypeDetails = null;
        public Boolean SendRecurringPOSEntryModeFeature = null;
        public Boolean UseOrgPOSCode = null;
        
        public Integer getRefundSettlementTypeDetails() { return RefundSettlementTypeDetails; }
        public MerchantDataElements setRefundSettlementTypeDetails(Integer value) { this.RefundSettlementTypeDetails = value; return this; }
        public Boolean isSendRecurringPOSEntryModeFeature() { return SendRecurringPOSEntryModeFeature; }
        public MerchantDataElements setSendRecurringPOSEntryModeFeature(Boolean value) { this.SendRecurringPOSEntryModeFeature = value; return this; }
        public Boolean isUseOrgPOSCode() { return UseOrgPOSCode; }
        public MerchantDataElements setUseOrgPOSCode(Boolean value) { this.UseOrgPOSCode = value; return this; }
    }

    @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; }
    }

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

        @DataMember
        public String ApprovalCode = null;

        @DataMember
        public String ResponseCode = null;

        @DataMember
        public String ErrorMessage = null;

        @DataMember
        public String ErrorCode = null;

        @DataMember(EmitDefaultValue=false)
        public AchProviderResponse AchProviderDetails = null;
        
        public String getTranId() { return TranId; }
        public AchPreAuthCapture setTranId(String value) { this.TranId = value; return this; }
        public String getApprovalCode() { return ApprovalCode; }
        public AchPreAuthCapture setApprovalCode(String value) { this.ApprovalCode = value; return this; }
        public String getResponseCode() { return ResponseCode; }
        public AchPreAuthCapture setResponseCode(String value) { this.ResponseCode = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public AchPreAuthCapture setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public AchPreAuthCapture setErrorCode(String value) { this.ErrorCode = value; return this; }
        public AchProviderResponse getAchProviderDetails() { return AchProviderDetails; }
        public AchPreAuthCapture 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 AchPreAuthCaptureRequest 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 /ACHPreAuthCapture HTTP/1.1 
Host: api.paysecure.acculynk.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchPreAuthCaptureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <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>
</AchPreAuthCaptureRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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