| POST | /POSCardlessDebit |
|---|
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 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 NetworkResponseData:
ali_pay_trans_id: Optional[str] = None
ali_pay_transaction_time: Optional[str] = None
response_code: Optional[str] = None
we_chat_pay_trans_id: Optional[str] = None
we_chat_pay_transaction_time: Optional[str] = None
we_chat_pay_open_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class POSCardlessDebit(PaysecureResponseInternal):
error_message: Optional[str] = None
error_code: Optional[str] = None
response_code: Optional[str] = None
tran_id: Optional[str] = None
approved_amount: int = 0
network: Optional[str] = None
network_response_data: Optional[NetworkResponseData] = None
@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 PaymentNetwork(IntEnum):
ALI_PAY = 1
WE_CHAT = 2
class PaymentDataType(IntEnum):
BAR_CODE = 1
QR_CODE = 2
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentInfo:
payment_network: Optional[PaymentNetwork] = None
payment_data_type: Optional[PaymentDataType] = None
payment_data: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NetworkRequestData:
ali_pay_partner_id: Optional[str] = None
web_hook_u_r_l: Optional[str] = None
order_title: Optional[str] = None
order_detail: Optional[str] = None
terminal_i_p: Optional[str] = None
order_number: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MerchantDataElements:
refund_settlement_type_details: int = 0
send_recurring_p_o_s_entry_mode_feature: bool = False
use_org_p_o_s_code: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MerchantDescriptorBase:
data_elements: Optional[MerchantDataElements] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MerchantDescriptor(MerchantDescriptorBase):
name: Optional[str] = None
address: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
zip: Optional[str] = None
country: Optional[str] = None
customer_service_number: Optional[str] = None
mcc: Optional[str] = None
fn_snum: Optional[str] = None
email: Optional[str] = None
class FundingSourceType(str, Enum):
DEPOSIT_ACCOUNT = 'DepositAccount'
CREDIT = 'Credit'
DEBIT = 'Debit'
PREPAID = 'Prepaid'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SenderInfo:
reference_number: Optional[str] = None
account_number: Optional[str] = None
name: Optional[str] = None
"""
Name Format FirstName{Space}LastName. For Example :- Alvaro Morata
"""
address: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
country: Optional[str] = None
date_of_birth: Optional[str] = None
"""
DateOfBirth Format MMDDYYYY. For Example :- 05051960
"""
zip: Optional[str] = None
phone_number: Optional[str] = None
funding_source: Optional[FundingSourceType] = None
class NetworkName(str, Enum):
DEFAULT = 'Default'
NYCE = 'NYCE'
C_U24 = 'CU24'
XCEL = 'XCEL'
STAR = 'STAR'
PULS = 'PULS'
SHZM = 'SHZM'
VISA = 'VISA'
MAST = 'MAST'
DISC = 'DISC'
AMEX = 'AMEX'
ALIP = 'ALIP'
UPIN = 'UPIN'
STAC = 'STAC'
STNE = 'STNE'
MAES = 'MAES'
INTL = 'INTL'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReceiverInfo:
reference_number: Optional[str] = None
account_number: Optional[str] = None
name: Optional[str] = None
"""
Name Format FirstName{Space}LastName. For Example :- Alvaro Morata
"""
address: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
country: Optional[str] = None
zip: Optional[str] = None
phone_number: Optional[str] = None
class BillPayGroup(str, Enum):
DEFAULT = 'Default'
SINGLE = 'Single'
RECURRING = 'Recurring'
INSTALLMENT = 'Installment'
DEFERRED = 'Deferred'
class DigitalWalletInfo(str, Enum):
DEFAULT = 'Default'
STAGED = 'Staged'
PASSTHROUGH = 'Passthrough'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WalletDescriptor:
type: Optional[str] = None
encrypted_data: Optional[str] = None
application_data_hash: Optional[str] = None
ephemeral_public_key: Optional[str] = None
public_key_hash: Optional[str] = None
transaction_id: Optional[str] = None
signature: Optional[str] = None
version: Optional[str] = None
application_data: Optional[str] = None
merchant_identifier: Optional[str] = None
special_payment: Optional[str] = None
digital_wallet_indicator: Optional[DigitalWalletInfo] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SecureDescriptor:
cavv: Optional[str] = None
secure_transaction_id: Optional[str] = None
class TaxIndicator(str, Enum):
DEFAULT = 'Default'
NO_TAX_INFO_PROVIDED = 'NoTaxInfoProvided'
TAX_INFO_PROVIDED = 'TaxInfoProvided'
TAX_EXEMPT_ITEM = 'TaxExemptItem'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Level2Descriptor:
tax_details: Optional[TaxIndicator] = None
merchant_reference_number: Optional[str] = None
merchant_tax_id: Optional[str] = None
order_number: Optional[str] = None
tax_amount: int = 0
destination_postal_code: Optional[str] = None
product_description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentFacilitatorDescriptor:
payment_facilitator_indicator: Optional[str] = None
pf_phone_number: Optional[str] = None
sub_merch_i_d: Optional[str] = None
seller_i_d: Optional[str] = None
class TokenTypes(str, Enum):
DEFAULT = 'Default'
UCAF = 'UCAF'
DSRP = 'DSRP'
UCAFDSRP = 'UCAFDSRP'
VISA_VERIFIED = 'VisaVerified'
DIGITAL_WALLET = 'DigitalWallet'
VISA_VERIFIED_DIGITAL_WALLET = 'VisaVerifiedDigitalWallet'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TokenDescriptor:
token_type: Optional[TokenTypes] = None
token_cryptogram_data1: Optional[str] = None
token_cryptogram_data2: Optional[str] = None
class CardonFileInfo(str, Enum):
DEFAULT = 'Default'
SUPPORTED = 'Supported'
NOT_SUPPORTED = 'NotSupported'
class StoredCredentialIndicatorInfo(str, Enum):
DEFAULT = 'Default'
INITIAL = 'Initial'
SUBSEQUENT = 'Subsequent'
class TransactionInitiateInfo(str, Enum):
DEFAULT = 'Default'
MERCHANT = 'Merchant'
TERMINAL = 'Terminal'
CUSTOMER = 'Customer'
class ScheduleIndicatorInfo(str, Enum):
DEFAULT = 'Default'
SCHEDULED = 'Scheduled'
UNSCHEDULED = 'Unscheduled'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CardonFileIndicatorDescriptor:
cardon_file: Optional[CardonFileInfo] = None
stored_credential_indicator: Optional[StoredCredentialIndicatorInfo] = None
transaction_initiate: Optional[TransactionInitiateInfo] = None
schedule_indicator: Optional[ScheduleIndicatorInfo] = None
network_transaction_id: Optional[str] = None
class CardAccountUpdaterInfo(str, Enum):
DEFAULT = 'Default'
SUPPORTED = 'Supported'
NOT_SUPPORTED = 'NotSupported'
class OrderTypeInfo(str, Enum):
DEFAULT = 'Default'
STANDING = 'Standing'
SUBSCRIPTION = 'Subscription'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillPayGroupIndicator:
mit_total_payment_count: Optional[str] = None
mit_amount_type: Optional[str] = None
mit_amount: Optional[str] = None
mit_unique_i_d: Optional[str] = None
mit_frequency: Optional[str] = None
mit_validation_flag: Optional[str] = None
mit_validation_reference: Optional[str] = None
mit_sequence_indicator: Optional[str] = None
class ChargeTypeInfo(str, Enum):
DEFAULT = 'Default'
PARTIAL_SHIPMENT = 'PartialShipment'
DELAYED = 'Delayed'
NO_SHOW = 'NoShow'
RESUBMISSION = 'Resubmission'
class SAFEligibleFlag(str, Enum):
DEFAULT = 'Default'
TRUE = 'True'
FALSE = 'False'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExtendedData:
track2_data_for_e_m_v_transaction: Optional[str] = None
sender_info: Optional[SenderInfo] = None
cashback_amount: int = 0
network: Optional[NetworkName] = None
receiver_info: Optional[ReceiverInfo] = None
bill_pay_group: Optional[BillPayGroup] = None
wallet_data: Optional[WalletDescriptor] = None
secure_data: Optional[SecureDescriptor] = None
level2_data: Optional[Level2Descriptor] = None
payment_facilitator_data: Optional[PaymentFacilitatorDescriptor] = None
token_data: Optional[TokenDescriptor] = None
otp_tran_id: Optional[str] = None
current_shipment: int = 0
total_shipments: int = 0
is_token_requested: bool = False
cardon_file_indicator: Optional[CardonFileIndicatorDescriptor] = None
card_account_updater: Optional[CardAccountUpdaterInfo] = None
retry_attempt_count: int = 0
total_auth_amount: int = 0
signature_hash_version: Optional[str] = None
order_type_detail: Optional[OrderTypeInfo] = None
bill_pay_group_indicator: Optional[BillPayGroupIndicator] = None
charge_type_detail: Optional[ChargeTypeInfo] = None
saf_eligible: Optional[SAFEligibleFlag] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class POSCardlessDebitRequest:
credentials: Optional[RequestorCredentials] = None
reference_key: Optional[str] = None
payment_info: Optional[PaymentInfo] = None
amount: int = 0
currency_code: Optional[str] = None
tid: Optional[str] = None
mid: Optional[str] = None
network_request_data: Optional[NetworkRequestData] = None
local_date: Optional[str] = None
"""
Local Date Format mmddyyyy. For Example:- 01202017
"""
local_time: Optional[str] = None
"""
Local Time Format HHmmss. For Example :- 012322
"""
merchant_details: Optional[MerchantDescriptor] = 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[ExtendedData] = None
Python POSCardlessDebitRequest 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 /POSCardlessDebit HTTP/1.1
Host: api.paysecure.acculynk.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<POSCardlessDebitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<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>
<BillPayGroup>Default</BillPayGroup>
<BillPayGroupIndicator>
<MITAmount>String</MITAmount>
<MITAmountType>String</MITAmountType>
<MITFrequency>String</MITFrequency>
<MITSequenceIndicator>String</MITSequenceIndicator>
<MITTotalPaymentCount>String</MITTotalPaymentCount>
<MITUniqueID>String</MITUniqueID>
<MITValidationFlag>String</MITValidationFlag>
<MITValidationReference>String</MITValidationReference>
</BillPayGroupIndicator>
<CardAccountUpdater>Default</CardAccountUpdater>
<CardonFileIndicator>
<CardonFile>Default</CardonFile>
<NetworkTransactionId>String</NetworkTransactionId>
<ScheduleIndicator>Default</ScheduleIndicator>
<StoredCredentialIndicator>Default</StoredCredentialIndicator>
<TransactionInitiate>Default</TransactionInitiate>
</CardonFileIndicator>
<CashbackAmount>0</CashbackAmount>
<ChargeTypeDetail>Default</ChargeTypeDetail>
<CurrentShipment>0</CurrentShipment>
<IsTokenRequested>false</IsTokenRequested>
<Level2Data>
<DestinationPostalCode>String</DestinationPostalCode>
<MerchantReferenceNumber>String</MerchantReferenceNumber>
<MerchantTaxId>String</MerchantTaxId>
<OrderNumber>String</OrderNumber>
<ProductDescription>String</ProductDescription>
<TaxAmount>0</TaxAmount>
<TaxDetails>Default</TaxDetails>
</Level2Data>
<Network>Default</Network>
<OTPTranId>String</OTPTranId>
<OrderTypeDetail>Default</OrderTypeDetail>
<PaymentFacilitatorData>
<PFPhoneNumber>String</PFPhoneNumber>
<PaymentFacilitatorIndicator>String</PaymentFacilitatorIndicator>
<SellerID>String</SellerID>
<SubMerchID>String</SubMerchID>
</PaymentFacilitatorData>
<ReceiverInfo>
<AccountNumber>String</AccountNumber>
<Address>String</Address>
<City>String</City>
<Country>String</Country>
<Name>String</Name>
<PhoneNumber>String</PhoneNumber>
<ReferenceNumber>String</ReferenceNumber>
<State>String</State>
<Zip>String</Zip>
</ReceiverInfo>
<RetryAttemptCount>0</RetryAttemptCount>
<SAFEligible>Default</SAFEligible>
<SecureData>
<CAVV>String</CAVV>
<SecureTransactionId>String</SecureTransactionId>
</SecureData>
<SenderInfo>
<AccountNumber>String</AccountNumber>
<Address>String</Address>
<City>String</City>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<FundingSource>DepositAccount</FundingSource>
<Name>String</Name>
<PhoneNumber>String</PhoneNumber>
<ReferenceNumber>String</ReferenceNumber>
<State>String</State>
<Zip>String</Zip>
</SenderInfo>
<SignatureHashVersion>String</SignatureHashVersion>
<TokenData>
<TokenCryptogramData1>String</TokenCryptogramData1>
<TokenCryptogramData2>String</TokenCryptogramData2>
<TokenType>Default</TokenType>
</TokenData>
<TotalAuthAmount>0</TotalAuthAmount>
<TotalShipments>0</TotalShipments>
<Track2DataForEMVTransaction>String</Track2DataForEMVTransaction>
<WalletData>
<ApplicationData>String</ApplicationData>
<ApplicationDataHash>String</ApplicationDataHash>
<DigitalWalletIndicator>Default</DigitalWalletIndicator>
<EncryptedData>String</EncryptedData>
<EphemeralPublicKey>String</EphemeralPublicKey>
<MerchantIdentifier>String</MerchantIdentifier>
<PublicKeyHash>String</PublicKeyHash>
<Signature>String</Signature>
<SpecialPayment>String</SpecialPayment>
<TransactionId>String</TransactionId>
<Type>String</Type>
<Version>String</Version>
</WalletData>
</ExtendedData>
<LocalDate>String</LocalDate>
<LocalTime>String</LocalTime>
<MID>String</MID>
<MerchantDetails>
<DataElements>
<RefundSettlementTypeDetails>0</RefundSettlementTypeDetails>
<SendRecurringPOSEntryModeFeature>false</SendRecurringPOSEntryModeFeature>
<UseOrgPOSCode>false</UseOrgPOSCode>
</DataElements>
<Address>String</Address>
<City>String</City>
<Country>String</Country>
<CustomerServiceNumber>String</CustomerServiceNumber>
<Email>String</Email>
<FNSnum>String</FNSnum>
<MCC>String</MCC>
<Name>String</Name>
<State>String</State>
<Zip>String</Zip>
</MerchantDetails>
<NetworkRequestData>
<AliPayPartnerId>String</AliPayPartnerId>
<OrderDetail>String</OrderDetail>
<OrderNumber>String</OrderNumber>
<OrderTitle>String</OrderTitle>
<TerminalIP>String</TerminalIP>
<WebHookURL>String</WebHookURL>
</NetworkRequestData>
<PaymentInfo>
<PaymentData>String</PaymentData>
<PaymentDataType>BarCode</PaymentDataType>
<PaymentNetwork>AliPay</PaymentNetwork>
</PaymentInfo>
<ReferenceKey>String</ReferenceKey>
<SignatureHash>String</SignatureHash>
<TID>String</TID>
</POSCardlessDebitRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<POSCardlessDebit 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>
<ApprovedAmount>0</ApprovedAmount>
<ErrorCode>String</ErrorCode>
<ErrorMessage>String</ErrorMessage>
<Network>String</Network>
<NetworkResponseData>
<AliPayTransId>String</AliPayTransId>
<AliPayTransactionTime>String</AliPayTransactionTime>
<ResponseCode>String</ResponseCode>
<WeChatPayOpenId>String</WeChatPayOpenId>
<WeChatPayTransId>String</WeChatPayTransId>
<WeChatPayTransactionTime>String</WeChatPayTransactionTime>
</NetworkResponseData>
<ResponseCode>String</ResponseCode>
<TranId>String</TranId>
</POSCardlessDebit>