შეკვეთის მოთხოვნა

მეთოდის საშუალებით, ბიზნესი ონლაინ გადახდის სერვერზე აგზავნის გადახდის დეტალებს, ტექნიკურ მახასიათებლებსა და გადასახდელ თანხას. ოპერაციის წარმატებით დასრულების შემთხვევაში, პროცესის გასაგრძელებლად, მომხმარებელი უნდა გადაამისამართოთ ონლაინ გადახდის გვერდზე, _links პარამეტრში დაბრუნებულ redirect მისამართზე.

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

Content-Typerequiredapplication/json

AuthorizationrequiredBasic <base64>

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

Idempotency-KeyoptionalUUID v4

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

Accept-Languageoptionalstring

განსაზღვრავს ონლაინ გადახდების გვერდზე გადამისამართების შემდეგ, რა ენის ინტერფეისი დახვდება მომხმარებელს. იღებს ორ მნიშვნელობას:

• ka - ქართული (ნაგულისხმევი)
• en - ინგლისური.

Themeoptionalstring

განსაზღვრავს ონლაინ გადახდების გვერდზე გადამისამართების შემდეგ, რა თემის ინტერფეისი დახვდება მომხმარებელს. იღებს ორ მნიშვნელობას:

• light - ღია (ნაგულისხმევი)
• dark - მუქი.

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

buyeroptionalobject

ინფორმაცია ბიზნესში მყიდველის შესახებ.

buyer.full_nameoptionalstring

მყიდველის სახელი და გვარი.

buyer.masked_emailoptionalstring

მყიდველის დაშიფრული ელ. ფოსტის მისამართი.

buyer.masked_phoneoptionalstring

მყიდველის დაშიფრული ტელეფონის ნომერი.

callback_urlrequiredstring

ბიზნესის ვებმისამართი (აუცილებლად https ტიპის), რომელსაც ავტომატურად გამოიძახებს ბანკი, ოპერაციის დასრულების შემდეგ, ბიზნესისთვის გადახდის მონაცემების მიწოდების მიზნით (Callback-ის დროს).

external_order_idoptionalstring

გადახდის იდენტიფიკატორი ბიზნესის სისტემიდან (მაგალითად: შესყიდვების კალათის იდენტიფიკატორი).

captureoptional"automatic" | "manual"

ტრანზაქციის ტიპი, რომელიც იღებს ორ მნიშვნელობას:

• automatic - სტანდარტული ორდერის შექმნა, გადახდა მოხდება პრეავტორიზაციის გარეშე, ანუ მომხარებლის ანგარიშიდან თანხა მომენტალურად ჩამოიჭრება
• manual - გადახდის შესრულების შემდეგ მომხარებლის ანგარიშზე თანხა დაიბლოკება და მომხმარებლისთვის არ იქნება ხელმისაწვდომი. გადახდის დასასრულებლად უნდა გამოიყენოთ პრეავტორიზაციის დასრულების მეთოდი და დაადასტუროთ/უარყოთ ოპერაცია. ამ ოპერაციის 30 დღეში შეუსრულებლობის შემთხვევაში, თანხას ავტომატურად მოეხსნება ბლოკი და ისევ იქნება ხელმისაწვდომი მომხარებლისთვის. ამ ფუნქციონალის გამოყენება შესაძლებელია მხოლოდ Apple Pay-ით, Google Pay-ით ან საბარათე გადახდაზე.

purchase_unitsrequiredobject

ინფორმაცია შეკვეთის შესახებ.

purchase_units.basketrequiredarray

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

purchase_units.basket[].product_idrequiredstring

პროდუქტის/სერვისის იდენტიფიკატორი ბიზნესის სისტემაში.

purchase_units.basket[].descriptionoptionalstring

პროდუქტის/სერვისის დასახელება (აღწერა).

purchase_units.basket[].quantityrequirednumber

თითოეული პროდუქტის/სერვისის რაოდენობა (მოცულობა). მინიმალური მნიშვნელობა არის 1.

purchase_units.basket[].unit_pricerequirednumber

პროდუქტის/სერვისის ერთეულის ფასი.

purchase_units.basket[].unit_discount_priceoptionalnumber

აქციით გადახდის შემთხვევაში, შესყიდული პროდუქტის/სერვისის ერთეულის დაკლებული თანხის მოცულობა.

purchase_units.basket[].vatoptionalnumber

პროდუქტის/სერვისის დამატებული ღირებულების გადასახადი (დღგ).

purchase_units.basket[].vat_percentoptionalnumber

პროდუქტის/სერვისის დამატებული ღირებულების გადასახადის (დღგ) პროცენტი.

purchase_units.basket[].total_priceoptionalnumber

მთლიანი თანხა.

purchase_units.basket[].imageoptionalstring

პროდუქტის/სერვისის სურათის ვებმისამართი (ლინკი).

purchase_units.basket[].package_codeoptionalstring

პროდუქტის კოდი.

