Response Schemas¶
integrify.kapitalbank.schemas.response.ErrorResponseBodySchema
pydantic-model
¶
Bases: BaseSchema
Fields:
-
error_code(ErrorCode) -
error_description(str) -
error_details(Optional[dict])
integrify.kapitalbank.schemas.response.BaseResponseSchema
pydantic-model
¶
Bases: BaseSchema, Generic[_ResponseT]
Fields:
-
error(Optional[ErrorResponseBodySchema]) -
data(Optional[_ResponseT])
integrify.kapitalbank.schemas.response.CreateOrderResponseSchema
pydantic-model
¶
Bases: BaseSchema
Fields:
integrify.kapitalbank.schemas.response.OrderType
pydantic-model
¶
integrify.kapitalbank.schemas.response.OrderInformationResponseSchema
pydantic-model
¶
Bases: BaseSchema
Fields:
-
id(int) -
type_rid(str) -
status(TransactionStatus) -
last_status_login(str) -
amount(float) -
currency(str) -
create_time(str) -
type(OrderType)
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
id
pydantic-field
¶
type_rid
pydantic-field
¶
status
pydantic-field
¶
last_status_login
pydantic-field
¶
amount
pydantic-field
¶
currency
pydantic-field
¶
create_time
pydantic-field
¶
type
pydantic-field
¶
integrify.kapitalbank.schemas.response.StoredToken
pydantic-model
¶
integrify.kapitalbank.schemas.response.CardAuthentication
pydantic-model
¶
Bases: BaseSchema
Fields:
-
need_cvv2(bool) -
need_tds(bool) -
tran_id(Optional[str]) -
tds_ds_tran_id(Optional[str]) -
timestamp(Optional[datetime]) -
tds_protocol_ver(Optional[str]) -
eci(Optional[str]) -
tds_a_res(Optional[str])
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
need_cvv2
pydantic-field
¶
need_tds
pydantic-field
¶
tran_id = None
pydantic-field
¶
tds_ds_tran_id = None
pydantic-field
¶
timestamp = None
pydantic-field
¶
tds_protocol_ver = None
pydantic-field
¶
eci = None
pydantic-field
¶
tds_a_res = None
pydantic-field
¶
integrify.kapitalbank.schemas.response.CardDetails
pydantic-model
¶
Bases: BaseSchema
Fields:
-
authentication(Optional[CardAuthentication]) -
expiration(str) -
brand(str) -
issuer_rid(Optional[str])
integrify.kapitalbank.schemas.response.SrcToken
pydantic-model
¶
Bases: BaseSchema
Fields:
-
id(int) -
payment_method(str) -
role(str) -
status(str) -
reg_time(datetime) -
entry_mode(Optional[str]) -
display_name(str) -
card(CardDetails)
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
id
pydantic-field
¶
payment_method
pydantic-field
¶
role
pydantic-field
¶
status
pydantic-field
¶
reg_time
pydantic-field
¶
entry_mode = None
pydantic-field
¶
display_name
pydantic-field
¶
card
pydantic-field
¶
integrify.kapitalbank.schemas.response.ConsumerDeviceBrowser
pydantic-model
¶
Bases: BaseSchema
Fields:
-
user_agent(str) -
color_depth(int) -
pixel_ratio(float) -
language(str) -
tz_offset(int) -
local_storage(bool) -
language_replaced(bool) -
resolution_replaced(bool) -
os_replaced(bool) -
browser_replaced(bool) -
screen_w(int) -
screen_h(int) -
screen_avail_w(int) -
screen_avail_h(int) -
platform(str) -
accept_header(str) -
ip(str) -
ref_url(str) -
java_enabled(bool) -
js_enabled(bool)
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
user_agent
pydantic-field
¶
color_depth
pydantic-field
¶
pixel_ratio
pydantic-field
¶
language
pydantic-field
¶
tz_offset
pydantic-field
¶
local_storage
pydantic-field
¶
language_replaced
pydantic-field
¶
resolution_replaced
pydantic-field
¶
os_replaced
pydantic-field
¶
browser_replaced
pydantic-field
¶
screen_w
pydantic-field
¶
screen_h
pydantic-field
¶
screen_avail_w
pydantic-field
¶
screen_avail_h
pydantic-field
¶
platform
pydantic-field
¶
accept_header
pydantic-field
¶
ip
pydantic-field
¶
ref_url
pydantic-field
¶
java_enabled
pydantic-field
¶
js_enabled
pydantic-field
¶
integrify.kapitalbank.schemas.response.ConsumerDevice
pydantic-model
¶
Bases: BaseSchema
Fields:
integrify.kapitalbank.schemas.response.BusinessAddress
pydantic-model
¶
integrify.kapitalbank.schemas.response.Merchant
pydantic-model
¶
Bases: BaseSchema
Fields:
-
id(int) -
rid(str) -
title(str) -
business_address(BusinessAddress) -
trust_consumer_phone(bool)
integrify.kapitalbank.schemas.response.DetailedOrderType
pydantic-model
¶
Bases: BaseSchema
Fields:
-
allow_void(bool) -
hpp_tran_phase(str) -
secret_length(int) -
title(str) -
rid(str) -
payment_methods(list[str]) -
card_brands(Optional[list[str]]) -
allow_tds_attempt(bool) -
allow_tds_cant(bool) -
allow_tds_challenged(bool) -
allow_surcharge(bool) -
allow_tran_types(list[str]) -
allow_tran_phases(list[str]) -
allow_auth_kinds(list[str]) -
allow_cof_store_usages(list[str]) -
order_class(str) -
allow_cvv2(bool)
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
allow_void
pydantic-field
¶
hpp_tran_phase
pydantic-field
¶
secret_length
pydantic-field
¶
title
pydantic-field
¶
rid
pydantic-field
¶
payment_methods
pydantic-field
¶
card_brands = None
pydantic-field
¶
allow_tds_attempt
pydantic-field
¶
allow_tds_cant
pydantic-field
¶
allow_tds_challenged
pydantic-field
¶
allow_surcharge
pydantic-field
¶
allow_tran_types
pydantic-field
¶
allow_tran_phases
pydantic-field
¶
allow_auth_kinds
pydantic-field
¶
allow_cof_store_usages
pydantic-field
¶
order_class
pydantic-field
¶
allow_cvv2
pydantic-field
¶
integrify.kapitalbank.schemas.response.DetailedOrderInformationResponseSchema
pydantic-model
¶
Bases: BaseSchema
Fields:
-
id(int) -
hpp_url(str) -
hpp_redirect_url(Optional[str]) -
password(str) -
status(TransactionStatus) -
prev_status(Optional[str]) -
last_status_login(str) -
amount(float) -
currency(str) -
terminal(Dict) -
src_amount(float) -
src_amount_full(float) -
src_currency(str) -
dst_amount(Optional[float]) -
dst_currency(Optional[str]) -
stored_tokens(Optional[list[StoredToken]]) -
create_time(datetime) -
finish_time(Optional[datetime]) -
cvv2_auth_status(str) -
tds_v1_auth_status(Optional[str]) -
tds_v2_auth_status(Optional[str]) -
tds_server_url(Optional[str]) -
authorized_charge_amount(float) -
cleared_charge_amount(float) -
cleared_refund_amount(float) -
description(str) -
language(str) -
src_token(Optional[SrcToken]) -
consumer_device(Optional[ConsumerDevice]) -
merchant(Merchant) -
initiation_env_kind(str) -
type(DetailedOrderType) -
hpp_cof_capture_purposes(list[str]) -
cust_attrs(list[str]) -
report_pubs(Dict)
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
id
pydantic-field
¶
hpp_url
pydantic-field
¶
hpp_redirect_url = None
pydantic-field
¶
password
pydantic-field
¶
status
pydantic-field
¶
prev_status = None
pydantic-field
¶
last_status_login
pydantic-field
¶
amount
pydantic-field
¶
currency
pydantic-field
¶
terminal
pydantic-field
¶
src_amount
pydantic-field
¶
src_amount_full
pydantic-field
¶
src_currency
pydantic-field
¶
dst_amount = None
pydantic-field
¶
dst_currency = None
pydantic-field
¶
stored_tokens = None
pydantic-field
¶
create_time
pydantic-field
¶
finish_time = None
pydantic-field
¶
cvv2_auth_status
pydantic-field
¶
tds_v1_auth_status = None
pydantic-field
¶
tds_v2_auth_status = None
pydantic-field
¶
tds_server_url = None
pydantic-field
¶
authorized_charge_amount
pydantic-field
¶
cleared_charge_amount
pydantic-field
¶
cleared_refund_amount
pydantic-field
¶
description
pydantic-field
¶
language
pydantic-field
¶
src_token = None
pydantic-field
¶
consumer_device = None
pydantic-field
¶
merchant
pydantic-field
¶
initiation_env_kind
pydantic-field
¶
type
pydantic-field
¶
hpp_cof_capture_purposes
pydantic-field
¶
cust_attrs
pydantic-field
¶
report_pubs
pydantic-field
¶
integrify.kapitalbank.schemas.response.Match
pydantic-model
¶
integrify.kapitalbank.schemas.response.RefundOrderResponseSchema
pydantic-model
¶
Bases: FullReverseOrderResponseSchema
Fields:
-
match(Match) -
pmo_result_code(str) -
approval_code(str)
Validators:
integrify.kapitalbank.schemas.response.FullReverseOrderResponseSchema
pydantic-model
¶
integrify.kapitalbank.schemas.response.ClearingOrderResponseSchema
pydantic-model
¶
integrify.kapitalbank.schemas.response.PartialReverseOrderResponseSchema
pydantic-model
¶
integrify.kapitalbank.schemas.response.LinkCardTokenResponseSchema
pydantic-model
¶
Bases: BaseSchema
Fields:
-
status(str) -
cvv2_auth_status(str) -
tds_v1_auth_status(str) -
tds_v2_auth_status(str) -
otp_aut_status(str) -
src_token(SrcToken)
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
status
pydantic-field
¶
cvv2_auth_status
pydantic-field
¶
tds_v1_auth_status
pydantic-field
¶
tds_v2_auth_status
pydantic-field
¶
otp_aut_status
pydantic-field
¶
src_token
pydantic-field
¶
integrify.kapitalbank.schemas.response.ProcessPaymentWithSavedCardResponseSchema
pydantic-model
¶
Bases: RefundOrderResponseSchema
Fields:
-
match(Match) -
pmo_result_code(str) -
approval_code(str)
Validators: