პრეავტორიზაციის უარყოფა

სრული თანხის უარყოფის მეთოდი

Header-ის პარამეტრები

Content-Typerequiredapplication/json

AuthorizationrequiredBasic <base64>

გადაეცემა Bearer <jwt_token> მნიშვნელობა, სადაც jwt_token არის აუტენტიფიკაციის მეთოდის Response-ის access_token პარამეტრში დაბრუნებული მნიშვნელობა.

Idempotency-KeyoptionalUUID v4

Idempotency-Key პარამეტრი უნდა იყოს უნიკალური ყველა ახალი API რექვესთისთვის. იმავე API-ზე Idempotency-Key-ის განმეორებით გამოყენებისას სერვერი დააბრუნებს იმავე სტატუს კოდსა და body-ს, რაც თავდაპირველი მოთხოვნისას. ეს ფუნქცია განსაკუთრებით სასარგებლოა თანმიმდევრული შედეგის უზრუნველსაყოფად, როდესაც საქმე გვაქვს ქსელური პრობლემებითა ან ხელახალი ცდებით გამოწვეულ დუბლირებულ მოთხოვნებთან.

Path პარამეტრები

order_idrequiredstring

შეკვეთის იდენტიფიკატორი, რომელიც ონლაინ მაღაზიას უბრუნდება შეკვეთის მოთხოვნის Response-ში.

Body-ს პარამეტრები

descriptionoptionalstring

უარყოფის მიზეზი.

CURL

curl -X POST 'https://api.bog.ge/payments/v1/payment/authorization/cancel/:order_id' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
--data-raw '{
"description": "string"
}'

Response

keystring

API მოთხოვნის სტატუსის იდენტიფიკატორი.

messagestring

API მოთხოვნის სტატუსის აღწერა.

action_idstring

ქმედების იდენტიფიკატორი.

RESPONSE

{
    "key": "request_received",
    "message": "Pre-authorization payment cancellation request received",
    "action_id": "aa9478c7-f82f-45a9-8a30-e7b4275b1224"
}