გადახდების დეტალების მიღება

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

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

AuthorizationrequiredBasic <base64>

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

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

order_idrequiredstring

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

CURL

curl -X GET 'https://api.bog.ge/payments/v1/receipt/:order_id' \
-H 'Authorization: Bearer <token>'

Response

order_idstring

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

industrystring

ბიზნესის ინდუსტრია, რომელიც მისი რეგისტრაციის დროს განისაზღვრება.

capturestring

ავტორიზაციის მეთოდი. ყოველთვის - automatic. ტრანზაქციის ტიპი ორი შესაძლო მნიშვნელობით:

• automatic - სტანდარტული ორდერი
• manual - პრეავტორიზაციის ორდერი

external_order_idstring

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

clientobject

ბიზნესის ინფორმაცია.

client.idstring

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

client.brand_kastring

ბიზნესის ქართული დასახელება.

client.brand_enstring

ბიზნესის ინგლისური დასახელება.

client.urlstring

ბიზნესის ვებგვერდის მისამართი.

zoned_create_datestring

შეკვეთის შექმნის თარიღი მსოფლიო კოორდინირებული დროით ( UTC), "YYYY-MM-DDTHH:MM:SS.ssssssZ" ფორმატში.

zoned_expire_datestring

შეკვეთის ვადის გასვლის თარიღი მსოფლიო კოორდინირებული დროით (UTC), "YYYY-MM-DDTHH:MM:SS.ssssssZ" ფორმატში.

order_statusobject

შეკვეთის სტატუსი.

order_status.keystring

სტატუსი იღებს შემდეგ მნიშვნელობებს:

• created - გადახდის მოთხოვნა შექმნილია
• processing - გადახდა მუშავდება
• completed - გადახდის პროცესი დასრულდა წარმატებით
• rejected - გადახდის პროცესი დასრულდა წარუმატებლად
• refund_requested - მოთხოვნილია თანხის დაბრუნება
• refunded - გადახდის თანხა დაბრუნებულია
• refunded_partially - გადახდის თანხა ნაწილობრივ დაბრუნებულია
• auth_requested - პრეავტორიზირებული გადახდა მოთხოვნილია
• blocked - პრეავტორიზირებული გადახდის პროცესი დასრულდა წარმატებით, თუმცა თანხა ჯერ დაბლოკილია და ელოდება დადასტურებას
• partial_completed - პრეავტორიზირებული გადახდა ნაწილობრივ თანხაზე წარმატებით დადასტურდა

order_status.valuestring

აღწერა.

buyerobject

მყიდველის ინფორმაცია.

buyer.full_namestring

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

buyer.emailstring

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

buyer.phone_numberstring

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

purchase_unitsobject

ინფორმაცია შესყიდული პროდუქციის შესახებ.

purchase_units.request_amountstring

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

purchase_units.transfer_amountstring

შეკვეთის დამუშავებული თანხა.

purchase_units.refund_amountstring

დაბრუნებული თანხა.

purchase_units.currency_codestring

ვალუტა.

purchase_units.itemsarray

შეძენილი პროდუქტების/სერვისების მასივი.

purchase_units.items[].external_item_idstring

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

purchase_units.items[].descriptionstring

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

purchase_units.items[].quantitystring

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

purchase_units.items[].unit_pricestring

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

purchase_units.items[].unit_discount_pricestring

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

purchase_units.items[].vatstring

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

purchase_units.items[].vat_percentstring

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

purchase_units.items[].total_pricestring

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

purchase_units.items[].package_codestring

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

purchase_units.items[].tinstring

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

purchase_units.items[].pinflstring

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

purchase_units.basket[].product_discount_idoptionalstring

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

redirect_linksobject

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

redirect_links.failstring

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

redirect_links.successstring

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

payment_detailobject

გადახდის დეტალები.

payment_detail.transfer_methodobject

გადახდის მეთოდი.

payment_detail.transfer_method.keystring

გადახდის მეთოდი იღებს შემდეგ მნიშვნელობებს:

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

payment_detail.transfer_method.valuestring

აღწერა.

payment_detail.transaction_idstring

ტრანზაქციის იდენტიფიკატორი.

payment_detail.auth_codestring

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

payment_detail.payer_identifierstring

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

• card/google_pay – ბრუნდება ბარათის დაშიფრული ნომერი (PAN)⁵
• apple_pay – ბრუნდება Apple-ის მიერ მინიჭებული ბარათის ნომერი, რომელიც უნიკალურია ყველა მოწყობილობისთვის
• bog_p2p/bog_loyalty – ბრუნდება ანგარიშის სახელი
• bog_loan/bnpl – ბრუნდება მომხმარებლის სახელი და გვარის პირველი ასო.

