API Referansı

Note

İstifadəsi göstərilən bütün sorğular sinxrondur. Asinxron versiyasaları istifadə etmək üçün bu importu edin və eyni-adlı funksiyaları await ilə çağırın:

from integrify.epoint.asyncio import EPointRequest

integrify.epoint.sync.EPointRequest module-attribute

EPointRequest = _EPointRequest()

Note

Bu artıq hazır yaradılmış klass obyektidir, birbaşa istifadə üçün nəzərdə tutulub. Əks halda bütün sorğuları _EPointRequest().save_card() kimi istifadə etməlisiniz.

integrify.epoint.sync._EPointRequest

_EPointRequest()

Bases: SyncApiRequest

EPoint sorğular üçün baza class

pay

pay(amount, currency, order_id, description=None, **extra)

Ödəniş sorğusu (sync)

Endpoint: /api/1/request

Example

from integrify.epoint import EPointRequest

EPointRequest.pay(amount=100, currency='AZN', order_id='12345678', description='Ödəniş')

Cavab formatı: RedirectUrlResponseSchema

Bu sorğunu göndərdikdə, cavab olaraq redirect_url gəlir. Müştəri həmin URLə daxil olub, kart məlumatlarını daxil edib, uğurlu ödəniş etdikdən sonra, backend callback APIsinə (EPoint dashboard-ında qeyd etdiyiniz) sorğu daxil olur, və eyni order_id ilə DecodedCallbackDataSchema formatında məlumat gəlir.

PARAMETER	DESCRIPTION
amount	Ödəniş miqdarı. Numerik dəyər. TYPE: Decimal
currency	Ödəniş məzənnəsi. Mümkün dəyərlər: AZN TYPE: str
order_id	Unikal ID. Maksimal uzunluq: 255 simvol. TYPE: str
description	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: Optional[str] DEFAULT: None
**extra	Başqa ötürmək istədiyiniz əlavə dəyərlər. Bu dəyərlər callback sorğuda sizə geri göndərilir. TYPE: Any DEFAULT: {}

get_transaction_status

get_transaction_status(transaction_id)

Transaksiya statusunu öyrənmək üçün sorğu (sync)

Endpoint: /api/1/get-status

Example

from integrify.epoint import EPointRequest

EPointRequest.get_transaction_status(transaction_id='texxxxxx')

Cavab formatı: TransactionStatusResponseSchema

PARAMETER	DESCRIPTION
transaction_id	EPoint tərəfindən verilmiş tranzaksiya IDsi. Adətən te prefiksi ilə olur. TYPE: str

save_card

save_card()

Ödəniş olmadan kartı yadda saxlamaq sorğusu (sync)

Endpoint: /api/1/card-registration

Example

from integrify.epoint import EPointRequest

EPointRequest.save_card()

Cavab formatı: RedirectUrlWithCardIdResponseSchema

Bu sorğunu göndərdikdə, cavab olaraq redirect_url və card_id gəlir. Müştəri həmin URLə daxil olub, kart məlumatlarını uğurlu qeyd etdikdən sonra, backend callback APIsinə (EPoint dashboard-ında qeyd etdiyiniz) sorğu daxil olur, və eyni card_id ilə DecodedCallbackDataSchema formatında məlumat gəlir.

pay_with_saved_card

pay_with_saved_card(amount, currency, order_id, card_id)

Yadda saxlanılmış kartla ödəniş sorğusu (sync)

Endpoint: /api/1/execute-pay

Example

from integrify.epoint import EPointRequest

EPointRequest.pay_with_saved_card(amount=100, currency='AZN', order_id='12345678', card_id='cexxxxxx')

Cavab formatı: BaseResponseSchema

Bu sorğunu göndərdikdə, cavab olaraq BaseResponseSchema formatında cavab gəlir, və ödənişin statusu birbaşa qayıdır: heç bir callback sorğusu gəlmir.

PARAMETER	DESCRIPTION
amount	Ödəniş miqdarı. Numerik dəyər. TYPE: Decimal
currency	Ödəniş məzənnəsi. Mümkün dəyərlər: AZN TYPE: str
order_id	Unikal ID. Maksimal uzunluq: 255 simvol. TYPE: str
card_id	Saxlanılmış kartın id-si. Adətən ce prefiksi ilə başlayır. TYPE: str

pay_and_save_card

pay_and_save_card(amount, currency, order_id, description=None)

Ödəniş və kartı yadda saxlama sorğusu (sync)

Endpoint: /api/1/card-registration-with-pay

Example

from integrify.epoint import EPointRequest

EPointRequest.pay_and_save_card(amount=100, currency='AZN', order_id='12345678', description='Ödəniş')

Cavab formatı: RedirectUrlWithCardIdResponseSchema

Bu sorğunu göndərdikdə, cavab olaraq redirect_url və card_id gəlir. Müştəri həmin URLə daxil olub, kart məlumatlarını daxil edib, uğurlu ödəniş etdikdən sonra, backend callback APIsinə (EPoint dashboard-ında qeyd etdiyiniz) sorğu daxil olur, və eyni order_id və card_id ilə DecodedCallbackDataSchema formatında məlumat gəlir.

PARAMETER	DESCRIPTION
amount	Ödəniş miqdarı. Numerik dəyər. TYPE: Decimal
currency	Ödəniş məzənnəsi. Mümkün dəyərlər: AZN TYPE: str
order_id	Unikal ID. Maksimal uzunluq: 255 simvol. TYPE: str
description	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: Optional[str] DEFAULT: None

payout

payout(amount, currency, order_id, card_id, description=None)

Hesabınızda olan pulu karta nağdlaşdırmaq sorğusu (sync)

Endpoint: /api/1/refund-request

