PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

CreateACHTokenRequest

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

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

// @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 CreateACHTokenRequest
{
    // @DataMember
    public Credentials: RequestorCredentials;

    // @DataMember
    public SessionId: string;

    // @DataMember
    public ExtendedData: ACHExtendedData;

    public constructor(init?: Partial<CreateACHTokenRequest>) { (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 UserInformation
{
    // @DataMember
    public Name: string[];

    // @DataMember
    public Phone: string[];

    // @DataMember
    public Email: string[];

    // @DataMember
    public Address: AddressDetails[];

    public constructor(init?: Partial<UserInformation>) { (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 CreateACHToken extends PaysecureResponseInternal
{
    // @DataMember
    public ACHToken: string;

    // @DataMember
    public BankName: string;

    // @DataMember
    public AccountNumberLast4: string;

    // @DataMember
    public ACHHash: string;

    // @DataMember
    public AccountType: string;

    // @DataMember
    public AccountName: string;

    // @DataMember
    public BankId: string;

    // @DataMember
    public AccountStatus: string;

    // @DataMember
    public UserInformation: UserInformation;

    // @DataMember
    public ResponseCode: string;

    // @DataMember
    public ErrorMessage: string;

    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public ExtendedData: ACHExtendedDataResponse;

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

// @DataContract
export class AddressDetails
{
    // @DataMember
    public Address1: string;

    // @DataMember
    public Address2: string;

    // @DataMember
    public City: string;

    // @DataMember
    public State: string;

    // @DataMember
    public Zip: string;

    // @DataMember
    public Country: string;

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

TypeScript CreateACHTokenRequest 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 /CreateACHToken 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
	},
	SessionId: 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
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ACHToken: String,
	BankName: String,
	AccountNumberLast4: String,
	ACHHash: String,
	AccountType: String,
	AccountName: String,
	BankId: String,
	AccountStatus: String,
	UserInformation: 
	{
		Name: 
		[
			String
		],
		Phone: 
		[
			String
		],
		Email: 
		[
			String
		],
		Address: 
		[
			{
				Address1: String,
				Address2: String,
				City: String,
				State: String,
				Zip: String,
				Country: String
			}
		]
	},
	ResponseCode: String,
	ErrorMessage: String,
	ErrorCode: String,
	ExtendedData: 
	{
		NetworkResponseCode: String,
		NetworkErrorCode: String,
		DeclineReferenceCode: String,
		NetworkTransactionId: String
	},
	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
		}
	}
}