### API Endpoint Example

Source: https://api.bog.ge/docs/en/bg-ofa-pis

This example demonstrates the structure of a GET request to the API, including the base URL for both production and sandbox environments, and the dynamic path parameters.

```HTTP
GET /v2/{resource-path}/{resourceId}/{authorisation-category}/{authorisationId} HTTP/1.1
Host: xs2a.bog.ge

# Production Environment
# https://xs2a.bog.ge/0.8/v2/{resource-path}/{resourceId}/{authorisation-category}/{authorisationId}

# Sandbox Environment
# https://xs2a-sandbox.bog.ge/0.8/v2/{resource-path}/{resourceId}/{authorisation-category}/{authorisationId}
```

--------------------------------

### Get Authorisation Sub-Resources Request Example

Source: https://api.bog.ge/docs/en/bg-ofa-pis

This code snippet demonstrates how to make a GET request to retrieve authorisation sub-resources. It includes path parameters like resource-path, resourceId, and authorisation-category, as well as optional headers such as Digest, x-jws-signature, and X-Request-ID.

```http
GET /v2/{resource-path}/{resourceId}/{authorisation-category} HTTP/1.1
Host: xs2a.bog.ge
Digest: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
x-jws-signature: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4
X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
```

--------------------------------

### GET /banking/products/cred-and-chrg-cards

Source: https://api.bog.ge/docs/en/openbanking

Retrieves example response data for credit and charge cards. This endpoint provides a sample of the product data structure, including details like product ID, names, descriptions, and associated fees.

```APIDOC
## GET /banking/products/cred-and-chrg-cards

### Description
Retrieves example response data for credit and charge cards. This endpoint provides a sample of the product data structure, including details like product ID, names, descriptions, and associated fees.

### Method
GET

### Endpoint
/banking/products/cred-and-chrg-cards

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **page-size** (integer) - Optional - The number of items per page. Default: 1

### Request Example
```json
{
  "example": "No request body needed for this GET request."
}
```

### Response
#### Success Response (200)
- **description** (string) - A description of the example data.
- **value** (object) - Contains the product data.
  - **products** (array) - An array of product objects.
    - **productId** (string) - The unique identifier for the product.
    - **effectiveFrom** (string) - The date the product becomes effective.
    - **lastUpdated** (string) - The date the product information was last updated.
    - **productCategory** (string) - The category of the product.
    - **name** (string) - The name of the product.
    - **description** (string) - A detailed description of the product.
    - **brand** (string) - The brand of the product.
    - **isTailored** (boolean) - Indicates if the product is tailored.
    - **additionalInformation** (object) - Additional information links for the product.
      - **eligibilityUri** (string) - URI for eligibility information.
      - **feesAndPricingUri** (string) - URI for fees and pricing information.
      - **overviewUri** (string) - URI for product overview.
      - **termsUri** (string) - URI for terms and conditions.
    - **cardArt** (object) - Information about the card's visual art.
      - **title** (string) - The title of the card art.
      - **imageUri** (string) - The URI of the card art image.
    - **features** (array) - An array of product features.
      - **featureType** (string) - The type of feature.
      - **additionalValue** (string) - Additional value associated with the feature.
      - **additionalInfo** (string) - Additional information about the feature.
      - **additionalInfoUri** (string) - URI for more information on the feature.
    - **fees** (array) - An array of fees associated with the product.
      - **name** (string) - The name of the fee.
      - **feeType** (string) - The type of fee.
      - **amount** (number) - The amount of the fee.
      - **currency** (string) - The currency of the fee.
      - **additionalInfo** (string) - Additional information about the fee.
  - **_links** (object) - Links for pagination.
    - **self** (object) - Link to the current page.
      - **href** (string) - The URL for the self link.
    - **next** (object) - Link to the next page.
      - **href** (string) - The URL for the next link.

#### Response Example
```json
{
  "description": "get cred-and-chrg-cards example",
  "value": {
    "products": [
      {
        "productId": "65cc2c8205a05d7379fa3a6386f710e1",
        "effectiveFrom": "1970-01-01T04:00:00.000+04:00",
        "lastUpdated": "2022-06-24T12:46:42.786+04:00",
        "productCategory": "CRED_AND_CHRG_CARDS",
        "name": "Sticker",
        "description": "Debit Card",
        "brand": "Sticker",
        "isTailored": true,
        "additionalInformation": {
          "eligibilityUri": null,
          "feesAndPricingUri": null,
          "overviewUri": null,
          "termsUri": "https://conditions.bog.ge/ge/bank-service-conditions"
        },
        "cardArt": {
          "title": null,
          "imageUri": null
        },
        "features": [
          {
            "featureType": "OTHER",
            "additionalValue": null,
            "additionalInfo": "Plus Points accumulration and redumption",
            "additionalInfoUri": null
          }
        ],
        "fees": [
          {
            "name": "Monthly: 1.0",
            "feeType": "PERIODIC",
            "amount": 1,
            "currency": "GEL",
            "additionalInfo": "Monthly: 1.0"
          }
        ]
      }
    ],
    "_links": {
      "self": {
        "href": "https://ob-products.bog.ge/1.0/banking/products/cred-and-chrg-cards?page=1&page-size=1"
      },
      "next": {
        "href": "https://ob-products.bog.ge/1.0/banking/products/cred-and-chrg-cards?page=2&page-size=1"
      }
    }
  }
}
```
```

