API Client¶

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.kapitalbank.client.KapitalRequest `module-attribute` ¶

KapitalRequest = KapitalClientClass(sync=True)

integrify.kapitalbank.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.kapitalbank.client.KapitalClientClass ¶

KapitalClientClass(
    name='Kapital',
    base_url=BASE_URL,
    default_handler=None,
    sync=True,
    dry=False,
)

Bases: APIClient, Generic[_Mode]

create_order ¶

create_order(
    amount: SupportsFloat,
    currency: str,
    description: Unset[str] = UNSET,
) -> APIResponse[
    BaseResponseSchema[CreateOrderResponseSchema]
]

create_order(
    amount: SupportsFloat,
    currency: str,
    description: Unset[str] = UNSET,
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[CreateOrderResponseSchema]
    ],
]

create_order(*args, **kwds)

get_order_information ¶

get_order_information(
    order_id: int,
) -> APIResponse[
    BaseResponseSchema[OrderInformationResponseSchema]
]

get_order_information(
    order_id: int,
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[OrderInformationResponseSchema]
    ],
]

get_order_information(*args, **kwds)

get_detailed_order_info ¶

get_detailed_order_info(
    order_id: int,
) -> APIResponse[
    BaseResponseSchema[
        DetailedOrderInformationResponseSchema
    ]
]

get_detailed_order_info(
    order_id: int,
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[
            DetailedOrderInformationResponseSchema
        ]
    ],
]

get_detailed_order_info(*args, **kwds)

refund_order ¶

refund_order(
    order_id: int, amount: SupportsFloat
) -> APIResponse[
    BaseResponseSchema[RefundOrderResponseSchema]
]

refund_order(
    order_id: int, amount: SupportsFloat
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[RefundOrderResponseSchema]
    ],
]

refund_order(*args, **kwds)

save_card ¶

save_card(
    amount: SupportsFloat,
    currency: str,
    description: Unset[str] = UNSET,
) -> APIResponse[
    BaseResponseSchema[CreateOrderResponseSchema]
]

save_card(
    amount: SupportsFloat,
    currency: str,
    description: Unset[str] = UNSET,
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[CreateOrderResponseSchema]
    ],
]

save_card(*args, **kwds)

pay_and_save_card ¶

pay_and_save_card(
    amount: SupportsFloat,
    currency: str,
    description: Unset[str] = UNSET,
) -> APIResponse[
    BaseResponseSchema[CreateOrderResponseSchema]
]

pay_and_save_card(
    amount: SupportsFloat,
    currency: str,
    description: Unset[str] = UNSET,
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[CreateOrderResponseSchema]
    ],
]

pay_and_save_card(*args, **kwds)

full_reverse_order ¶

full_reverse_order(
    order_id: int,
) -> APIResponse[
    BaseResponseSchema[FullReverseOrderResponseSchema]
]

full_reverse_order(
    order_id: int,
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[FullReverseOrderResponseSchema]
    ],
]

full_reverse_order(*args, **kwds)

clearing_order ¶

clearing_order(
    order_id: int, amount: SupportsFloat
) -> APIResponse[
    BaseResponseSchema[ClearingOrderResponseSchema]
]

clearing_order(
    order_id: int, amount: SupportsFloat
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[ClearingOrderResponseSchema]
    ],
]

clearing_order(*args, **kwds)

partial_reverse_order ¶

partial_reverse_order(
    order_id: int, amount: SupportsFloat
) -> APIResponse[
    BaseResponseSchema[PartialReverseOrderResponseSchema]
]

partial_reverse_order(
    order_id: int, amount: SupportsFloat
) -> Coroutine[
    Any,
    Any,
    APIResponse[
        BaseResponseSchema[
            PartialReverseOrderResponseSchema
        ]
    ],
]

partial_reverse_order(*args, **kwds)

pay_with_saved_card ¶

pay_with_saved_card(
    token, amount, currency, description=UNSET
)

Yadda saxlanmış kartdan ödəniş etmək üçün sorğu

Endpoint /api/order

Example:

from integrify.kapitalbank 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: `int`
`amount`	Ödəniş miqdarı. Numerik dəyər. TYPE: `SupportsFloat`
`currency`	Ödənişin məzənnəsi. Mümkün dəyərlər: `["AZN", "USD"]`. TYPE: `str`
`description`	Ödənişin təsviri. Maksimal uzunluq: 1000 simvol. Məcburi arqument deyil. TYPE: `Unset[str]` DEFAULT: `UNSET`