PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

CreateAchSessionRequest

The following routes are available for this service:
POST/CreateAchSession
import 'package:servicestack/servicestack.dart';

class RequestorCredentials implements IConvertible
{
    // @Required()
    String? MerchantId;

    // @Required()
    String? UserName;

    // @Required()
    String? Password;

    // @Required()
    String? Version;

    RequestorCredentials({this.MerchantId,this.UserName,this.Password,this.Version});
    RequestorCredentials.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MerchantId = json['MerchantId'];
        UserName = json['UserName'];
        Password = json['Password'];
        Version = json['Version'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MerchantId': MerchantId,
        'UserName': UserName,
        'Password': Password,
        'Version': Version
    };

    getTypeName() => "RequestorCredentials";
    TypeContext? context = _ctx;
}

// @DataContract
class ACHExtendedData implements IConvertible
{
    // @DataMember
    int? CashbackAmount;

    // @DataMember
    String? ConnectPaySubScriberId;

    // @DataMember
    String? OrganizationId;

    // @DataMember
    String? DeviceFingerPrint;

    // @DataMember
    String? MerchantSessionId;

    // @DataMember
    String? CurrencyCode;

    // @DataMember
    String? PaymentType;

    // @DataMember
    bool? VerifyCustomer;

    // @DataMember
    String? CustomerExternalId;

    // @DataMember
    String? Description;

    // @DataMember
    String? CustomerName;

    // @DataMember
    String? AddressLine1;

    // @DataMember
    String? AddressLine2;

    // @DataMember
    String? City;

    // @DataMember
    String? State;

    // @DataMember
    String? Zip;

    // @DataMember
    String? Country;

    // @DataMember
    String? Email;

    // @DataMember
    String? TelephoneNumber;

    // @DataMember
    String? ReturnUrl;

    // @DataMember
    String? CancelUrl;

    // @DataMember
    String? EstablishData;

    // @DataMember
    String? RedirectUrl;

    // @DataMember
    int? RetryAttemptCount;

    // @DataMember
    String? SignatureHashVersion;

    // @DataMember
    DateTime? DeadlineHashDate;

    ACHExtendedData({this.CashbackAmount,this.ConnectPaySubScriberId,this.OrganizationId,this.DeviceFingerPrint,this.MerchantSessionId,this.CurrencyCode,this.PaymentType,this.VerifyCustomer,this.CustomerExternalId,this.Description,this.CustomerName,this.AddressLine1,this.AddressLine2,this.City,this.State,this.Zip,this.Country,this.Email,this.TelephoneNumber,this.ReturnUrl,this.CancelUrl,this.EstablishData,this.RedirectUrl,this.RetryAttemptCount,this.SignatureHashVersion,this.DeadlineHashDate});
    ACHExtendedData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CashbackAmount = json['CashbackAmount'];
        ConnectPaySubScriberId = json['ConnectPaySubScriberId'];
        OrganizationId = json['OrganizationId'];
        DeviceFingerPrint = json['DeviceFingerPrint'];
        MerchantSessionId = json['MerchantSessionId'];
        CurrencyCode = json['CurrencyCode'];
        PaymentType = json['PaymentType'];
        VerifyCustomer = json['VerifyCustomer'];
        CustomerExternalId = json['CustomerExternalId'];
        Description = json['Description'];
        CustomerName = json['CustomerName'];
        AddressLine1 = json['AddressLine1'];
        AddressLine2 = json['AddressLine2'];
        City = json['City'];
        State = json['State'];
        Zip = json['Zip'];
        Country = json['Country'];
        Email = json['Email'];
        TelephoneNumber = json['TelephoneNumber'];
        ReturnUrl = json['ReturnUrl'];
        CancelUrl = json['CancelUrl'];
        EstablishData = json['EstablishData'];
        RedirectUrl = json['RedirectUrl'];
        RetryAttemptCount = json['RetryAttemptCount'];
        SignatureHashVersion = json['SignatureHashVersion'];
        DeadlineHashDate = JsonConverters.fromJson(json['DeadlineHashDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CashbackAmount': CashbackAmount,
        'ConnectPaySubScriberId': ConnectPaySubScriberId,
        'OrganizationId': OrganizationId,
        'DeviceFingerPrint': DeviceFingerPrint,
        'MerchantSessionId': MerchantSessionId,
        'CurrencyCode': CurrencyCode,
        'PaymentType': PaymentType,
        'VerifyCustomer': VerifyCustomer,
        'CustomerExternalId': CustomerExternalId,
        'Description': Description,
        'CustomerName': CustomerName,
        'AddressLine1': AddressLine1,
        'AddressLine2': AddressLine2,
        'City': City,
        'State': State,
        'Zip': Zip,
        'Country': Country,
        'Email': Email,
        'TelephoneNumber': TelephoneNumber,
        'ReturnUrl': ReturnUrl,
        'CancelUrl': CancelUrl,
        'EstablishData': EstablishData,
        'RedirectUrl': RedirectUrl,
        'RetryAttemptCount': RetryAttemptCount,
        'SignatureHashVersion': SignatureHashVersion,
        'DeadlineHashDate': JsonConverters.toJson(DeadlineHashDate,'DateTime',context!)
    };

    getTypeName() => "ACHExtendedData";
    TypeContext? context = _ctx;
}

// @DataContract
class CreateAchSessionRequest implements IConvertible
{
    // @DataMember
    RequestorCredentials? Credentials;