--------------------------------

### Create Signing Basket Response

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Example response after creating a signing basket. It confirms the transaction status, provides a basket ID, and includes links to manage the basket and start the authorization process.

```json
{
  "transactionStatus": "RCVD",
  "basketId": "1234-basket-567",
  "_links": {
    "self": {
      "href": "/psd2/v1/signing-baskets/1234-basket-567"
    },
    "status": {
      "href": "/psd2/v1/signing-baskets/1234-basket-567/status"
    },
    "startAuthorisation": {
      "href": "/psd2/v1/signing-baskets/1234-basket-567/authorisations"
    }
  }
}
```

--------------------------------

### GET /banking/products/cred-and-chrg-cards

Source: https://api.bog.ge/docs/en/openbanking

Retrieves example response data for credit and charge cards. This endpoint provides a sample JSON structure for product information.

```APIDOC
## GET /banking/products/cred-and-chrg-cards

### Description
Retrieves example response data for credit and charge cards. This endpoint provides a sample JSON structure for product information.

### Method
GET

### Endpoint
/banking/products/cred-and-chrg-cards

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **page-size** (integer) - Optional - The number of items per page. Defaults to 10.

### Request Example
```json
{
  "example": "No request body for this GET request."
}
```

### Response
#### Success Response (200)
- **description** (string) - A description of the example data.
- **value** (object) - Contains the product details.
  - **products** (array) - An array of product objects.
    - **productId** (string) - The unique identifier for the product.
    - **effectiveFrom** (string) - The date the product became effective.
    - **lastUpdated** (string) - The date the product information was last updated.
    - **productCategory** (string) - The category of the product.
    - **name** (string) - The name of the product.
    - **description** (string) - A detailed description of the product.
    - **brand** (string) - The brand of the product.
    - **isTailored** (boolean) - Indicates if the product is tailored.
    - **additionalInformation** (object) - Additional information about the product.
      - **eligibilityUri** (string) - URI for eligibility information.
      - **feesAndPricingUri** (string) - URI for fees and pricing information.
      - **overviewUri** (string) - URI for product overview.
      - **termsUri** (string) - URI for product terms and conditions.
    - **cardArt** (object) - Information about the card art.
      - **title** (string) - The title of the card art.
      - **imageUri** (string) - The URI of the card art image.
    - **features** (array) - An array of product features.
      - **featureType** (string) - The type of feature.
      - **additionalValue** (string) - Additional value associated with the feature.
      - **additionalInfo** (string) - Additional information about the feature.
      - **additionalInfoUri** (string) - URI for additional feature information.
    - **fees** (array) - An array of product fees.
      - **name** (string) - The name of the fee.
      - **feeType** (string) - The type of fee.
      - **amount** (number) - The amount of the fee.
      - **currency** (string) - The currency of the fee.
      - **additionalInfo** (string) - Additional information about the fee.
  - **_links** (object) - Links related to the response.
    - **self** (object) - Link to the current resource.
      - **href** (string) - The URL of the self link.
    - **next** (object) - Link to the next page of results.
      - **href** (string) - The URL of the next link.

#### Response Example
```json
{
  "description": "get cred-and-chrg-cards example",
  "value": {
    "products": [
      {
        "productId": "65cc2c8205a05d7379fa3a6386f710e1",
        "effectiveFrom": "1970-01-01T04:00:00.000+04:00",
        "lastUpdated": "2022-06-24T12:46:42.786+04:00",
        "productCategory": "CRED_AND_CHRG_CARDS",
        "name": "Sticker",
        "description": "Debit Card",
        "brand": "Sticker",
        "isTailored": true,
        "additionalInformation": {
          "eligibilityUri": null,
          "feesAndPricingUri": null,
          "overviewUri": null,
          "termsUri": "https://conditions.bog.ge/ge/bank-service-conditions"
        },
        "cardArt": {
          "title": null,
          "imageUri": null
        },
        "features": [
          {
            "featureType": "OTHER",
            "additionalValue": null,
            "additionalInfo": "Plus Points accumulration and redumption",
            "additionalInfoUri": null
          }
        ],
        "fees": [
          {
            "name": "Monthly: 1.0",
            "feeType": "PERIODIC",
            "amount": 1,
            "currency": "GEL",
            "additionalInfo": "Monthly: 1.0"
          }
        ]
      }
    ],
    "_links": {
      "self": {
        "href": "https://ob-products.bog.ge/1.0/banking/products/cred-and-chrg-cards?page=1&page-size=1"
      },
      "next": {
        "href": "https://ob-products.bog.ge/1.0/banking/products/cred-and-chrg-cards?page=2&page-size=1"
      }
    }
  }
}
```
```

