Go API client for zibal

Combined API for Zibal Gateway and Facilities (Verification, Wallet, etc.)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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:

import zibal "github.com/sajadsafary/zibal"

To use a proxy, set the environment variable HTTP_PROXY:

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 zibal.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), zibal.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 zibal.ContextOperationServerIndices and zibal.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), zibal.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), zibal.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
FacilitiesAPI	FacilityAccountToIbanPost	Post /facility/accountToIban	Bank Account To IBAN
FacilitiesAPI	FacilityCardToAccountPost	Post /facility/cardToAccount	Card To Bank Account
FacilitiesAPI	FacilityCardToIbanPost	Post /facility/cardToIban	Card To IBAN
FacilitiesAPI	FacilityCheckCardWithNationalCodePost	Post /facility/checkCardWithNationalCode	Check Card With National Code
FacilitiesAPI	FacilityNationalIdentityInquiryPost	Post /facility/nationalIdentityInquiry	National Identity Inquiry
FacilitiesAPI	FacilityShahkarInquiryPost	Post /facility/shahkarInquiry	Shahkar Inquiry
FacilitiesAPI	WalletCheckoutPlusPost	Post /wallet/checkout/plus	Wallet Checkout Plus
GatewayAPI	RequestLazyPost	Post /request/lazy	Initiate Lazy Payment
GatewayAPI	RequestPost	Post /request	Initiate Payment
GatewayAPI	StartTrackIdGet	Get /start/{trackId}	Get payment page
GatewayAPI	VerifyPost	Post /verify	Verify Payment

Documentation For Models

• BankAccountToIbanRequest
• BankAccountToIbanResponse
• BankAccountToIbanResponseData
• CardToAccountRequest
• CardToAccountResponse
• CardToAccountResponseData
• CardToIbanRequest
• CardToIbanResponse
• CardToIbanResponseData
• CheckCardWithNationalCodeRequest
• CheckCardWithNationalCodeResponse
• ErrorResponse
• LazyPaymentInitRequest
• LazyPaymentInitResponse
• NationalIdentityInquiryRequest
• NationalIdentityInquiryResponse
• NationalIdentityInquiryResponseData
• PaymentInitRequest
• PaymentInitResponse
• PaymentVerifyRequest
• PaymentVerifyResponse
• ShahkarInquiryRequest
• ShahkarInquiryResponse
• ShahkarInquiryResponseData
• WalletCheckoutPlusRequest
• WalletCheckoutPlusResponse
• WalletCheckoutPlusResponseData

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), zibal.ContextAccessToken, "BEARER_TOKEN_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