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 .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 /CreateACHToken HTTP/1.1 
Host: api.paysecure.acculynk.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateACHTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Credentials>
    <MerchantId>String</MerchantId>
    <Password>String</Password>
    <UserName>String</UserName>
    <Version>String</Version>
  </Credentials>
  <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>
  <SessionId>String</SessionId>
</CreateACHTokenRequest>

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

<CreateACHToken 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>
  <ACHHash>String</ACHHash>
  <ACHToken>String</ACHToken>
  <AccountName>String</AccountName>
  <AccountNumberLast4>String</AccountNumberLast4>
  <AccountStatus>String</AccountStatus>
  <AccountType>String</AccountType>
  <BankId>String</BankId>
  <BankName>String</BankName>
  <ErrorCode>String</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <ExtendedData>
    <DeclineReferenceCode>String</DeclineReferenceCode>
    <NetworkErrorCode>String</NetworkErrorCode>
    <NetworkResponseCode>String</NetworkResponseCode>
    <NetworkTransactionId>String</NetworkTransactionId>
  </ExtendedData>
  <ResponseCode>String</ResponseCode>
  <UserInformation>
    <Address>
      <AddressDetails>
        <Address1>String</Address1>
        <Address2>String</Address2>
        <City>String</City>
        <Country>String</Country>
        <State>String</State>
        <Zip>String</Zip>
      </AddressDetails>
    </Address>
    <Email xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Email>
    <Name xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Name>
    <Phone xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Phone>
  </UserInformation>
</CreateACHToken>