--------------------------------

### Retrieve Installment Loan Details via HTTP GET

Source: https://api.bog.ge/docs/en/installment/installment-details

This request retrieves the status of an installment loan by sending a GET request to the installment checkout endpoint. It requires a Bearer JWT token for authorization and returns a JSON object containing the order status and installment details.

```HTTP
GET /v1/installment/checkout/<order_id> HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic <base64>
```

```JSON
{
  "order_id": "{order_id}",
  "status": "success" | "in_progress" | "error",
  "installment_status": "success" | "reject" | "reverse_success" | "fail" | "unknown",
  "ipay_payment_id": "{ipay_payment_id}",
  "shop_order_id": "{shop_order_id}",
  "payment_method": "BOG_LOAN"
}
```

--------------------------------

### POST /v1/{payment-service}/{payment-product}

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Initiates a payment by sending all relevant data for the payment product and standing order execution in a JSON body. This is the first step in initiating a recurring or periodic payment.

```APIDOC
## POST /v1/{payment-service}/{payment-product}

### Description
Initiates a payment by sending all relevant data for the payment product and standing order execution in a JSON body. This is the first step in initiating a recurring or periodic payment.

### Method
POST

### Endpoint
/v1/{payment-service}/{payment-product}

### Parameters
#### Path Parameters
- **payment-service** (string) - Required - The payment service identifier.
- **payment-product** (string) - Required - The payment product identifier.

#### Query Parameters
- **X-Request-ID** (string) - Optional - Unique identifier for the request.
- **Digest** (string) - Optional - The digest of the request body.
- **Signature** (string) - Optional - The signature of the request.
- **PSU-ID** (string) - Optional - The identifier of the Payment Service User.
- **PSU-ID-Type** (string) - Optional - The type of the PSU-ID.
- **PSU-Corporate-ID** (string) - Optional - The corporate identifier of the PSU.
- **PSU-Corporate-ID-Type** (string) - Optional - The type of the PSU-Corporate-ID.
- **consentId** (string) - Optional - The ID of the consent.
- **PSU-IP-Address** (string) - Required - The IP address of the PSU.
- **TPP-Redirect-Preferred** (boolean) - Optional - Preferred redirect by the Third Party Provider.
- **TPP-Decoupled-Preferred** (boolean) - Optional - Preferred decoupled flow by the Third Party Provider.
- **TPP-Redirect-URI** (string) - Optional - The URI for redirection by the Third Party Provider.
- **TPP-Nok-Redirect-URI** (string) - Optional - The URI for redirection in case of failure by the Third Party Provider.
- **TPP-Explicit-Authorisation-Preferred** (boolean) - Optional - Preferred explicit authorisation by the Third Party Provider.
- **TPP-Rejection-NoFunds-Preferred** (boolean) - Optional - Preferred no funds rejection by the Third Party Provider.
- **TPP-Brand-Logging-Information** (string) - Optional - Logging information from the brand.
- **TPP-Notification-URI** (string) - Optional - URI for notifications.
- **TPP-Notification-Content-Preferred** (string) - Optional - Preferred content for notifications.
- **PSU-IP-Port** (string) - Optional - The port of the PSU's IP address.
- **PSU-Accept** (string) - Optional - The Accept header from the PSU.
- **PSU-Accept-Charset** (string) - Optional - The Accept-Charset header from the PSU.
- **PSU-Accept-Encoding** (string) - Optional - The Accept-Encoding header from the PSU.
- **PSU-Accept-Language** (string) - Optional - The Accept-Language header from the PSU.
- **PSU-User-Agent** (string) - Optional - The User-Agent header from the PSU.
- **PSU-Http-Method** (string) - Optional - The HTTP method used by the PSU.
- **PSU-Device-ID** (string) - Optional - The device ID of the PSU.
- **PSU-Geo-Location** (string) - Optional - The geographic location of the PSU.

#### Request Body
- **paymentInitiation** (object) - Required - Contains all data relevant for the payment initiation.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (201)
- **CREATED_201_PaymentInitiation** (object) - Description of the created payment initiation response.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Payment Initiation Responses (Redirect, OAuth2, Decoupled, Embedded)

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Illustrates various JSON responses for payment initiation requests, covering redirect flows (implicit and explicit authorization), OAuth2 approach, decoupled approach, and embedded approach. These examples detail transaction status, payment ID, and relevant links for further actions.

```json
{
  "transactionStatus": "RCVD",
  "paymentId": "1234-wertiq-983",
  "_links": {
    "scaRedirect": {
      "href": "https://www.testbank.com/asdfasdfasdf"
    },
    "self": {
      "href": "/psd2/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "status": {
      "href": "/psd2/v1/payments/1234-wertiq-983/status"
    },
    "scaStatus": {
      "href": "/psd2/v1/payments/1234-wertiq-983/authorisations/123auth456"
    }
  }
}
```

```json
{
  "transactionStatus": "RCVD",
  "paymentId": "1234-wertiq-983",
  "_links": {
    "self": {
      "href": "/psd2/v1/payments/1234-wertiq-983"
    },
    "status": {
      "href": "/psd2/v1/payments/1234-wertiq-983/status"
    },
    "startAuthorisation": {
      "href": "/psd2/v1/payments1234-wertiq-983/authorisations"
    }
  }
}
```

```json
{
  "transactionStatus": "RCVD",
  "paymentId": "1234-wertiq-983",
  "_links": {
    "scaOAuth": {
      "href": "https://www.testbank.com/oauth/.well-known/oauth-authorization-server"
    },
    "self": {
      "href": "/psd2/v1/payments/1234-wertiq-983"
    },
    "status": {
      "href": "/psd2/v1/payments/1234-wertiq-983/status"
    },
    "scaStatus": {
      "href": "/psd2/v1/payments/1234-wertiq-983/authorisations/123auth456"
    }
  }
}
```

```json
{
  "transactionStatus": "RCVD",
  "paymentId": "1234-wertiq-983",
  "_links": {
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/1234-wertiq-983/authorisations"
    },
    "self": {
      "href": "/psd2/v1/payments/1234-wertiq-983"
    }
  }
}
```

```json
{
  "transactionStatus": "RCVD",
  "paymentId": "1234-wertiq-983",
  "_links": {
    "startAuthorisationWithPsuAuthentication": {
      "href": "/psd2/v1/payments/1234-wertiq-983/authorisations"
    },
    "self": {
      "href": "/psd2/v1/payments/1234-wertiq-983"
    }
  }
}
```

--------------------------------

### GET /v1/installment/checkout/{order_id}

Source: https://api.bog.ge/docs/en/installment/installment-details

Retrieves the current status and details of an installment loan process based on the order identifier.

```APIDOC
## GET /v1/installment/checkout/<order_id>

