KapitalBank 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.kapital import KapitalAsyncRequest
integrify.kapital.client.KapitalRequest
module-attribute
¶
KapitalRequest = KapitalClientClass(sync=True)
integrify.kapital.client.KapitalAsyncRequest
module-attribute
¶
KapitalAsyncRequest = KapitalClientClass(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ı KapitalClientClass().save_card()
kimi istifadə etməlisiniz.
integrify.kapital.client.KapitalClientClass
¶
KapitalClientClass(sync=True)
Bases: APIClient
create_order
¶
create_order(amount, currency, description=None)
Ödəniş sorğusu
Endpoint /api/order
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.create_order(
amount=10.0,
currency="AZN",
description="Test payment",
)
Cavab formatı: BaseResponseSchema[CreateOrderResponseSchema]
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ə "{callback_url}/?ID={id}&STATUS={status}" formatında sorğusu göndərilir. Ödənişin
detallarını get_detailed_order_info() funksiyandan istifadə edərək əldə edə bilərsiz.
PARAMETER | DESCRIPTION |
---|---|
amount
|
Ödəniş miqdarı. Numerik dəyər.
TYPE:
|
currency
|
Ödənişin məzənnəsi. Mümkün dəyərlər:
TYPE:
|
description
|
Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil.
TYPE:
|
get_order_information
¶
get_order_information(order_id)
Ödəniş haqda qısa məlumat əldə etmək üçün sorğu
Endpoint /api/order/{order_id}
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.get_order_information(order_id=123456)
Cavab formatı: BaseResponseSchema[OrderInformationResponseSchema]
Bu sorğunu göndərdikdə, cavab olaraq ödəniş haqda qısa məlumat əldə edə bilərsiniz.
PARAMETER | DESCRIPTION |
---|---|
order_id
|
Ödənişin ID-si.
TYPE:
|
get_detailed_order_info
¶
get_detailed_order_info(order_id)
Ödəniş haqda detallı məlumat əldə etmək üçün sorğu
Endpoint /api/order/{order_id}?&tranDetailLevel=2&tokenDetailLevel=2&orderDetailLevel=2
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.get_detailed_order_info(order_id=123456)
Cavab formatı: BaseResponseSchema[DetailedOrderInformationResponseSchema]
Bu sorğunu göndərdikdə, cavab olaraq ödənişin detallı məlumat əldə edə bilərsiniz.
PARAMETER | DESCRIPTION |
---|---|
order_id
|
Ödənişin ID-si.
TYPE:
|
refund_order
¶
refund_order(order_id, amount)
Geri ödəniş sorğusu
Endpoint /api/order/{order_id}/exec-tran
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.refund_order(
order_id=123456,
amount=10.0,
)
Cavab formatı: BaseResponseSchema[RefundOrderResponseSchema]
Bu sorğu ilə əvvəlki ödənişi geri ödəmək üçün istifadə edə bilərsiniz. Cavab olaraq ödənişin detallarını əldə edə bilərsiniz.
PARAMETER | DESCRIPTION |
---|---|
order_id
|
Ödənişin ID-si.
TYPE:
|
amount
|
Geri ödəniş miqdarı. Numerik dəyər.
TYPE:
|
save_card
¶
save_card(amount, currency, description=None)
Kartı saxlamaq üçün ödəniş sorğusu
Endpoint /api/order
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.save_card(
amount=1.0,
currency="AZN",
description="Test payment",
)
Cavab formatı: BaseResponseSchema[CreateOrderResponseSchema]
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ə "{callback_url}/?ID={id}&STATUS={status}" formatında sorğusu göndərilir. Ödənişin
detallarını get_detailed_order_info() funksiyandan istifadə edərək əldə edə bilərsiz.
Həmin detallarda storedTokens key-i altındaki tokenləri saxlayaraq, sonrakı ödənişlərdə bu tokenləri
istifadə edə bilərsiniz.
response.body.data.stored_tokens[0].id
ilə tokeni əldə edə bilərsiniz.
pay_and_save_card
¶
pay_and_save_card(amount, currency, description=None)
Kartı saxlamaq və ödəniş etmək üçün ödəniş sorğusu
Endpoint /api/order
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.pay_and_save_card(
amount=1.0,
currency="AZN",
description="Test payment",
)
Cavab formatı: BaseResponseSchema[CreateOrderResponseSchema]
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ə "{callback_url}/?ID={id}&STATUS={status}" formatında sorğusu göndərilir. Ödənişin
detallarını get_detailed_order_info() funksiyandan istifadə edərək əldə edə bilərsiz.
Həmin detallarda storedTokens key-i altındaki tokenləri saxlayaraq, sonrakı ödənişlərdə bu tokenləri
istifadə edə bilərsiniz.
response.body.data.stored_tokens[0].id
ilə tokeni əldə edə bilərsiniz.
full_reverse_order
¶
full_reverse_order(order_id)
Ödənişi ləğv etmək üçün sorğu
Endpoint /api/order/{order_id}/exec-tran
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.full_reverse_order(order_id=123456)
Cavab formatı: BaseResponseSchema[FullReverseOrderResponseSchema]
Bu sorğunu göndərdikdə, cavab olaraq ödənişin ləğv edilməsi haqda məlumat əldə edə bilərsiniz. Bu funksiyani save_card() funksiyası ilə yaradılan ödənişlər üçün istifadə edə bilərsiniz. Kartın token-i saxladıqdan sonra həmin ödənişi qaytarmaq üçün istifade etmək olar.
PARAMETER | DESCRIPTION |
---|---|
order_id
|
Ödənişin ID-si.
TYPE:
|
clearing_order
¶
clearing_order(order_id, amount)
Ödənişin təsdiq edilməsi üçün sorğu
Endpoint /api/order/{order_id}/exec-tran
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.clearing_order(order_id=123456)
Cavab formatı: BaseResponseSchema[ClearingOrderResponseSchema]
Bu sorğunu göndərdikdə, cavab olaraq ödənişin təsdiq edilməsi haqda məlumat əldə edə bilərsiniz. Bu funksiyani save_card() funksiyası ilə yaradılan ödənişlər üçün istifadə edə bilərsiniz. Preauthorization əməliyyatının ikinci mərhələsi üçün.
PARAMETER | DESCRIPTION |
---|---|
order_id
|
Ödənişin ID-si.
TYPE:
|
partial_reverse_order
¶
partial_reverse_order(order_id, amount)
Ödənişin hissəsini ləğv etmək üçün sorğu
Endpoint /api/order/{order_id}/exec-tran
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.partial_reverse_order(order_id=123456, amount=5.0)
Cavab formatı: BaseResponseSchema[PartialReverseOrderResponseSchema]
Bu sorğunu göndərdikdə, cavab olaraq ödənişin ləğv edilməsi haqda məlumat əldə edə bilərsiniz. Bu funksiyani clearing_order() funksiyası ilə təsdiq edilmiş ödənişlər üçün istifadə edə bilərsiniz. İlkin məbləğdən az olan vəsaitləri qaytarmaq üçün istifadə olunur. Bir dəfə istifadə etmək olar.
PARAMETER | DESCRIPTION |
---|---|
order_id
|
Ödənişin ID-si.
TYPE:
|
amount
|
Ləğv olunacaq miqdar. Numerik dəyər.
TYPE:
|
pay_with_saved_card
¶
pay_with_saved_card(token, amount, currency, description=None)
Yadda saxlanmış kartdan ödəniş etmək üçün sorğu
Endpoint /api/order
Example:
from integrify.kapital import KapitalRequest
KapitalRequest.pay_with_saved_card(123456, 1.0, "AZN", "Test payment")
Cavab formatı: BaseResponseSchema[ProcessPaymentWithSavedCardResponseSchema]
Bu sorğunu göndərdikdə, cavab olaraq ödənişin təsdiq edilməsi haqda məlumat əldə edə bilərsiniz.
PARAMETER | DESCRIPTION |
---|---|
token
|
Kart tokeni.
TYPE:
|
amount
|
Ödəniş miqdarı. Numerik dəyər.
TYPE:
|
currency
|
Ödənişin məzənnəsi. Mümkün dəyərlər:
TYPE:
|
description
|
Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil.
TYPE:
|