    // @DataMember
    double? ACHSessionExpiryInMin;

    // @DataMember
    double? ACHSessionTTL;

    // @DataMember
    ACHExtendedData? ExtendedData;

    CreateAchSessionRequest({this.Credentials,this.ACHSessionExpiryInMin,this.ACHSessionTTL,this.ExtendedData});
    CreateAchSessionRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Credentials = JsonConverters.fromJson(json['Credentials'],'RequestorCredentials',context!);
        ACHSessionExpiryInMin = JsonConverters.toDouble(json['ACHSessionExpiryInMin']);
        ACHSessionTTL = JsonConverters.toDouble(json['ACHSessionTTL']);
        ExtendedData = JsonConverters.fromJson(json['ExtendedData'],'ACHExtendedData',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Credentials': JsonConverters.toJson(Credentials,'RequestorCredentials',context!),
        'ACHSessionExpiryInMin': ACHSessionExpiryInMin,
        'ACHSessionTTL': ACHSessionTTL,
        'ExtendedData': JsonConverters.toJson(ExtendedData,'ACHExtendedData',context!)
    };

    getTypeName() => "CreateAchSessionRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class InOutTimes implements IConvertible
{
    InOutTimes();
    InOutTimes.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "InOutTimes";
    TypeContext? context = _ctx;
}

// @DataContract
class RequestTimestamps implements IConvertible
{
    // @DataMember(EmitDefaultValue=false)
    InOutTimes? AppLayer;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? ParentLookup;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? RetryLookup;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? GetCardData;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? CardTokenize;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? CardEncrypt;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? DBInsert;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? BackendProcess;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? DBUpdate;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? ParentUpdate;

    // @DataMember(EmitDefaultValue=false)
    InOutTimes? Network;