### Description
Allows an Online Shop to receive detailed information regarding the status of an installment loan completed by a customer based on the payment identifier.

### Method
GET

### Endpoint
/v1/installment/checkout/<order_id>

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The unique identifier for the order.

### Request Example
GET /v1/installment/checkout/12345 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <jwt_token>

### Response
#### Success Response (200)
- **order_id** (string) - An order identifier.
- **status** (string) - The order status (success, in_progress, error).
- **installment_status** (string) - The installment loan status (success, reject, reverse_success, fail, unknown).
- **ipay_payment_id** (string) - A payment ID in the ipay system.
- **shop_order_id** (string) - A Merchant’s order identifier.
- **payment_method** (string) - The payment method (always BOG_LOAN).

#### Response Example
{
  "order_id": "12345",
  "status": "success",
  "installment_status": "success",
  "ipay_payment_id": "PAY-98765",
  "shop_order_id": "SHOP-555",
  "payment_method": "BOG_LOAN"
}
```

--------------------------------

### Get Authorisation Status Request Example

Source: https://api.bog.ge/docs/en/bg-ofa-pis

This code snippet illustrates a GET request to check the SCA status of an authorisation or cancellation authorisation sub-resource. It uses the same base path as the Get Authorisation Sub-Resources request but targets a specific status endpoint.

```http
GET /v2/{resource-path}/{resourceId}/{authorisation-category}/status HTTP/1.1
Host: xs2a.bog.ge
X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
```

--------------------------------

### POST /authorisations/start

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Initiates a new SCA authorisation process for a PSU.

```APIDOC
## POST /authorisations/start

