| POST | /ACHPreAuthorize |
|---|
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
class ACHType(str, Enum):
TOKEN = 'Token'
CP_TOKEN = 'CPToken'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ACHTokenDescriptor:
ach_token_type: Optional[ACHType] = None
ach_token_data: 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
class RecurringPaymentType(str, Enum):
SINGLE = 'Single'
RECURRING = 'Recurring'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPreAuthorizeRequest:
credentials: Optional[RequestorCredentials] = None
ach_token: Optional[ACHTokenDescriptor] = None
amount: int = 0
reference_key: Optional[str] = None
currency_code: Optional[str] = None
custom1: Optional[str] = None
custom2: Optional[str] = None
custom3: Optional[str] = None
custom4: Optional[str] = None
custom5: Optional[str] = None
signature_hash: Optional[str] = None
extended_data: Optional[ACHExtendedData] = None
recurring_payment: Optional[RecurringPaymentType] = 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 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 AchPaysecureVersion(PaysecureResponseInternal):
local_date_time: Optional[str] = None
extended_data: Optional[ACHExtendedDataResponse] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchProviderResponse:
network_response_code: Optional[str] = None
transaction_status_code: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPreAuthorize(AchPaysecureVersion):
tran_id: Optional[str] = None
approval_code: Optional[str] = None
response_code: Optional[str] = None
network: Optional[str] = None
approved_amount: int = 0
error_message: Optional[str] = None
error_code: Optional[str] = None
ach_provider_details: Optional[AchProviderResponse] = None
Python AchPreAuthorizeRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ACHPreAuthorize HTTP/1.1
Host: api.paysecure.acculynk.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AchPreAuthorizeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<ACHToken>
<ACHTokenData>String</ACHTokenData>
<ACHTokenType>Token</ACHTokenType>
</ACHToken>
<Amount>0</Amount>
<Credentials>
<MerchantId>String</MerchantId>
<Password>String</Password>
<UserName>String</UserName>
<Version>String</Version>
</Credentials>
<CurrencyCode>String</CurrencyCode>
<Custom1>String</Custom1>
<Custom2>String</Custom2>
<Custom3>String</Custom3>
<Custom4>String</Custom4>
<Custom5>String</Custom5>
<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>
<RecurringPayment>Single</RecurringPayment>
<ReferenceKey>String</ReferenceKey>
<SignatureHash>String</SignatureHash>
</AchPreAuthorizeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AchPreAuthorize 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>
<ExtendedData>
<DeclineReferenceCode>String</DeclineReferenceCode>
<NetworkErrorCode>String</NetworkErrorCode>
<NetworkResponseCode>String</NetworkResponseCode>
<NetworkTransactionId>String</NetworkTransactionId>
</ExtendedData>
<LocalDateTime>String</LocalDateTime>
<AchProviderDetails>
<NetworkResponseCode>String</NetworkResponseCode>
<TransactionStatusCode>0</TransactionStatusCode>
</AchProviderDetails>
<ApprovalCode>String</ApprovalCode>
<ApprovedAmount>0</ApprovedAmount>
<ErrorCode>String</ErrorCode>
<ErrorMessage>String</ErrorMessage>
<Network>String</Network>
<ResponseCode>String</ResponseCode>
<TranId>String</TranId>
</AchPreAuthorize>