Skip to main content

Create Pre-order

View as Markdown

The create pre-order endpoint generates a unique payment link based on the provided transaction details. This link redirects the customer to a secure, bank-hosted page where they can complete their payment using various methods.

Method: POST /v1/preorder

Headers: See Common Headers

Request Parameters​

callback_urlrequiredstring

The HTTPS URL where the bank's server sends asynchronous callbacks with the final transaction status.

descriptionrequiredstring

A brief description of the order or service.

external_order_idoptionalstring

A unique order identifier generated by the merchant's system.

purchase_unitsrequiredobject

An object with payment amount and currency details.

purchase_units.currencyrequiredstring

The three-letter currency code (e.g., 'GEL').

purchase_units.total_amountrequirednumber

The total transaction amount.

ttloptionalinteger

Time to live3 in minutes for which the pre-order link remains valid. Minimum: 2 min. Maximum: 1440 min (24 hours). Default: 15 min.

curl --location 'https://api.bog.ge/payments/v1/pre-orders' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT>' \
--data '{
  "callback_url": "https://example.com/callback",
  "description": "service fee",
  "external_order_id": "id123",
  "purchase_units": {
    "currency": "GEL",
    "total_amount": 1
  },
  "ttl": 1440
}'

Response Parameters​

idstring

A unique identifier for the pre-order generated by the bank's system. This ID can be used for future references, such as checking the payment status.

_linksobject

A container for hypermedia links related to the resource.

_links.payment_linkobject

An object containing the URL for the customer to complete the payment.

_links.payment_link.hrefstring

The fully qualified URL redirects the customer to the secure, bank-hosted payment page.

{
    "id": "c0fb0f1d-7715-485a-b753-10cf148708e3",
    "_links": {
        "payment_link": {
            "href": "https://link.bog.ge/HnisFqRnzJz"
        }
    }
}