### Description
Initiates the SCA authorisation process and returns the current status and available methods.

### Method
POST

### Endpoint
/authorisations/start

### Response
#### Success Response (200)
- **scaStatus** (string) - Current status of the SCA process
- **authorisationId** (string) - Unique identifier for the authorisation
- **_links** (object) - Hypermedia links for further actions

#### Response Example
{
  "scaStatus": "psuIdentified",
  "authorisationId": "auth-123",
  "_links": { "self": { "href": "/authorisations/auth-123" } }
}
```

--------------------------------

### POST /payments/{payment-product}

Source: https://api.bog.ge/docs/en/bg-ofa-pis

Creates a payment initiation request for bulk payments at the ASPSP.

```APIDOC
## POST /payments/{payment-product}

### Description
Creates a payment initiation request at the ASPSP. Supports both JSON encoding and XML (ISO20022 pain.001) message formats.

### Method
POST

### Endpoint
/payments/{payment-product}

### Parameters
#### Path Parameters
- **payment-product** (string) - Required - The addressed payment product endpoint (e.g., "sepa-credit-transfers", "pain.001-sepa-credit-transfers").

### Request Example
{
  "paymentInformation": "Bulk payment details..."
}

### Response
#### Success Response (201)
- **transactionStatus** (string) - The status of the transaction.
- **paymentId** (string) - Unique identifier for the payment.
- **transactionFees** (object) - Fee details for the transaction.
- **scaMethods** (array) - List of available Strong Customer Authentication methods.
- **_links** (object) - HATEOAS links for further authorization steps.

#### Response Example
{
  "transactionStatus": "ACCC",
  "paymentId": "PAY-123456789",
  "transactionFees": {
    "currency": "EUR",
    "amount": "0.00"
  },
  "scaMethods": [
    {
      "authenticationType": "PUSH_OTP",
      "authenticationMethodId": "METH-001",
      "name": "Push OTP"
    }
  ],
  "_links": {
    "self": { "href": "/payments/sepa-credit-transfers/123" }
  }
}
```

--------------------------------

### GET /websites/api_bog_ge_en

Source: https://api.bog.ge/docs/en/installment/create-order

Retrieves the status and relevant links for an online installment loan. The links can be used to get loan details or to redirect the user to finalize the loan process.

```APIDOC
## GET /websites/api_bog_ge_en

### Description
Retrieves the status and relevant links for an online installment loan. The links can be used to get loan details or to redirect the user to finalize the loan process.

### Method
GET

### Endpoint
/websites/api_bog_ge_en

### Parameters
#### Query Parameters
- **order_id** (string) - Required - The unique identifier of the online installment loan order.

### Response
#### Success Response (200)
- **status** (string) - A status of the online installment loan.
- **links** (array) - URLs that are used on the further steps of the installment loan process. Each link object contains:
  - **href** (string) - A Web resource Address.
  - **rel** (string) - A Web resource unique name (e.g., 'self' for loan details, 'target' for redirection).
  - **method** (string) - An HTTP method that should be used to redirect on the web resource (e.g., 'GET', 'REDIRECT').
- **order_id** (string) - An unique identifier of the online installment loan order.

