PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

CreateACHTokenRequest

The following routes are available for this service:
POST/CreateACHToken
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RequestorCredentials:
    # @Required()
    merchant_id: Optional[str] = None

    # @Required()
    user_name: Optional[str] = None

    # @Required()
    password: Optional[str] = None

    # @Required()
    version: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ACHExtendedData:
    cashback_amount: int = 0
    connect_pay_sub_scriber_id: Optional[str] = None
    organization_id: Optional[str] = None
    device_finger_print: Optional[str] = None
    merchant_session_id: Optional[str] = None
    currency_code: Optional[str] = None
    payment_type: Optional[str] = None
    verify_customer: bool = False
    customer_external_id: Optional[str] = None
    description: Optional[str] = None
    customer_name: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    zip: Optional[str] = None
    country: Optional[str] = None
    email: Optional[str] = None
    telephone_number: Optional[str] = None
    return_url: Optional[str] = None
    cancel_url: Optional[str] = None
    establish_data: Optional[str] = None
    redirect_url: Optional[str] = None
    retry_attempt_count: int = 0
    signature_hash_version: Optional[str] = None
    deadline_hash_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateACHTokenRequest:
    credentials: Optional[RequestorCredentials] = None
    session_id: Optional[str] = None
    extended_data: Optional[ACHExtendedData] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InOutTimes:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RequestTimestamps:
    app_layer: Optional[InOutTimes] = None
    parent_lookup: Optional[InOutTimes] = None
    retry_lookup: Optional[InOutTimes] = None
    get_card_data: Optional[InOutTimes] = None
    card_tokenize: Optional[InOutTimes] = None
    card_encrypt: Optional[InOutTimes] = None
    db_insert: Optional[InOutTimes] = None
    backend_process: Optional[InOutTimes] = None
    db_update: Optional[InOutTimes] = None
    parent_update: Optional[InOutTimes] = None
    network: Optional[InOutTimes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaysecureResponseInternal:
    timestamps: Optional[RequestTimestamps] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserInformation:
    name: Optional[List[str]] = None
    phone: Optional[List[str]] = None
    email: Optional[List[str]] = None
    address: Optional[List[AddressDetails]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ACHExtendedDataResponse:
    network_response_code: Optional[str] = None
    network_error_code: Optional[str] = None
    decline_reference_code: Optional[str] = None
    network_transaction_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateACHToken(PaysecureResponseInternal):
    ach_token: Optional[str] = None
    bank_name: Optional[str] = None
    account_number_last4: Optional[str] = None
    ach_hash: Optional[str] = None
    account_type: Optional[str] = None
    account_name: Optional[str] = None
    bank_id: Optional[str] = None
    account_status: Optional[str] = None
    user_information: Optional[UserInformation] = None
    response_code: Optional[str] = None
    error_message: Optional[str] = None
    error_code: Optional[str] = None
    extended_data: Optional[ACHExtendedDataResponse] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressDetails:
    address1: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    zip: Optional[str] = None
    country: Optional[str] = None

Python 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>