Example

from integrify.epoint import EPointRequest

EPointRequest.payout(amount=100, currency='AZN', order_id='12345678', description='Ödəniş')

Cavab sorğu formatı: BaseResponseSchema

Bu sorğunu göndərdikdə, əməliyyat Epoint xidməti tərəfindən işləndikdən və bankdan ödəniş statusu alındıqdan sonra cavab BaseResponseSchema formatında qayıdacaqdır

PARAMETER	DESCRIPTION
amount	Nağdlaşdırmaq miqdarı. Numerik dəyər. TYPE: Decimal
currency	Nağdlaşdırma məzənnəsi. Mümkün dəyərlər: AZN TYPE: str
order_id	Unikal ID. Maksimal uzunluq: 255 simvol. TYPE: str
card_id	Saxlanılmış kartın id-si. Adətən ce prefiksi ilə başlayır. TYPE: str
description	Nağdlaşdırmanın təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: Optional[str] DEFAULT: None

refund

refund(transaction_id, currency, amount=None)

Keçmiş ödənişi tam və ya yarımçıq geri qaytarma sorğusu (sync)

Endpoint: /api/1/reverse

Example

from integrify.epoint import EPointRequest

# Full refund
EPointRequest.refund(transaction_id='texxxxxx', currency='AZN')

# Partial refund
EPointRequest.refund(transaction_id='texxxxxx', currency='AZN', amount=50)

Cavab formatı: MinimalResponseSchema

Bu sorğunu göndərdikdə, cavab olaraq status və message gəlir. Heç bir callback sorğusu göndərilmir.

PARAMETER	DESCRIPTION
transaction_id	EPoint tərəfindən verilmiş tranzaksiya IDsi. Adətən te prefiksi ilə olur. TYPE: str
currency	Ödəniş məzənnəsi. Mümkün dəyərlər: AZN TYPE: str
amount	Ödəniş məbləği. Məbləğin göndərilməsi yarımçıq geri-qaytarma hesab olunur, əks halda tam geri-qaytarma baş verəcəkdir. TYPE: Optional[Decimal] DEFAULT: None

split_pay

split_pay(amount, currency, order_id, split_user_id, split_amount, description=None, **extra)

Ödənişi başqa EPoint istifadəçisi ilə bölüb ödəmə sorğusu (sync)

Endpoint: /api/1/split-request

Example

from integrify.epoint import EPointRequest

EPointRequest.split_pay(amount=100, currency='AZN', order_id='123456789', split_user_id='epoint_user_id', split_amount=50, description='split payment')

Cavab formatı: RedirectUrlResponseSchema

PARAMETER	DESCRIPTION
amount	Ödəniş miqdarı. Numerik dəyər. TYPE: Decimal
currency	Ödəniş məzənnəsi. Mümkün dəyərlər: AZN TYPE: str
order_id	Unikal ID. Maksimal uzunluq: 255 simvol. TYPE: str
split_user_id	Ödənişi böləcəyini EPoint user-ini IDsi TYPE: str
split_amount	Bölünən miqdar. Numerik dəyər TYPE: Decimal
description	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: Optional[str] DEFAULT: None
**extra	Başqa ötürmək istədiyiniz əlavə dəyərlər. Bu dəyərlər callback sorğuda sizə geri göndərilir. TYPE: Any DEFAULT: {}

split_pay_with_saved_card

split_pay_with_saved_card(amount, currency, order_id, card_id, split_user_id, split_amount, description=None)

Saxlanılmış kartla ödənişi başqa EPoint istifadəçisi ilə bölüb ödəmə sorğusu (sync)

Endpoint: /api/1/split-execute-pay

Example

from integrify.epoint import EPointRequest

EPointRequest.split_pay_with_saved_card(amount=100, currency='AZN', order_id='123456789', card_id='cexxxxxx', split_user_id='epoint_user_id', split_amount=50, description='split payment')

Cavab formatı: SplitPayWithSavedCardResponseSchema

PARAMETER	DESCRIPTION
amount	Ödəniş miqdarı. Numerik dəyər. TYPE: Decimal
currency	Ödəniş məzənnəsi. Mümkün dəyərlər: AZN TYPE: str
order_id	Unikal ID. Maksimal uzunluq: 255 simvol. TYPE: str
card_id	Saxlanılmış kartın id-si. Adətən ce prefiksi ilə başlayır. TYPE: str
split_user_id	Ödənişi böləcəyini EPoint user-ini IDsi TYPE: str
split_amount	Bölünən miqdar. Numerik dəyər TYPE: Decimal
description	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: Optional[str] DEFAULT: None

split_pay_and_save_card

split_pay_and_save_card(amount, currency, order_id, split_user_id, split_amount, description=None)

Ödənişi başqa EPoint istifadəçisi ilə bölüb ödəmə və kartı saxlama sorğusu (sync)

Endpoint: /api/1/split-card-registration-with-pay

Example

from integrify.epoint import EPointRequest

EPointRequest.split_pay_and_save_card(amount=100, currency='AZN', order_id='123456789', split_user_id='epoint_user_id', split_amount=50, description='split payment')

Cavab formatı: RedirectUrlWithCardIdResponseSchema

PARAMETER	DESCRIPTION
amount	Ödəniş miqdarı. Numerik dəyər. TYPE: Decimal
currency	Ödəniş məzənnəsi. Mümkün dəyərlər: AZN TYPE: str
order_id	Unikal ID. Maksimal uzunluq: 255 simvol. TYPE: str
split_user_id	Ödənişi böləcəyini EPoint user-ini IDsi TYPE: str
split_amount	Bölünən miqdar. Numerik dəyər TYPE: Decimal
description	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: Optional[str] DEFAULT: None