#### Response Example
```json
{
  "status": "CREATED",
  "links": [
      {
          "href": "https://installment-test.bog.ge/v1/installment/checkout/{order_id}",
          "rel": "self",
          "method": "GET"
      },
      {
          "href": "https://installment-test.bog.ge/?order_id={order_id}&locale=ka",
          "rel": "target",
          "method": "REDIRECT"
      }
    ],
  "order_id": "{order_id}"
}
```
```

--------------------------------

### Account List Example 2: Multicurrency Account with Sub-accounts (EUR/USD)

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

This example demonstrates a response for a multicurrency account with two sub-accounts (EUR and USD). Consent for transactions and balances is granted only at the sub-account level.

```json
{
  "accounts": [
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
      "iban": "GE00BG0000000000000001",
      "currency": "GEL",
      "product": "Current Account",
      "cashAccountType": "CACC",
      "name": "Georgian Lari Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
        },
        "transactions": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
      "iban": "GE00BG0000000000000001",
      "currency": "GEL",
      "product": "Current Account",
      "cashAccountType": "CACC",
      "name": "US Dollar Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
        },
        "transactions": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/transactions"
        }
      }
    }
  ]
}
```

--------------------------------

### Get Account Balances Request Example

Source: https://api.bog.ge/docs/en/openbanking

Example of a JSON request to retrieve account balances. This typically includes the account identifier and may be used with various API calls to fetch financial data.

```json
{
  "account": {
    "iban": "GE00BG0000000000000000"
  },
  "balances": [
    {
      "balanceType": "closingBooked",
      "balanceAmount": {
        "currency": "GEL",
        "amount": "500.00"
      },
      "referenceDate": "2021-03-31"
    },
    {
      "balanceType": "expected",
      "balanceAmount": {
        "currency": "GEL",
        "amount": "900.00"
      },
      "lastChangeDateTime": "2021-03-31T15:30:35.035Z"
    }
  ]
}
```

--------------------------------

### Consent Response (Redirect with Explicit Auth Start)

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Example response for a consent request using the redirect SCA method, where the authorization process needs to be explicitly started. It provides the consent ID and a link to initiate the authorization.

```json
{
  "consentStatus": "received",
  "consentId": "1234-wertiq-983",
  "_links": {
    "startAuthorisation": {
      "href": "/psd2/v1/consents/1234-wertiq-983/authorisations"
    }
  }
}
```

--------------------------------

### Example Request Headers for Authorisation Endpoint

Source: https://api.bog.ge/docs/en/openbanking

Illustrates common headers used when making a request to the authorisation endpoint. Includes mandatory headers like X-Request-ID and optional headers for security and user information.

```http
GET /0.8/v1/consents/12345/authorisations/67890 HTTP/1.1
Host: xs2a-sandbox.bog.ge
X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Digest: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
PSU-IP-Address: 192.168.8.78
PSU-Accept-Language: en-US
```

--------------------------------

### Buy Now Pay Later Visual Guide

Source: https://api.bog.ge/docs/en/payments/external-orders/modal

Information on how to access and use the Buy Now Pay Later (BNPL) visual guide for placing a 'Buy Now Pay Later' button on your page.

```APIDOC
## Buy Now Pay Later Visual Guide

### Description
If you intend to display a 'Buy Now Pay Later' button on your website, please refer to the provided BNPL visual guide. This guide contains assets and instructions for correctly implementing the button.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
- **Download Link** (URL) - A link to download the BNPL visual guide.
```

--------------------------------

### Card Account List Example 1: Basic Credit Card Details

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

This example provides a list of card accounts, specifically a 'Basic Credit' card. It includes masked PAN, currency, name, status, credit limit, and available balances.

```json
{
  "cardAccounts": [
    {
      "resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
      "maskedPan": "525412******3241",
      "currency": "GEL",
      "name": "Main",
      "product": "Basic Credit",
      "status": "enabled",
      "creditLimit": {
        "currency": "GEL",
        "amount": "15000"
      },
      "balances": [
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "GEL",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "nonInvoiced",
          "balanceAmount": {
            "currency": "GEL",
            "amount": "4175.86"
          }
        }
      ],
      "_links": {
        "transactions": {
          "href": "/psd2/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
        }
      }
    }
  ]
}
```

--------------------------------

### POST /authorisation/start

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Endpoints for initiating the authorisation process using various PSU authentication methods.

```APIDOC
## POST /authorisation/start

### Description
Initiates the authorisation process. Supports multiple methods including PSU identification, authentication, encrypted authentication, and method selection.

### Method
POST

### Endpoint
/authorisation/start