payment_detail.payment_optionstring

გადახდის გზა. შესაძლებელია დაბრუნდეს შემდეგი მნიშვნელობები:

• direct_debit - ბარათით გადახდა
• recurrent - დამახსოვრებული ბარათით გადახდა
• subscription - დამახსოვრებული ბარათით ავტომატური ჩამოჭრა.

payment_detail.card_typestring

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

• amex - American Express
• mc - Mastercard
• visa - Visa.

payment_detail.card_expiry_datestring

იმ ბარათის ვადის გასვლის თარიღი (თვე/წელი), რომლითაც მოხდა გადახდა. პარამეტრი მნიშვნელობას იღებს საბარათე გადახდის დროს.

payment_detail.request_account_tagstring

ელ.კომერციის POS ტერმინალის შეკვეთაში მოთხოვნილი იდენტიფიკატორი

payment_detail.transfer_account_tagstring

ელ.კომერციის იმ POS ტერმინალის იდენტიფიკატორი, რომელზეც შესრულდა გადახდა.

payment_detail.saved_card_typestring

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

• recurrent - ბარათი დამახსოვრებულია კლიენტის მიერ ინცირებული მომავალი გადახდისთვის.
• subscription - ბარათი დამახსოვრებულია ავტომატური გადახდებისთვის ფიქსირებული თანხითა და დეტალებით.

payment_detail.parent_order_idstring

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

payment_detail.codestring

გადახდის Response კოდი.

payment_detail.code_descriptionstring

გადახდის Response კოდის აღწერა.

payment_detail.auth_codestring

საბარათე, Google Pay-ით ან Apple Pay-ით გადახდის ავტორიზაციის კოდი.

discountobject

ინფორმაცია ფასდაკლების შესახებ, რომელიც გავრცელდა გადახდაზე

discount.bank_discount_amountstring

ბანკის მიერ გავრცელებული ფასდაკლების თანხა

discount.bank_discount_descstring

ბანკის მიერ გავრცელებული ფასდაკლების აღწერა

discount.system_discount_amountstring

საბარათე სისტემის მიერ გავრცელებული ფასდაკლების თანხა

discount.system_discount_descstring

საბარათე სისტემის მიერ გავრცელებული ფასდაკლების აღწერა

discount.discounted_amountstring

თანხა ფასდაკლების შემდეგ

discount.original_order_amountstring

საწყისი თანხა

actionsarray

შეკვეთასთან დაკავშირებული ქმედებების სია.

actions[].action_idstring

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

actions[].request_channelstring

წყარო, რომლიდანაც მოხდა ქმედების ინიციარება:

• public_api - ონლაინ გადახდების API
• business_manager - ბიზნეს მენეჯერის გვერდი
• support - საქართველოს ბანკის შიდა სისტემა.

actions[].actionstring

ქმედების ტიპი:

• authorize - პრეავტორიზირებული გადახდის დადასტურება
• partial_authorize - პრეავტორიზირებული გადახდის დადასტურება არასრულ თანხაზე
• cancel_authorize - პრეავტორიზირებული გადახდის უარყოფა
• refund - თანხის დაბრუნება
• partial_refund - თანხის ნაწილობრივი დაბრუნება.

actions[].statusstring

ქმედების სტატუსი:

• completed - ქმედება დასრულდა წარმატებით
• rejected - ქმედება დასრულდა წარმუმატებლად

actions[].codestring

მოქმედების response კოდი. მოქმედების Response კოდების სია იხ. აქ.

actions[].code_descriptionstring

მოქმედების response კოდის აღწერა.

actions[].zoned_action_datestring

ქმედების ინიცირების თარიღი მსოფლიო კოორდინირებული დროით (UTC), "YYYY-MM-DDTHH:MM:SS.ssssssZ" ფორმატში.

actions[].amountstring

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

langstring

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

• ka - ქართული
• en - ინგლისური.

reject_reasonstring

გადახდის წარუმატებლად დასრულების მიზეზი. პარამეტრი მნიშვნელობას იღებს მხოლოდ მაშინ, თუ შეკვეთა წარუმატებლად დასრულდა ("order_status": "rejected"). იღებს შემდეგ მნიშვნელობებს:

