EPoint sorğu cavabı schema-ları¶
Main¶
integrify.epoint.schemas.response.MinimalResponseSchema
pydantic-model
¶
integrify.epoint.schemas.response.BaseResponseSchema
pydantic-model
¶
Bases: MinimalResponseSchema
Fields:
-
status(TransactionStatus) -
message(str | None) -
transaction(str | None) -
bank_transaction(str | None) -
bank_response(str | None) -
operation_code(str | None) -
rrn(str | None) -
card_mask(str | None) -
card_name(str | None) -
amount(Decimal | None)
transaction = None
pydantic-field
¶
EPoint xidmətinin əməliyyat IDsi
bank_transaction = None
pydantic-field
¶
Bank ödəniş əməliyyatı IDsi
bank_response = None
pydantic-field
¶
Ödəniş icrasının nəticəsi ilə bankın cavabı
operation_code = None
pydantic-field
¶
001-kart qeydiyyatı 100- istifadəçi ödənişi
rrn = None
pydantic-field
¶
Retrieval Reference Number - unikal əməliyyat identifikatoru. Yalnız uğurlu bir əməliyyat üçün mövcuddur
card_mask = None
pydantic-field
¶
Ödəniş səhifəsində göstərilən istifadəçi adı
card_name = None
pydantic-field
¶
123456**1234 formatında əks edilən kart maskası
amount = None
pydantic-field
¶
Ödəniş məbləği
status
pydantic-field
¶
Success və ya failed əməliyyatının nəticəsi
message = None
pydantic-field
¶
Ödənişin icra statusu haqqında mesaj
integrify.epoint.schemas.response.RedirectUrlResponseSchema
pydantic-model
¶
Bases: MinimalResponseSchema
Fields:
-
status(TransactionStatus) -
message(str | None) -
transaction(str | None) -
redirect_url(str | None)
transaction = None
pydantic-field
¶
EPoint xidmətinin əməliyyat IDsi
redirect_url = None
pydantic-field
¶
İstifadəçinin kart məlumatlarını daxil etmək üçün yönləndirilməsi lazım olan URL
status
pydantic-field
¶
Success və ya failed əməliyyatının nəticəsi
message = None
pydantic-field
¶
Ödənişin icra statusu haqqında mesaj
integrify.epoint.schemas.response.RedirectUrlWithCardIdResponseSchema
pydantic-model
¶
Bases: RedirectUrlResponseSchema
Fields:
-
status(TransactionStatus) -
message(str | None) -
transaction(str | None) -
redirect_url(str | None) -
card_id(str | None)
card_id = None
pydantic-field
¶
Ödənişləri yerinə yetirmək üçün istifadə edilməsi lazım olan unikal kart identifikatoru
status
pydantic-field
¶
Success və ya failed əməliyyatının nəticəsi
message = None
pydantic-field
¶
Ödənişin icra statusu haqqında mesaj
transaction = None
pydantic-field
¶
EPoint xidmətinin əməliyyat IDsi
redirect_url = None
pydantic-field
¶
İstifadəçinin kart məlumatlarını daxil etmək üçün yönləndirilməsi lazım olan URL
integrify.epoint.schemas.response.PaymentSchema
pydantic-model
¶
Bases: BaseWithCodeSchema
Fields:
-
status(TransactionStatus) -
message(str | None) -
transaction(str | None) -
bank_transaction(str | None) -
bank_response(str | None) -
operation_code(str | None) -
rrn(str | None) -
card_mask(str | None) -
card_name(str | None) -
amount(Decimal | None) -
code(str | None) -
order_id(str) -
other_attr(str | None)
order_id
pydantic-field
¶
Tətbiqinizdə unikal əməliyyat ID
other_attr = None
pydantic-field
¶
Əlavə göndərdiyiniz seçimlər
status
pydantic-field
¶
Success və ya failed əməliyyatının nəticəsi
message = None
pydantic-field
¶
Ödənişin icra statusu haqqında mesaj
transaction = None
pydantic-field
¶
EPoint xidmətinin əməliyyat IDsi
bank_transaction = None
pydantic-field
¶
Bank ödəniş əməliyyatı IDsi
bank_response = None
pydantic-field
¶
Ödəniş icrasının nəticəsi ilə bankın cavabı
operation_code = None
pydantic-field
¶
001-kart qeydiyyatı 100- istifadəçi ödənişi
rrn = None
pydantic-field
¶
Retrieval Reference Number - unikal əməliyyat identifikatoru. Yalnız uğurlu bir əməliyyat üçün mövcuddur
card_mask = None
pydantic-field
¶
Ödəniş səhifəsində göstərilən istifadəçi adı
card_name = None
pydantic-field
¶
123456**1234 formatında əks edilən kart maskası
amount = None
pydantic-field
¶
Ödəniş məbləği
code = None
pydantic-field
¶
Bankın 3 rəqəmli cavab kodu.
code_to_msg(v=None)
classmethod
¶
3 rəqəmli koddan, xəta/uğur mesajına çevrilir.
Kod Code lüğətində yoxdursa (bank yeni/naməlum kod qaytara bilər),
KeyError atmaq əvəzinə orijinal kod qaytarılır ki, cavab parse-i crash olmasın.
integrify.epoint.schemas.response.TransactionStatusResponseSchema
pydantic-model
¶
Bases: BaseWithCodeSchema
Fields:
-
message(str | None) -
transaction(str | None) -
bank_transaction(str | None) -
bank_response(str | None) -
operation_code(str | None) -
rrn(str | None) -
card_mask(str | None) -
card_name(str | None) -
amount(Decimal | None) -
code(str | None) -
status(TransactionStatusExtended) -
order_id(str | None) -
other_attr(str | None)
status
pydantic-field
¶
Tranzaksiyanın detallı statusu
order_id = None
pydantic-field
¶
Tətbiqinizdə unikal əməliyyat ID
other_attr = None
pydantic-field
¶
Əlavə göndərdiyiniz seçimlər
message = None
pydantic-field
¶
Ödənişin icra statusu haqqında mesaj
transaction = None
pydantic-field
¶
EPoint xidmətinin əməliyyat IDsi
bank_transaction = None
pydantic-field
¶
Bank ödəniş əməliyyatı IDsi
bank_response = None
pydantic-field
¶
Ödəniş icrasının nəticəsi ilə bankın cavabı
operation_code = None
pydantic-field
¶
001-kart qeydiyyatı 100- istifadəçi ödənişi
rrn = None
pydantic-field
¶
Retrieval Reference Number - unikal əməliyyat identifikatoru. Yalnız uğurlu bir əməliyyat üçün mövcuddur
card_mask = None
pydantic-field
¶
Ödəniş səhifəsində göstərilən istifadəçi adı
card_name = None
pydantic-field
¶
123456**1234 formatında əks edilən kart maskası
amount = None
pydantic-field
¶
Ödəniş məbləği
code = None
pydantic-field
¶
Bankın 3 rəqəmli cavab kodu.
code_to_msg(v=None)
classmethod
¶
3 rəqəmli koddan, xəta/uğur mesajına çevrilir.
Kod Code lüğətində yoxdursa (bank yeni/naməlum kod qaytara bilər),
KeyError atmaq əvəzinə orijinal kod qaytarılır ki, cavab parse-i crash olmasın.
integrify.epoint.schemas.response.SplitPayWithSavedCardResponseSchema
pydantic-model
¶
Bases: BaseResponseSchema
Fields:
-
status(TransactionStatus) -
message(str | None) -
transaction(str | None) -
bank_transaction(str | None) -
bank_response(str | None) -
operation_code(str | None) -
rrn(str | None) -
card_mask(str | None) -
card_name(str | None) -
amount(Decimal | None) -
split_amount(Decimal | None)
split_amount = None
pydantic-field
¶
İkinci istifadəçi üçün ödəniş məbləği.
status
pydantic-field
¶
Success və ya failed əməliyyatının nəticəsi
message = None
pydantic-field
¶
Ödənişin icra statusu haqqında mesaj
transaction = None
pydantic-field
¶
EPoint xidmətinin əməliyyat IDsi
bank_transaction = None
pydantic-field
¶
Bank ödəniş əməliyyatı IDsi
bank_response = None
pydantic-field
¶
Ödəniş icrasının nəticəsi ilə bankın cavabı
operation_code = None
pydantic-field
¶
001-kart qeydiyyatı 100- istifadəçi ödənişi
rrn = None
pydantic-field
¶
Retrieval Reference Number - unikal əməliyyat identifikatoru. Yalnız uğurlu bir əməliyyat üçün mövcuddur
card_mask = None
pydantic-field
¶
Ödəniş səhifəsində göstərilən istifadəçi adı
card_name = None
pydantic-field
¶
123456**1234 formatında əks edilən kart maskası
amount = None
pydantic-field
¶
Ödəniş məbləği
Apple Pay & Google Pay¶
integrify.epoint.schemas.response.WidgetResponseSchema
pydantic-model
¶
Bases: BaseModel
/api/1/token/widget sorğusunun cavabı
Fields:
-
status(str) -
message(str | None) -
widget_url(str | None)
integrify.epoint.schemas.response.TokenPaymentResponseSchema
pydantic-model
¶
Bases: BaseModel
/api/1/token/payment sorğusunun cavabı: EPoint-də yaradılmış token ödənişi.
Bu obyekt frontend-də initTokenPay-ə payment parametri kimi ötürülür.
Fields:
-
status(str | None) -
message(str | None) -
id(int | None) -
transaction(str | None) -
rrn(str | None) -
short_link(str | None) -
bank_order_id(str | None) -
total(Decimal | None) -
card_name(str | None) -
card_mask(str | None) -
description(str | None) -
merchant_order_id(str | None) -
other_attr(Any) -
created_at(datetime | None) -
updated_at(datetime | None)
status = None
pydantic-field
¶
Xəta baş verdikdə, əməliyyatın statusu
message = None
pydantic-field
¶
Xəta baş verdikdə, xəta mesajı
id = None
pydantic-field
¶
Token ödənişinin EPoint-dəki IDsi. Apple/Google Pay sorğularında istifadə olunur.
transaction = None
pydantic-field
¶
EPoint xidmətinin əməliyyat IDsi
rrn = None
pydantic-field
¶
Retrieval Reference Number - unikal əməliyyat identifikatoru
short_link = None
pydantic-field
¶
Ödənişin qısa linki
bank_order_id = None
pydantic-field
¶
Bank tərəfindəki sifariş IDsi
total = None
pydantic-field
¶
Ödənişin yekun məbləği
card_name = None
pydantic-field
¶
Ödəniş səhifəsində göstərilən istifadəçi adı
card_mask = None
pydantic-field
¶
123456**1234 formatında əks edilən kart maskası
description = None
pydantic-field
¶
Ödənişin təsviri
merchant_order_id = None
pydantic-field
¶
Tətbiqinizdə unikal əməliyyat ID (sorğuda göndərdiyiniz order_id)
other_attr = None
pydantic-field
¶
Əlavə göndərdiyiniz seçimlər
created_at = None
pydantic-field
¶
Ödənişin yaradılma tarixi
updated_at = None
pydantic-field
¶
Ödənişin son yenilənmə tarixi
integrify.epoint.schemas.response.TokenPayResponseSchema
pydantic-model
¶
Bases: BaseModel
Apple Pay/Google Pay ödənişinin tamamlanması sorğusunun cavabı
Fields:
-
status(str) -
message(str | None) -
result(Any) -
redirect_url(str | None)
status
pydantic-field
¶
Əməliyyatın nəticəsi. Uğurlu olduqda: success
message = None
pydantic-field
¶
Ödənişin icra statusu haqqında mesaj
result = None
pydantic-field
¶
Ödəniş provayderindən (PSP) gələn cavab
redirect_url = None
pydantic-field
¶
Yönləndirmə URL-i (məs., 3DS üçün). Hər zaman gəlmir.
Extra¶
integrify.epoint.schemas.response.BaseWithCodeSchema
pydantic-model
¶
Bases: BaseResponseSchema
Fields:
-
status(TransactionStatus) -
message(str | None) -
transaction(str | None) -
bank_transaction(str | None) -
bank_response(str | None) -
operation_code(str | None) -
rrn(str | None) -
card_mask(str | None) -
card_name(str | None) -
amount(Decimal | None) -
code(str | None)
code = None
pydantic-field
¶
Bankın 3 rəqəmli cavab kodu.
status
pydantic-field
¶
Success və ya failed əməliyyatının nəticəsi
message = None
pydantic-field
¶
Ödənişin icra statusu haqqında mesaj
transaction = None
pydantic-field
¶
EPoint xidmətinin əməliyyat IDsi
bank_transaction = None
pydantic-field
¶
Bank ödəniş əməliyyatı IDsi
bank_response = None
pydantic-field
¶
Ödəniş icrasının nəticəsi ilə bankın cavabı
operation_code = None
pydantic-field
¶
001-kart qeydiyyatı 100- istifadəçi ödənişi
rrn = None
pydantic-field
¶
Retrieval Reference Number - unikal əməliyyat identifikatoru. Yalnız uğurlu bir əməliyyat üçün mövcuddur
card_mask = None
pydantic-field
¶
Ödəniş səhifəsində göstərilən istifadəçi adı
card_name = None
pydantic-field
¶
123456**1234 formatında əks edilən kart maskası
amount = None
pydantic-field
¶
Ödəniş məbləği
code_to_msg(v=None)
classmethod
¶
3 rəqəmli koddan, xəta/uğur mesajına çevrilir.
Kod Code lüğətində yoxdursa (bank yeni/naməlum kod qaytara bilər),
KeyError atmaq əvəzinə orijinal kod qaytarılır ki, cavab parse-i crash olmasın.