PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

AchPreAuthorizeRequest

The following routes are available for this service:
POST/ACHPreAuthorize
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Paysecure.ServiceModel;
using Paysecure.ServiceModel.Types;

namespace Paysecure.ServiceModel
{
    [DataContract]
    public partial class AchPreAuthorize
        : AchPaysecureVersion
    {
        [DataMember]
        public virtual string TranId { get; set; }

        [DataMember]
        public virtual string ApprovalCode { get; set; }

        [DataMember]
        public virtual string ResponseCode { get; set; }

        [DataMember]
        public virtual string Network { get; set; }

        [DataMember]
        public virtual int ApprovedAmount { get; set; }

        [DataMember]
        public virtual string ErrorMessage { get; set; }

        [DataMember]
        public virtual string ErrorCode { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual AchProviderResponse AchProviderDetails { get; set; }
    }

    [DataContract]
    public partial class AchPreAuthorizeRequest
    {
        [DataMember]
        public virtual RequestorCredentials Credentials { get; set; }

        [DataMember]
        public virtual ACHTokenDescriptor ACHToken { get; set; }

        [DataMember]
        public virtual int Amount { get; set; }

        [DataMember]
        public virtual string ReferenceKey { get; set; }

        [DataMember]
        public virtual string CurrencyCode { get; set; }

        [DataMember]
        public virtual string Custom1 { get; set; }

        [DataMember]
        public virtual string Custom2 { get; set; }

        [DataMember]
        public virtual string Custom3 { get; set; }

        [DataMember]
        public virtual string Custom4 { get; set; }

        [DataMember]
        public virtual string Custom5 { get; set; }

        [DataMember]
        public virtual string SignatureHash { get; set; }

        [DataMember]
        public virtual ACHExtendedData ExtendedData { get; set; }

        [DataMember]
        public virtual RecurringPaymentType RecurringPayment { get; set; }
    }

}

namespace Paysecure.ServiceModel.Types
{
    [DataContract]
    public partial class ACHExtendedData
    {
        [DataMember]
        public virtual int CashbackAmount { get; set; }

        [DataMember]
        public virtual string ConnectPaySubScriberId { get; set; }

        [DataMember]
        public virtual string OrganizationId { get; set; }

        [DataMember]
        public virtual string DeviceFingerPrint { get; set; }

        [DataMember]
        public virtual string MerchantSessionId { get; set; }

        [DataMember]
        public virtual string CurrencyCode { get; set; }

        [DataMember]
        public virtual string PaymentType { get; set; }

        [DataMember]
        public virtual bool VerifyCustomer { get; set; }

        [DataMember]
        public virtual string CustomerExternalId { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual string CustomerName { get; set; }

        [DataMember]
        public virtual string AddressLine1 { get; set; }

        [DataMember]
        public virtual string AddressLine2 { get; set; }

        [DataMember]
        public virtual string City { get; set; }

        [DataMember]
        public virtual string State { get; set; }

        [DataMember]
        public virtual string Zip { get; set; }

        [DataMember]
        public virtual string Country { get; set; }

        [DataMember]
        public virtual string Email { get; set; }

        [DataMember]
        public virtual string TelephoneNumber { get; set; }

        [DataMember]
        public virtual string ReturnUrl { get; set; }

        [DataMember]
        public virtual string CancelUrl { get; set; }

        [DataMember]
        public virtual string EstablishData { get; set; }

        [DataMember]
        public virtual string RedirectUrl { get; set; }

        [DataMember]
        public virtual int RetryAttemptCount { get; set; }

        [DataMember]
        public virtual string SignatureHashVersion { get; set; }

        [DataMember]
        public virtual DateTime? DeadlineHashDate { get; set; }
    }

    [DataContract]
    public partial class ACHExtendedDataResponse
    {
        [DataMember(EmitDefaultValue=false)]
        public virtual string NetworkResponseCode { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string NetworkErrorCode { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string DeclineReferenceCode { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string NetworkTransactionId { get; set; }
    }

    [DataContract]
    public partial class AchPaysecureVersion
        : PaysecureResponseInternal
    {
        [DataMember(EmitDefaultValue=false)]
        public virtual string LocalDateTime { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual ACHExtendedDataResponse ExtendedData { get; set; }
    }

    [DataContract]
    public partial class AchProviderResponse
    {
        [DataMember]
        public virtual string NetworkResponseCode { get; set; }

        [DataMember]
        public virtual int TransactionStatusCode { get; set; }
    }

    public partial class ACHTokenDescriptor
    {
        public virtual ACHType ACHTokenType { get; set; }
        public virtual string ACHTokenData { get; set; }
    }

    public enum ACHType
    {
        Token,
        CPToken,
    }

    [DataContract]
    public partial class InOutTimes
    {
    }

    [DataContract]
    public partial class PaysecureResponseInternal
    {
        [DataMember(EmitDefaultValue=false)]
        public virtual RequestTimestamps Timestamps { get; set; }
    }

    public enum RecurringPaymentType
    {
        Single,
        Recurring,
    }

    public partial class RequestorCredentials
    {
        [Required]
        public virtual string MerchantId { get; set; }

        [Required]
        public virtual string UserName { get; set; }

        [Required]
        public virtual string Password { get; set; }

        [Required]
        public virtual string Version { get; set; }
    }

    [DataContract]
    public partial class RequestTimestamps
    {
        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes AppLayer { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes ParentLookup { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes RetryLookup { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes GetCardData { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes CardTokenize { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes CardEncrypt { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes DBInsert { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes BackendProcess { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes DBUpdate { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes ParentUpdate { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes Network { get; set; }
    }

}

C# AchPreAuthorizeRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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)\/"}}}