• expiration - შეკვეთას გაუვიდა ვადა
• unknown - დაუდგენელი მიზეზი.
• გადახდის Response კოდის აღწერა - ბარათით, Google pay-ით ან Apple pay-ით ინიცირებული გადახდების უარყოფის მიზეზი. Response კოდების სია იხილეთ აქ.

splitobject

თანხის გაყოფის სტატუსისა და დეტალების ობიექტი.

split.split_statusstring

თანხის გაყოფის მოთხოვნის სტატუსი. შესაძლო მნიშვნელობები:

• created - მოთხოვნა შექმნილია
• processing - მოთხოვნა მუშავდება
• canceled - მოთხოვნა გაუქმებულია
• completed - მოთხოვნა წარმატებით შესრულდა
• rejected - მოთხოვნა ვერ შესრულდა

split.currencystring

თანხის გაყოფის ვალუტა (მაგ. GEL).

split.request_channelstring

არხი, საიდანაც მოხდა თანხის გაყოფის ინიცირება.

RESPONSE

{
    "order_id": "a767a276-cddd-43ec-9db3-9f9b39eee02d",
    "industry": "ecommerce",
    "capture": "automatic",
    "external_order_id": "123456",
    "client": {
        "id": "10000",
        "brand_ka": "საქართველოს ბანკი",
        "brand_en": "BOG",
        "url": "https://api.bog.ge"
    },
    "create_date": "2022-11-01T13:19:43.021178",
    "zoned_create_date": "2022-11-01T13:19:43.021178Z",
    "expire_date": "2022-11-01T13:39:43.021178",
    "zoned_expire_date": "2022-11-01T13:39:43.021178Z",
    "order_status": {
        "key": "refunded",
        "value": "დაბრუნებული"
    },
    "buyer": {
        "full_name": "John Doe",
        "email": "johndoe@gmail.com",
        "phone_number": "+995555000000"
    },
    "purchase_units": {
        "request_amount": "100.5",
        "transfer_amount": "0.0",
        "refund_amount": "100.5",
        "currency_code": "GEL",
        "items": [
            {
                "external_item_id": "id_1",
                "description": "product 1",
                "quantity": "1",
                "unit_price": "25.35",
                "unit_discount_price": "0",
                "vat": "0",
                "vat_percent": "0",
                "total_price": "25.35",
                "package_code": "A000123",
                "tin": null,
                "pinfl": null,
                "product_discount_id": "BF222R5"
            }
        ]
    },
    "redirect_links": {
        "success": "https://payment.bog.ge/receipt?order_id=a767a276-cddd-43ec-9db3-9f9b39eee02d",
        "fail": "https://payment.bog.ge/receipt?order_id=a767a276-cddd-43ec-9db3-9f9b39eee02d"
    },
    "payment_detail": {
        "transfer_method": {
            "key": "card",
            "value": "ბარათით გადახდა"
        },
        "code": "100",
        "code_description": "Successful payment",
        "transaction_id": "230513868679",
        "payer_identifier": "548888xxxxxx9893",
        "payment_option": "direct_debit",
        "card_type": "mc",
        "card_expiry_date": "03/24",
        "request_account_tag": "1212",
        "transfer_account_tag": "gev2",
        "saved_card_type": "recurrent",
        "parent_order_id": "8d52130d-cb1b-45ea-b048-0f040a44e2a3",
        "pg_trx_id": "K4T2XMAZ9EBVQ3WN",
        "auth_code": "483921"
    },
    "discount": {
        "bank_discount_amount": "string",
        "bank_discount_desc": "string",
        "discounted_amount": "string",
        "original_order_amount": "string",
        "system_discount_amount": "string",
        "system_discount_desc": "string"
    },
    "actions": [
        {
            "action_id": "b70968ca-eda9-47ae-8811-26fd1ab733f8",
            "request_channel": "public_api",
            "action": "authorize",
            "status": "completed",
            "action_date": "2022-11-28T13:42:40.668439",
            "zoned_action_date": "2022-11-28T13:42:40.668439Z",
            "amount": "100.5",
            "code": null,
            "code_description": null
        },
        {
            "action_id": "a89b872a-9700-4025-b3fb-047cbba7a5e6",
            "request_channel": "business_manager",
            "action": "refund",
            "status": "completed",
            "action_date": "2022-11-28T13:58:03.427939",
            "zoned_action_date": "2022-11-28T13:58:03.427939Z",
            "amount": "100.5",
            "code": null,
            "code_description": null
        }
    ],
    "disputes": null,
    "split": null,
    "lang": "ka",
    "reject_reason": null
}