### Parameters
#### Request Body
- **startAuthorisation** (hrefType) - Optional - Link to start authorisation
- **startAuthorisationWithPsuIdentification** (hrefType) - Optional - Link to start with PSU identification
- **startAuthorisationWithPsuAuthentication** (hrefType) - Optional - Link to start with PSU authentication
- **startAuthorisationWithEncryptedPsuAuthentication** (hrefType) - Optional - Link to start with encrypted PSU authentication
- **startAuthorisationWithAuthenticationMethodSelection** (hrefType) - Optional - Link to start with method selection

### Request Example
{
  "startAuthorisationWithPsuIdentification": "/v1/authorisations/123/psu-identification"
}

### Response
#### Success Response (200)
- **scaStatus** (hrefType) - Link to retrieve SCA status
- **selectAuthenticationMethod** (hrefType) - Link to select authentication method

#### Response Example
{
  "scaStatus": "/v1/authorisations/123/status",
  "selectAuthenticationMethod": "/v1/authorisations/123/methods"
}
```

--------------------------------

### Response Sample for Payment Initiation Authorisation (JSON)

Source: https://api.bog.ge/docs/en/openbanking

This is a sample JSON response for a successful payment initiation authorisation request (201 Created). It includes the authorisation status, ID, and a PSU message.

```json
{
  "scaStatus": "received",
  "authorisationId": "123auth456",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}
```

--------------------------------

### GET /card-transactions/{transactionId}

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Retrieves specific details regarding card-based transactions, including terminal IDs, markup fees, and instalment information.

```APIDOC
## GET /card-transactions/{transactionId}

### Description
Provides specific data points for card transactions such as terminal identifiers and markup fee calculations.

### Method
GET

### Endpoint
/card-transactions/{transactionId}

### Request Body
- **transactionAmount** (object) - Required - The amount of the card transaction.
- **cardTransactionId** (string) - Optional - Unique identifier for the card transaction.
- **markupFeePercentage** (string) - Optional - Percentage of the markup fee applied.

### Response
#### Success Response (200)
- **terminalId** (string) - Identifier of the card terminal.
- **grandTotalAmount** (object) - Total amount including charges and taxes.
- **acceptorTransactionDateTime** (string) - Timestamp of the transaction.

#### Response Example
{
  "cardTransactionId": "CT-12345",
  "transactionAmount": { "amount": "50.00", "currency": "EUR" },
  "markupFeePercentage": "0.3"
}
```

--------------------------------

### Payment Initiation Response JSON

Source: https://api.bog.ge/docs/en/openbanking

Example JSON response returned upon successful payment initiation. It provides the transaction status, a unique payment ID, and HATEOAS links for authorization and status tracking.

```json
{
  "transactionStatus": "RCVD",
  "paymentId": "1234-wertiq-983",
  "_links": {
    "scaRedirect": {
      "href": "https://www.testbank.com/asdfasdfasdf"
    },
    "self": {
      "href": "/psd2/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "status": {
      "href": "/psd2/v1/payments/1234-wertiq-983/status"
    },
    "scaStatus": {
      "href": "/psd2/v1/payments/1234-wertiq-983/authorisations/123auth456"
    }
  }
}
```

--------------------------------

### POST /v1/{payment-service}/{payment-product}/{paymentId}/authorisations

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Starts the authorization process for a payment initiation.

```APIDOC
## POST /v1/{payment-service}/{payment-product}/{paymentId}/authorisations

### Description
Create an authorisation sub-resource and start the authorisation process. This method can be iterated for multi-SCA scenarios and is used when the ASPSP requires an explicit start of the authorisation process.

### Method
POST

### Endpoint
/v1/{payment-service}/{payment-product}/{paymentId}/authorisations

### Parameters
#### Path Parameters
- **payment-service** (string) - Required - The payment service identifier.
- **payment-product** (string) - Required - The payment product identifier.
- **paymentId** (string) - Required - The unique identifier for the payment.

#### Query Parameters
(No query parameters defined for this endpoint in the provided schema)

#### Request Body
(The request body structure depends on the specific authorisation initiation method, e.g., startAuthorisationWithPsuIdentification, startAuthorisationWithPsuAuthentication, etc. Refer to the API documentation for detailed schemas.)

### Request Example
```json
{
  "example": "POST /v1/payments/sepa-credit-transfers/12345/authorisations"
}
```

### Response
#### Success Response (201)
- **authorisationId** (string) - The unique identifier for the created authorisation.
- **scaStatus** (string) - The status of the Strong Customer Authentication (SCA).
- **challengeData** (object) - Data required for the SCA challenge, if applicable.

