EPoint klientinin API Reference-i¶

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 import EPointAsyncRequest

integrify.epoint.client.EPointRequest `module-attribute` ¶

EPointRequest = EPointClientClass(sync=True)

integrify.epoint.client.EPointAsyncRequest `module-attribute` ¶

EPointAsyncRequest = EPointClientClass(sync=False)

Note

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

integrify.epoint.client.EPointClientClass ¶

EPointClientClass(name='EPoint', base_url=BASE_URL, default_handler=None, sync=True, dry=False)

Bases: APIClient

EPoint sorğular üçün baza class

pay ¶

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

Ödəniş sorğusu

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: `SupportsFloat`
`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: `Unsettable[str]` DEFAULT: `_UNSET`
`**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

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

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

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: `SupportsFloat`
`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)

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

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: `SupportsFloat`
`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: `str`

payout ¶

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

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

Endpoint: /api/1/refund-request

Example

from integrify.epoint import EPointRequest

EPointRequest.payout(amount=100, currency='AZN', order_id='12345678', card_id='cexxxxxx', 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: `SupportsFloat`
`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: `Unsettable[str]` DEFAULT: `_UNSET`

refund ¶

refund(transaction_id, currency, amount=_UNSET)

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

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: `Unsettable[SupportsFloat]` DEFAULT: `_UNSET`

split_pay ¶

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

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

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: `SupportsFloat`
`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: `SupportsFloat`
`description`	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: `Unsettable[str]` DEFAULT: `_UNSET`
`**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=_UNSET)

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

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: `SupportsFloat`
`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: `SupportsFloat`
`description`	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: `Unsettable[str]` DEFAULT: `_UNSET`

split_pay_and_save_card ¶

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

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

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: `SupportsFloat`
`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: `SupportsFloat`
`description`	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: `Unsettable[str]` DEFAULT: `_UNSET`

EPoint klientinin API Reference-i¶

integrify.epoint.client.EPointRequest module-attribute ¶

integrify.epoint.client.EPointAsyncRequest module-attribute ¶

integrify.epoint.client.EPointClientClass ¶

pay ¶

get_transaction_status ¶

save_card ¶

pay_with_saved_card ¶

pay_and_save_card ¶

payout ¶

refund ¶

split_pay ¶

split_pay_with_saved_card ¶

split_pay_and_save_card ¶

integrify.epoint.client.EPointRequest `module-attribute` ¶

integrify.epoint.client.EPointAsyncRequest `module-attribute` ¶