    RequestTimestamps({this.AppLayer,this.ParentLookup,this.RetryLookup,this.GetCardData,this.CardTokenize,this.CardEncrypt,this.DBInsert,this.BackendProcess,this.DBUpdate,this.ParentUpdate,this.Network});
    RequestTimestamps.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AppLayer = JsonConverters.fromJson(json['AppLayer'],'InOutTimes',context!);
        ParentLookup = JsonConverters.fromJson(json['ParentLookup'],'InOutTimes',context!);
        RetryLookup = JsonConverters.fromJson(json['RetryLookup'],'InOutTimes',context!);
        GetCardData = JsonConverters.fromJson(json['GetCardData'],'InOutTimes',context!);
        CardTokenize = JsonConverters.fromJson(json['CardTokenize'],'InOutTimes',context!);
        CardEncrypt = JsonConverters.fromJson(json['CardEncrypt'],'InOutTimes',context!);
        DBInsert = JsonConverters.fromJson(json['DBInsert'],'InOutTimes',context!);
        BackendProcess = JsonConverters.fromJson(json['BackendProcess'],'InOutTimes',context!);
        DBUpdate = JsonConverters.fromJson(json['DBUpdate'],'InOutTimes',context!);
        ParentUpdate = JsonConverters.fromJson(json['ParentUpdate'],'InOutTimes',context!);
        Network = JsonConverters.fromJson(json['Network'],'InOutTimes',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AppLayer': JsonConverters.toJson(AppLayer,'InOutTimes',context!),
        'ParentLookup': JsonConverters.toJson(ParentLookup,'InOutTimes',context!),
        'RetryLookup': JsonConverters.toJson(RetryLookup,'InOutTimes',context!),
        'GetCardData': JsonConverters.toJson(GetCardData,'InOutTimes',context!),
        'CardTokenize': JsonConverters.toJson(CardTokenize,'InOutTimes',context!),
        'CardEncrypt': JsonConverters.toJson(CardEncrypt,'InOutTimes',context!),
        'DBInsert': JsonConverters.toJson(DBInsert,'InOutTimes',context!),
        'BackendProcess': JsonConverters.toJson(BackendProcess,'InOutTimes',context!),
        'DBUpdate': JsonConverters.toJson(DBUpdate,'InOutTimes',context!),
        'ParentUpdate': JsonConverters.toJson(ParentUpdate,'InOutTimes',context!),
        'Network': JsonConverters.toJson(Network,'InOutTimes',context!)
    };

    getTypeName() => "RequestTimestamps";
    TypeContext? context = _ctx;
}

// @DataContract
class PaysecureResponseInternal implements IConvertible
{
    // @DataMember(EmitDefaultValue=false)
    RequestTimestamps? Timestamps;

    PaysecureResponseInternal({this.Timestamps});
    PaysecureResponseInternal.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Timestamps = JsonConverters.fromJson(json['Timestamps'],'RequestTimestamps',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Timestamps': JsonConverters.toJson(Timestamps,'RequestTimestamps',context!)
    };

    getTypeName() => "PaysecureResponseInternal";
    TypeContext? context = _ctx;
}

// @DataContract
class CreateAchSession extends PaysecureResponseInternal implements IConvertible
{
    // @DataMember
    String? SessionId;

    // @DataMember
    String? ErrorCode;

    // @DataMember
    String? ErrorMessage;

    // @DataMember
    ACHExtendedData? ExtendedData;

    CreateAchSession({this.SessionId,this.ErrorCode,this.ErrorMessage,this.ExtendedData});
    CreateAchSession.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        SessionId = json['SessionId'];
        ErrorCode = json['ErrorCode'];
        ErrorMessage = json['ErrorMessage'];
        ExtendedData = JsonConverters.fromJson(json['ExtendedData'],'ACHExtendedData',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'SessionId': SessionId,
        'ErrorCode': ErrorCode,
        'ErrorMessage': ErrorMessage,
        'ExtendedData': JsonConverters.toJson(ExtendedData,'ACHExtendedData',context!)
    });

    getTypeName() => "CreateAchSession";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.paysecure.acculynk.net', types: <String, TypeInfo> {
    'RequestorCredentials': TypeInfo(TypeOf.Class, create:() => RequestorCredentials()),
    'ACHExtendedData': TypeInfo(TypeOf.Class, create:() => ACHExtendedData()),
    'CreateAchSessionRequest': TypeInfo(TypeOf.Class, create:() => CreateAchSessionRequest()),
    'InOutTimes': TypeInfo(TypeOf.Class, create:() => InOutTimes()),
    'RequestTimestamps': TypeInfo(TypeOf.Class, create:() => RequestTimestamps()),
    'PaysecureResponseInternal': TypeInfo(TypeOf.Class, create:() => PaysecureResponseInternal()),
    'CreateAchSession': TypeInfo(TypeOf.Class, create:() => CreateAchSession()),
});

Dart CreateAchSessionRequest 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 /CreateAchSession 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
	},
	ACHSessionExpiryInMin: 0,
	ACHSessionTTL: 0,
	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

{
	SessionId: String,
	ErrorCode: String,
	ErrorMessage: 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
	},
	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
		}
	}
}