#### Response Example
```json
{
  "authorisationId": "auth-abc-123",
  "scaStatus": "psuAuthentication",
  "challengeData": {
    "challengeUrl": "https://example.com/challenge"
  }
}
```
```

--------------------------------

### Read Transaction Details API Request Example

Source: https://api.bog.ge/docs/en/openbanking

Example of a GET request to retrieve transaction details. It includes path parameters for account and transaction IDs, and various optional header parameters for enhanced request management and security. The response is expected in JSON format.

```http
GET /v1/accounts/{account-id}/transactions/{transactionId} HTTP/1.1
Host: xs2a-sandbox.bog.ge
X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Digest: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
x-jws-signature: <signature>
Consent-ID: <consent-id>
PSU-IP-Address: 192.168.8.78

```

--------------------------------

### Generate Account Statement (GET Request)

Source: https://api.bog.ge/docs/en/bonline/statement

This code snippet demonstrates how to make a GET request to the statement generation API. It requires account number, currency, start date, and end date as path parameters. The response includes statement details and transaction records.

```HTTP
GET api/statement/{accountNumber}/{currency}/{startDate}/{endDate}
```

--------------------------------

### POST /v1/{payment-service}/{payment-product} - Payment Initiation Request

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-0.yaml

Initiates a payment at the ASPSP. Supports various payment products like 'aspsp', 'domestic', and 'foreign', and payment services including 'payments', 'bulk-payments', and 'periodic-payments'.

```APIDOC
## POST /v1/{payment-service}/{payment-product}

### Description
Initiates a payment at the ASPSP. This method can be used with a JSON body and supports different payment products and services.

### Method
POST

### Endpoint
`/v1/{payment-service}/{payment-product}`

### Parameters
#### Path Parameters
- **payment-service** (string) - Required - The type of payment service (e.g., 'payments', 'bulk-payments', 'periodic-payments').
- **payment-product** (string) - Required - The payment product to use (e.g., 'aspsp', 'domestic', 'foreign').

#### Query Parameters
*None defined in this section.*

#### Request Body
*The structure of the request body depends on the `payment-service` and `payment-product`.
Refer to the implementation guidelines for specific details.*

### Request Example
```json
{
  "example": "Request body structure varies based on payment-service and payment-product. Please consult the implementation guidelines."
}
```

### Response
#### Success Response (201 Created)
*The response structure depends on the specific payment initiation and may include a `paymentId`.*

#### Response Example
```json
{
  "example": "Response body structure varies. A typical response might include a payment ID upon successful initiation."
}
```

#### Error Handling
*Standard HTTP error codes will be returned for invalid requests or other issues.*

```

--------------------------------

### POST /v2/bulk-payments/{payment-product}

Source: https://api.bog.ge/docs/en/redocusaurus/plugin-redoc-2.yaml

Initiates a payment initiation request for bulk payments at the ASPSP. This endpoint supports various payment schemas and content types, and requires specific headers for security and request details.

```APIDOC
## POST /v2/bulk-payments/{payment-product}

### Description
Initiates a payment initiation request at the ASPSP for bulk payments. This endpoint adheres to PSD2 Interface Implementation Guidelines for bulk payment initiation using JSON or XML encoding.

### Method
POST

### Endpoint
/v2/bulk-payments/{payment-product}

### Parameters
#### Path Parameters
- **payment-product** (string) - Required - The payment product identifier for bulk payments.

#### Query Parameters
None

#### Request Body
- **application/json**: Schema can be one of BulkPayment_SCT_Core, BulkPayment_SCT_inst_Core, BulkPayment_Target2_Core, or BulkPayment_Cross_Border_CT_Core.
- **application/xml**: A string representing the pain.001 structure corresponding to the Credit Transfer schema for the respective service.

### Request Example
```json
{
  "example": "Request body for bulk payment initiation (JSON or XML)"
}
```

### Response
#### Success Response (201)
- **Created**: Indicates the payment initiation request has been successfully created.

#### Error Responses
- **400**: Bad Request
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not Found
- **405**: Method Not Allowed
- **406**: Not Acceptable
- **408**: Request Timeout
- **409**: Conflict
- **415**: Unsupported Media Type
- **500**: Internal Server Error
- **503**: Service Unavailable

#### Response Example
```json
{
  "example": "Response body for successful creation or error details"
}
```
```