Skip to main content

თანხის დაბრუნება

View as Markdown

ამ მეთოდის საშუალებით ბიზნესს შეუძლია სრულად ან ნაწილობრივ დააბრუნოს შეკვეთისას გადახდილი თანხა. ბარათით, Apple Pay-ით, Google Pay-ით, BOG ავტორიზაციითა და ქულებით შესრულებული გადახდების უკან დაბრუნება შესაძლებელია როგორც სრულად, ისე ნაწილობრივ. ნაწილობრივი დაბრუნების მეთოდის გამოძახება დასაშვებია მანამ, სანამ გადახდილი თანხა სრულად არ დაბრუნდება.

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-ს პარამეტრები​

amountoptionalnumber

დასაბრუნებელი თანხა. გადმოცემა აუცილებელია, თუ თანხა ბრუნდება ნაწილობრივად. პარამეტრის არ გადმოცემის შემთხვევაში, თანხა სრულად დაბრუნდება. მნიშვნელობა არ შეიძლება იყოს დამუშავებულ თანხაზე (transfer_amount) მეტი.
curl -X POST 'https://api.bog.ge/payments/v1/payment/refund/:order_id' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "amount": "10.5"
}'

Response​

keystring

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

messagestring

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

action_idstring

ქმედების იდენტიფიკატორი.
{
    "key": "request_received",
    "message": "Refund request received",
    "action_id": "5b666901-eb05-4f83-abeb-8311e175f337"
}