purchase_units.basket[].tinoptionalstring

საგადასახადო საიდენტიფიკაციო ნომერი (TIN).

purchase_units.basket[].pinfloptionalstring

გადამხდელის კოდი (PINFL).

purchase_units.basket[].product_discount_codeoptionalstring

პროდუქტის ფასდაკლების იდენტიფიკატორი. თუ მოწოდებული მნიშვნელობით ბანკში დარეგისტრირებულია ფასდაკლების აქცია, ფასდაკლების პირობების გათვალისწინებით, შეკვეთაზე გავრცელდება შესაბამისი აქცია.

purchase_units.deliveryoptionalobject

ინფორმაცია მიტანის სერვისის შესახებ.

purchase_units.delivery.amountoptionalnumber

მიტანის ღირებულება.

purchase_units.total_amountrequirednumber

სრული გადასახდელი თანხის მოცულობა.

purchase_units.total_discount_amountoptionalnumber

აქციით გადახდის შემთხვევაში, დაკლებული თანხის მოცულობა.

purchase_units.currencyoptionalstring

ვალუტა, რომელშიც ხორციელდება გადახდა:

• GEL - ქართული ლარი (ნაგულისმევი)
• USD - ამერიკული დოლარი
• EUR - ევრო
• GBP - ბრიტანული გირვანქა.

redirect_urlsoptionalobject

ბიზნესის ვებმისამართები, რომლებზეც შესაძლოა, გადამისამართდეს მომხმარებელი ონლაინ გადახდის სისტემიდან ოპერაციის დასრულების შემდეგ.

redirect_urls.successoptionalstring

ვებმისამართი ოპერაციის წარმატებით დასრულების შემთხვევაში. მნიშვნელობის არ გადმოცემის შემთხვევაში მომხმარებელი დარჩება ონლაინ გადახდების გვერდზე და გამოუჩნდება შესაბამისი ქვითარი.

redirect_urls.failoptionalstring

ვებმისამართი ოპერაციის წარუმატებლად დასრულების შემთხვევაში. მნიშვნელობის არ გადმოცემის შემთხვევაში მომხმარებელი დარჩება ონლაინ გადახდების გვერდზე და გამოუჩნდება შესაბამისი ქვითარი.

ttloptionalnumber

შეკვეთის სიცოცხლის ხანგრძლივობა წუთებში (შეკვეთის შექმნიდან რამდენი წუთის განმავლობაში შეეძლება მომხმარებელს გადახდის შესრულება). მოცემული პარამეტრის ლოგიკა სხვა და სხვა ინდუსტრიის ბიზნესისთვის განსხვავებული შეიძლება იყოს. პარამეტრის მინიმალური შესაძლო მნიშვნელობაა 2, მაქსიმალური კი - 1440 (24 საათი). პარამეტრის არ გადმოცემის შემთხვევაში სისტემა იგულისხმებს 15 წუთს.

payment_methodoptionalarray

გადახდის მეთოდები, რომლების გამოყენებასაც შეძლებს მომხმარებელი ამ შეკვეთაზე გადახდის განსახორციელებლად. აუცილებელია, ბიზნესს გააქტიურებული ჰქონდეს ყველა გადმოცემული მეთოდი. პარამეტრის არ გადმოცემის შემთხვევაში მომხმარებელს ონლაინ გადახდის გვერდზე გადამისამართების შემდეგ შეეძლება ყველა იმ გადახდის მეთოდით სარგებლობა, რომელიც გააქტიურებული აქვს ბიზნესს. შესაძლო მნიშვნელობები:

• card - საბანკო ბარათით გადახდა
• google_pay - Google Pay-ით და საბანკო ბარათით გადახდა (ამ მნიშვნელობის გადმოცემის შემთხვევაში, მომხმარებელს შეეძლება როგორც Google Pay-ით, ასევე საბანკო ბარათით გადახდა. აუცილებელია, რომ ბიზნესს გააქტიურებული ჰქონდეს ორივე გადახდის მეთოდი)
• apple_pay - Apple Pay-ით და საბანკო ბარათით გადახდა (ამ მნიშვნელობის გადმოცემის შემთხვევაში, მომხმარებელს შეეძლება როგორც Apple Pay-ით, ასევე საბანკო ბარათით გადახდა. აუცილებელია, რომ ბიზნესს გააქტიურებული ჰქონდეს ორივე გადახდის მეთოდი)
• bog_p2p - საქართველოს ბანკის, ინტერნეტ ან მობაილ ბანკის მომხმარებლით გადარიცხვა
• bog_loyalty - საქართველოს ბანკის ქულებით MR/Plus გადახდა
• bnpl - ნაწილ-ნაწილით გადახდა
• bog_loan - სტანდარტული საბანკო განვადება
• gift_card - სასაჩუქრე ბარათით გადახდა

configoptionalobject

კონკრეტული გადახდის კონფიგურაცია.

