Skip to main content

Apple Pay™ Accept Payment

Calling this service is required to complete Apple Pay™ payment initiated on business' webpage.

Header parameters​

Content-Typerequiredapplication/json

AuthorizationrequiredBasic <base64>

Bearer <jwt_token>, where jwt_token is the token returned in the access_token parameter of the authentication method response.

Idempotency-KeyoptionalUUID v4

The Idempotency-Key parameter should be unique for each new API request. Subsequent requests to the same API endpoint with the same Idempotency-Key header will result in the server returning the same status code and response body as the initial request. This functionality is particularly useful to ensure consistent outcome in scenarios where network issues or retries may lead to duplicate requests.

Path parameters​

order_idrequiredstring

The order identifier returned in response to the order request.

Body parameters​

apple_pay_tokenrequiredstring

Apple token.

curl -X POST 'https://api.bog.ge/payments/v1/ecommerce/orders/{order_id}/payment' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "apple_pay_token": "string"
}'

Response​

idstring

Order identifier.

statusstring

Order status.

order_detailsobject

Order details. Contains same data as payment details.

_linksobject

The web resource addresses are used in the further stages of the payment process. At the moment following resources are returned:

_links.details.hrefstring

The address of the payment details can be used to obtain information on the online payment.
{
    "id": "{order_id}",
    "status": "completed",
    "order_details": {...},
    "_links": {
        "details": {
            "href": "https://api.bog.ge/payments/v1/receipt/{order_id}"
        }
    }
}