Skip to main content

Payment Details Receiving

Through the method the business has the opportunity to receive the detailed information on the online payment without its identifier.

Header parameters

AuthorizationrequiredBasic <base64>

The meaning Bearer <jwt_token> is transmitted, where jwt_token is the meaning returned to the access_token parameter of the Response method.

Path parameter

order_idrequiredstring

The order identifier, being returned to the online shop into the order requirement `Response`.
curl -X GET 'https://api.bog.ge/payments/v1/receipt/:order_id' \
-H 'Authorization: Bearer <token>'

Response

order_idstring

The online payment identifier.

industrystring

The business industry, being defined in the course of its registration.

capturestring

The authorization method, always - automatic. transaction type with two possible meanings:

  • automatic - a standard order
  • manual - a pre-authorization order

external_order_idstring

The payment identifier from the business system (e.g., a purchase basket identifier).

clientobject

The business information.

client.idstring

The business identifier in the bank system.

client.brand_kastring

The business Georgian name.

client.brand_enstring

The business English name.

client.urlstring

The business web-site address.

create_datestring

The order creation time in the bank system.

expire_datestring

The order expiration time in the bank system.

order_statusobject

Order status.

order_status.keystring

The status gets the following meanings:

  • created - payment request is created
  • processing - payment is being processed
  • completed - payment process has been completed
  • rejected - payment process has been unsuccessfully completed
  • refund_requested - refunding of the amount is requested
  • refunded - payment amount has been returned
  • refunded_partially - payment amount has been partially refunded
  • auth_requested - pre-authorize payment is requested
  • blocked - pre-authorize payment has been completed successfully, but payment amount is blocked and waiting for confirmation
  • partial_completed - pre-authorize payment partial amount has been confirmed successfully

order_status.valuestring

Description.

buyerobject

The buyer information.

buyer.full_namestring

The buyer's full name.

buyer.emailstring

The buyer's email.

buyer.phone_numberstring

The buyer's phone number.

purchase_unitsobject

Information on the purchased products.

purchase_units.request_amountstring

The requested amount of the order.

purchase_units.transfer_amountstring

The processed amount of the order.

purchase_units.refund_amountstring

The refunded amount.

purchase_units.currency_codestring

Currency.

purchase_units.itemsarray

The list of the purchased products/services.

purchase_units.items[].external_item_idstring

The purchased product/service identifier in the business system.

purchase_units.items[].descriptionstring

The name (description) of the purchased product/service.

purchase_units.items[].quantitystring

The quantity (volume) of each product/service.

purchase_units.items[].unit_pricestring

The purchased product/service unit price.

purchase_units.items[].unit_discount_pricestring

The volume of the deducted amount on the product/service unit in case of discount payment.

purchase_units.items[].vatstring

The value added tax (VAT) of the purchased product/service.

purchase_units.items[].vat_percentstring

The percentage of value added tax (VAT) of the purchased product/service.

purchase_units.items[].total_pricestring

The total price of the purchased product/service.

purchase_units.items[].package_codestring

The product code of the purchased product/service.

purchase_units.items[].tinstring

The taxpayer identification number (TIN).

purchase_units.items[].pinflstring

The personal identification number of an individual (PINFL).

redirect_linksobject

The business web-pages, to which customers can be re-directed from the online payment system upon completion of the transaction.

redirect_links.failstring

The web-address in the case of transaction failure.

redirect_links.successstring

The web-address in the case of transaction success.

payment_detailobject

Payment details.

payment_detail.transfer_methodstring

Payment method.

payment_detail.transfer_method.keystring

The payment method gets the following meanings:
  • card - payment by a bank card
  • google_pay - payment through Google Pay
  • apple_pay - payment through Apple Pay
  • bog_p2p - transferring by a customer of the Bank of Georgia, internet or mobile banking
  • bog_loyalty - payment by BoG MR/Plus points
  • bnpl - payment in installments
  • bog_loan - standard bank installment plan.

payment_detail.transfer_method.valuestring

Description.

payment_detail.transaction_idstring

Transaction identifier.

payment_detail.payer_identifierstring

A payer's identifier, according to the transfer_method, gets various meanings:

  • card/google_pay – the card’s encoded number is returned (PAN)5
  • apple_pay – a device-specific number assigned to your card by Apple is returned
  • bog_p2p/bog_loyalty – the account name is returned
  • bog_loan/bnpl – the first letter of a customer name is returned.

payment_detail.payment_optionstring

Payment method. The following values can be returned:

  • direct_debit - card payment
  • recurrent - payment by the saved card
  • subscription - automatic withdrawal by the saved card.

payment_detail.card_typestring

The type of card used for payment. The parameter takes its value during the card payment:

  • AMEX - American Express
  • MASTERCARD - Mastercard
  • VISA - Visa.

payment_detail.card_expiry_datestring

Expiration date (month/year) of the card with which the payment was made. The parameter takes value at the time of card payment.

actionsarray

The list of actions associated with an order.

actions[].action_idstring

The action identifier.

actions[].request_channelstring

The channel, from which the action was initiated:

  • public_api - online payments API
  • business_manager - business manager website
  • support - BOG inner system.

actions[].actionstring

The action type:

  • authorize - confirmation of pre-authorize payment
  • partial_authorize - confirmation of pre-authorize payment
  • cancel_authorize - rejection of pre-authorize payment
  • refund - refund
  • partial_refund - partially refund

actions[].statusstring

The action status:

  • completed - action has been completed successfully
  • rejected - has been completed unsuccessfully

actions[].action_datestring

The date when the action was initiated.

actions[].amountstring

The amount associated with the action.

langstring

The interface language found by a customer after re-directing to the online payment page. There are two meanings:

  • ka - Kartuli (Georgian)
  • en - English

reject_reasonstring

  • Reason for payment failure. The parameter takes value only if the order failed ("order_status": "rejected"). takes the following values:
  • expiration - the order has expired
  • unknown - an unidentified reason.
{
"order_id": "a767a276-cddd-43ec-9db3-9f9b39eee02d",
"industry": "ecommerce",
"capture": "manual",
"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",
"expire_date": "2022-11-01T13:39:43.021178",
"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
}
]
},
"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": "ბარათით გადახდა"
},
"transaction_id": "230513868679",
"payer_identifier": "548888xxxxxx9893",
"payment_option": "direct_debit",
"card_type": "mc",
"card_expiry_date": "03/24"
},
"actions": [
{
"action_id": "b70968ca-eda9-47ae-8811-26fd1ab733f8",
"request_channel": "public_api",
"action": "authorize",
"status": "completed",
"action_date": "2022-11-28T13:42:40.668439",
"amount": "100.5"
},
{
"action_id": "a89b872a-9700-4025-b3fb-047cbba7a5e6",
"request_channel": "business_manager",
"action": "refund",
"status": "completed",
"action_date": "2022-11-28T13:58:03.427930",
"amount": "100.5"
}
],
"lang": "ka",
"reject_reason": null
}