config.loanoptionalobject

გადახდის კონფიგურაცია. პარამეტრის გადმოცემა აუცილებელია თუ გსურთ, რომ შეკვეთის გადახდა მხოლოდ განვადებით ("payment_method":["bog_loan"] ) ან მხოლოდ ნაწილ-ნაწილით ("payment_method":["bnpl"] ) მოხდეს.

config.loan.typeoptionalstring

განვადების/ნაწილ-ნაწილის ფასდაკლების კოდი (კალკულატორის მიერ დაბრუნებული discount_code პარამეტრის მნიშვნელობა).

config.loan.monthoptionalnumber

განვადების/ნაწილ-ნაწილის ხანგრძლივობა თვეებში (კალკულატორის მიერ დაბრუნებული month პარამეტრის მნიშვნელობა).

config.campaignoptionalobject

აქციით გადახდის კონფიგურაცია. იმისთვის, რომ მომხმარებელმა შეძლოს ბიზნესზე დამატებული აქციით სარგებლობა, საჭიროა, შეკვეთის შექმნისას გადახდის მეთოდში საბარათე გადახდის მითითება ("payment_method":["card"] ).

config.campaign.cardoptionalstring

ბარათი, რომელზეც ვრცელდება აქცია:

• visa - ვიზა
• mc - მასტერქარდი
• solo - სოლო ბარათი

config.campaign.typeoptionalstring

აქციის ტიპი:

• restrict - ბარათის ტიპის შეზღუდვა
• client_discount - ფასდაკლება კონკრეტულ ბარათის ტიპზე

config.google_payoptionalobject

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

config.google_pay.google_pay_tokenoptionalstring

Google-ის ტოკენი

config.google_pay.externaloptionalboolean

• true - გადახდა ინიცირდება ბიზნესის ვებგვერდზე განთავსებული Google Pay-ს ღილაკით
• false - გადახდა ხდება ბანკის გადახდების გვერდიდან (ნაგულისმევი)

config.apple_payoptionalobject

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

config.apple_pay.externaloptionalboolean

• true - გადახდა ინიცირდება ბიზნესის ვებგვერდზე განთავსებული Apple Pay-ს ღილაკით
• false - გადახდა ხდება ბანკის გადახდების გვერდიდან (ნაგულისმევი)

config.accountoptionalobject

გადახდის კონფიგურაცია. პარამეტრის გადმოცემა აუცილებელია თუ თქვენთვის კონფიგურირებულია რამდენიმე ელ.კომერციის POS ტერმინალი ერთსადაიმავე ვალუტაში: შესრულებული ოპერაციები გსურთ დააჯგუფოთ ბიზნესის საჭიროებებიდან გამომდინარე ან ანგარიშსწორება შესრულდეს ბიზნესის სხვადასხვა ანგარიშზე.

config.account.tagoptionalstring

ელ.კომერციის POS ტერმინალის იდენტიფიკატორი. თუ მოწოდებული tag-ის მნიშვნელობა არ ემთხვევა POS-ის კონფიგურაციას ან tag მოწოდებული არ არის, ოპერაცია შესრულდება default POS ტერმინალზე და შესაბამის ანგარიშსწორების ანგარიშზე. შენიშვნა: ტეგის მნიშვნელობის შეთანხმება აუცილებელია დამატებითი POS-ის კონფიგურირებისას.

CURL

curl -X POST 'https://api.bog.ge/payments/v1/ecommerce/orders' \
-H 'Accept-Language: ka' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "callback_url": "https://example.com/callback",
    "external_order_id": "id123",
    "purchase_units": {
        "currency": "GEL",
        "total_amount": 1,
        "basket": [
            {
                "quantity": 1,
                "unit_price": 1,
                "product_id": "product123"
            }
        ]
    },
    "redirect_urls": {
        "fail": "https://example.com/fail",
        "success": "https://example.com/success"
    }
}'

Response

idstring

ონლაინ გადახდის იდენტიფიკატორი.

_linksobject

ვებრესურსის მისამართები, რომლებიც გადახდის პროცესის შემდგომ ეტაპებზე გამოიყენება. ამჟამად ბრუნდება ორი რესურსი:

_links.details.hrefstring

გადახდის დეტალების მისამართი, რომლის გამოძახებითაც შეგიძლიათ, გაიგოთ ინფორმაცია ონლაინ გადახდის შესახებ.

_links.redirect.hrefstring

ვებგვერდის მისამართი, რომელზეც უნდა გადავიდეს მომხმარებელი პლასტიკური ბარათის ან ონლაინბანკინგის მონაცემების შესაყვანად და გადახდის პროცესის დასასრულებლად.

RESPONSE

{
    "id": "{order_id}",
    "_links": {
        "details": {
            "href": "https://api.bog.ge/payments/v1/receipt/{order_id}"
        },
        "redirect": {
            "href": "https://payment.bog.ge/?order_id={order_id}"
        }
    }
}