PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

AchPreAuthCaptureRequest

The following routes are available for this service:
POST/ACHPreAuthCapture

export class RequestorCredentials
{
    // @Required()
    public MerchantId: string;

    // @Required()
    public UserName: string;

    // @Required()
    public Password: string;

    // @Required()
    public Version: string;

    public constructor(init?: Partial<RequestorCredentials>) { (Object as any).assign(this, init); }
}

export class MerchantDataElements
{
    public RefundSettlementTypeDetails: number;
    public SendRecurringPOSEntryModeFeature: boolean;
    public UseOrgPOSCode: boolean;

    public constructor(init?: Partial<MerchantDataElements>) { (Object as any).assign(this, init); }
}

export class MerchantDescriptorBase
{
    public DataElements: MerchantDataElements;

    public constructor(init?: Partial<MerchantDescriptorBase>) { (Object as any).assign(this, init); }
}

export class MerchantDescriptor extends MerchantDescriptorBase
{
    public Name: string;
    public Address: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Country: string;
    public CustomerServiceNumber: string;
    public MCC: string;
    public FNSnum: string;
    public Email: string;

    public constructor(init?: Partial<MerchantDescriptor>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class ACHExtendedData
{
    // @DataMember
    public CashbackAmount: number;

    // @DataMember
    public ConnectPaySubScriberId: string;

    // @DataMember
    public OrganizationId: string;

    // @DataMember
    public DeviceFingerPrint: string;

    // @DataMember
    public MerchantSessionId: string;

    // @DataMember
    public CurrencyCode: string;

    // @DataMember
    public PaymentType: string;

    // @DataMember
    public VerifyCustomer: boolean;

    // @DataMember
    public CustomerExternalId: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public CustomerName: string;

    // @DataMember
    public AddressLine1: string;

    // @DataMember
    public AddressLine2: string;

    // @DataMember
    public City: string;

    // @DataMember
    public State: string;

    // @DataMember
    public Zip: string;

    // @DataMember
    public Country: string;

    // @DataMember
    public Email: string;

    // @DataMember
    public TelephoneNumber: string;

    // @DataMember
    public ReturnUrl: string;

    // @DataMember
    public CancelUrl: string;

    // @DataMember
    public EstablishData: string;

    // @DataMember
    public RedirectUrl: string;

    // @DataMember
    public RetryAttemptCount: number;

    // @DataMember
    public SignatureHashVersion: string;

    // @DataMember
    public DeadlineHashDate?: string;

    public constructor(init?: Partial<ACHExtendedData>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AchPreAuthCaptureRequest
{
    // @DataMember
    public Credentials: RequestorCredentials;

    // @DataMember
    public TranId: string;

    // @DataMember
    public Amount: number;

    // @DataMember
    public ReferenceKey: string;

    // @DataMember
    public MerchantDetails: MerchantDescriptor;

    // @DataMember
    public Custom1: string;

    // @DataMember
    public Custom2: string;

    // @DataMember
    public Custom3: string;

    // @DataMember
    public Custom4: string;

    // @DataMember
    public Custom5: string;

    // @DataMember
    public SignatureHash: string;

    // @DataMember
    public ExtendedData: ACHExtendedData;

    public constructor(init?: Partial<AchPreAuthCaptureRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class InOutTimes
{

    public constructor(init?: Partial<InOutTimes>) { (Object as any).assign(this, init); }
}

// @DataContract
export class RequestTimestamps
{
    // @DataMember(EmitDefaultValue=false)
    public AppLayer: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public ParentLookup: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public RetryLookup: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public GetCardData: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public CardTokenize: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public CardEncrypt: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public DBInsert: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public BackendProcess: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public DBUpdate: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public ParentUpdate: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public Network: InOutTimes;

    public constructor(init?: Partial<RequestTimestamps>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PaysecureResponseInternal
{
    // @DataMember(EmitDefaultValue=false)
    public Timestamps: RequestTimestamps;

    public constructor(init?: Partial<PaysecureResponseInternal>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ACHExtendedDataResponse
{
    // @DataMember(EmitDefaultValue=false)
    public NetworkResponseCode: string;

    // @DataMember(EmitDefaultValue=false)
    public NetworkErrorCode: string;

    // @DataMember(EmitDefaultValue=false)
    public DeclineReferenceCode: string;

    // @DataMember(EmitDefaultValue=false)
    public NetworkTransactionId: string;

    public constructor(init?: Partial<ACHExtendedDataResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AchPaysecureVersion extends PaysecureResponseInternal
{
    // @DataMember(EmitDefaultValue=false)
    public LocalDateTime: string;

    // @DataMember(EmitDefaultValue=false)
    public ExtendedData: ACHExtendedDataResponse;

    public constructor(init?: Partial<AchPaysecureVersion>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class AchProviderResponse
{
    // @DataMember
    public NetworkResponseCode: string;

    // @DataMember
    public TransactionStatusCode: number;

    public constructor(init?: Partial<AchProviderResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AchPreAuthCapture extends AchPaysecureVersion
{
    // @DataMember
    public TranId: string;

    // @DataMember
    public ApprovalCode: string;

    // @DataMember
    public ResponseCode: string;

    // @DataMember
    public ErrorMessage: string;

    // @DataMember
    public ErrorCode: string;

    // @DataMember(EmitDefaultValue=false)
    public AchProviderDetails: AchProviderResponse;

    public constructor(init?: Partial<AchPreAuthCapture>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AchPreAuthCaptureRequest 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 /ACHPreAuthCapture 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"},"TranId":"String","Amount":0,"ReferenceKey":"String","MerchantDetails":{"Name":"String","Address":"String","City":"String","State":"String","Zip":"String","Country":"String","CustomerServiceNumber":"String","MCC":"String","FNSnum":"String","Email":"String","DataElements":{"RefundSettlementTypeDetails":0,"SendRecurringPOSEntryModeFeature":false,"UseOrgPOSCode":false}},"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)\/"}}

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

{"TranId":"String","ApprovalCode":"String","ResponseCode":"String","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)\/"}}}