https://github.com/iota-uz/click

IOTA Go client for the CLICK Pass API — work with payments, invoices, and fiscalization in your Go applications. Generated with OpenAPI Generator. Includes support for API key auth, server configuration, and handy utility helpers
https://github.com/iota-uz/click

api-client click click-pass go openapi

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/iota-uz/click
Owner: iota-uz
License: apache-2.0
Created: 2025-05-05T07:29:39.000Z (11 months ago)
Default Branch: main
Last Pushed: 2025-05-16T07:02:53.000Z (11 months ago)
Last Synced: 2025-05-16T07:33:48.149Z (11 months ago)
Topics: api-client, click, click-pass, go, openapi
Language: Mustache
Homepage: https://www.iota.uz
Size: 81.1 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

          # Go API client for clickapi

API for managing payments and fiscalization with CLICK Pass.

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 1.0.0

- Package version: 1.0.0

- Build date: 2025-05-16T12:32:01.201873300+05:00[Asia/Tashkent]

- Generator version: 7.9.0

- Build package: org.openapitools.codegen.languages.GoClientCodegen

For more information, please visit [https://www.iota.uz](https://www.iota.uz)

## Installation

Install the following dependencies:

```sh

go get github.com/stretchr/testify/assert

go get golang.org/x/net/context

```

Put the package under your project folder and add the following in import:

```go

import clickapi "github.com/iota-uz/click/clickapi"

```

To use a proxy, set the environment variable `HTTP_PROXY`:

```go

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `clickapi.ContextServerIndex` of type `int`.

```go

ctx := context.WithValue(context.Background(), clickapi.ContextServerIndex, 1)

```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `clickapi.ContextServerVariables` of type `map[string]string`.

```go

ctx := context.WithValue(context.Background(), clickapi.ContextServerVariables, map[string]string{

	"basePath": "v2",

})

```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.

An operation is uniquely identified by `"{classname}Service.{nickname}"` string.

Similar rules for overriding default operation server index and variables applies by using `clickapi.ContextOperationServerIndices` and `clickapi.ContextOperationServerVariables` context maps.

```go

ctx := context.WithValue(context.Background(), clickapi.ContextOperationServerIndices, map[string]int{

	"{classname}Service.{nickname}": 2,

})

ctx = context.WithValue(context.Background(), clickapi.ContextOperationServerVariables, map[string]map[string]string{

	"{classname}Service.{nickname}": {

		"port": "8443",

	},

})

```

## Documentation for API Endpoints

All URIs are relative to *https://api.click.uz*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*CardAPI* | [**CreateCardToken**](docs/CardAPI.md#createcardtoken) | **Post** /v2/merchant/card_token/request | Create card token

*CardAPI* | [**DeleteCardToken**](docs/CardAPI.md#deletecardtoken) | **Delete** /v2/merchant/card_token/{service_id}/{card_token} | Delete card token

*CardAPI* | [**VerifyCardToken**](docs/CardAPI.md#verifycardtoken) | **Post** /v2/merchant/card_token/verify | Verify card token

*FiscalizationAPI* | [**GetFiscalData**](docs/FiscalizationAPI.md#getfiscaldata) | **Get** /v2/merchant/payment/ofd_data/{service_id}/{payment_id} | Retrieving fiscal data (URL)

*FiscalizationAPI* | [**SubmitFiscalItems**](docs/FiscalizationAPI.md#submitfiscalitems) | **Post** /v2/merchant/payment/ofd_data/submit_items | Fiscalization of goods and services

*FiscalizationAPI* | [**SubmitFiscalQRCode**](docs/FiscalizationAPI.md#submitfiscalqrcode) | **Post** /v2/merchant/payment/ofd_data/submit_qrcode | Registering already fiscalized check

*InvoiceAPI* | [**CheckInvoiceStatus**](docs/InvoiceAPI.md#checkinvoicestatus) | **Get** /v2/merchant/invoice/status/{service_id}/{invoice_id} | Invoice status check

*InvoiceAPI* | [**CreateInvoice**](docs/InvoiceAPI.md#createinvoice) | **Post** /v2/merchant/invoice/create | Create invoice

*PaymentAPI* | [**CheckPaymentStatus**](docs/PaymentAPI.md#checkpaymentstatus) | **Get** /v2/merchant/payment/status/{service_id}/{payment_id} | Payment status check

*PaymentAPI* | [**CheckPaymentStatusByMTI**](docs/PaymentAPI.md#checkpaymentstatusbymti) | **Get** /v2/merchant/payment/status_by_mti/{service_id}/{merchant_trans_id} | Payment status check by merchant_trans_id

*PaymentAPI* | [**ConfirmPayment**](docs/PaymentAPI.md#confirmpayment) | **Post** /v2/merchant/click_pass/confirm | Payment confirmation

*PaymentAPI* | [**CreatePaymentWithClickPass**](docs/PaymentAPI.md#createpaymentwithclickpass) | **Post** /v2/merchant/click_pass/payment | Payment with CLICK Pass

*PaymentAPI* | [**DisableConfirmationMode**](docs/PaymentAPI.md#disableconfirmationmode) | **Delete** /v2/merchant/click_pass/confirmation/{service_id} | Disable confirmation mode

*PaymentAPI* | [**EnableConfirmationMode**](docs/PaymentAPI.md#enableconfirmationmode) | **Put** /v2/merchant/click_pass/confirmation/{service_id} | Enable confirmation mode

*PaymentAPI* | [**PartialRefund**](docs/PaymentAPI.md#partialrefund) | **Delete** /v2/merchant/payment/partial_reversal/{service_id}/{payment_id}/{amount} | Partial refund

*PaymentAPI* | [**PaymentWithToken**](docs/PaymentAPI.md#paymentwithtoken) | **Post** /v2/merchant/card_token/payment | Payment with token

*PaymentAPI* | [**ReversePayment**](docs/PaymentAPI.md#reversepayment) | **Delete** /v2/merchant/payment/reversal/{service_id}/{payment_id} | Payment reversal (cancel)

## Documentation For Models

 - [CardTokenRequest](docs/CardTokenRequest.md)

 - [CardTokenResponse](docs/CardTokenResponse.md)

 - [CardTokenVerifyRequest](docs/CardTokenVerifyRequest.md)

 - [CardTokenVerifyResponse](docs/CardTokenVerifyResponse.md)

 - [ClickPassPaymentRequest](docs/ClickPassPaymentRequest.md)

 - [ClickPassPaymentResponse](docs/ClickPassPaymentResponse.md)

 - [CommissionInfo](docs/CommissionInfo.md)

 - [CompleteRequest](docs/CompleteRequest.md)

 - [CompleteResponse](docs/CompleteResponse.md)

 - [ConfirmationModeResponse](docs/ConfirmationModeResponse.md)

 - [DeleteCardTokenResponse](docs/DeleteCardTokenResponse.md)

 - [FiscalDataResponse](docs/FiscalDataResponse.md)

 - [FiscalQRCodeRequest](docs/FiscalQRCodeRequest.md)

 - [FiscalQRCodeResponse](docs/FiscalQRCodeResponse.md)

 - [FiscalizationRequest](docs/FiscalizationRequest.md)

 - [FiscalizationResponse](docs/FiscalizationResponse.md)

 - [InvoiceRequest](docs/InvoiceRequest.md)

 - [InvoiceResponse](docs/InvoiceResponse.md)

 - [InvoiceStatusResponse](docs/InvoiceStatusResponse.md)

 - [Item](docs/Item.md)

 - [PartialRefundResponse](docs/PartialRefundResponse.md)

 - [PaymentConfirmationRequest](docs/PaymentConfirmationRequest.md)

 - [PaymentConfirmationResponse](docs/PaymentConfirmationResponse.md)

 - [PaymentReversalResponse](docs/PaymentReversalResponse.md)

 - [PaymentStatusByMTIResponse](docs/PaymentStatusByMTIResponse.md)

 - [PaymentStatusResponse](docs/PaymentStatusResponse.md)

 - [PrepareRequest](docs/PrepareRequest.md)

 - [PrepareResponse](docs/PrepareResponse.md)

 - [TokenPaymentRequest](docs/TokenPaymentRequest.md)

 - [TokenPaymentResponse](docs/TokenPaymentResponse.md)

## Documentation For Authorization

Authentication schemes defined for the API:

### AuthHeader

- **Type**: API key

- **API key parameter name**: Auth

- **Location**: HTTP header

Note, each API key must be added to a map of `map[string]APIKey` where the key is: AuthHeader and passed in as the auth context for each request.

Example

```go

auth := context.WithValue(

		context.Background(),

		clickapi.ContextAPIKeys,

		map[string]clickapi.APIKey{

			"AuthHeader": {Key: "API_KEY_STRING"},

		},

	)

r, err := client.Service.Operation(auth, args)

```

## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains

a number of utility functions to easily obtain pointers to values of basic types.

Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`

* `PtrInt`

* `PtrInt32`

* `PtrInt64`

* `PtrFloat`

* `PtrFloat32`

* `PtrFloat64`

* `PtrString`

* `PtrTime`

## Author

danil@iota.uz

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/iota-uz/click

Awesome Lists containing this project

README