comgate-payment-types

The types were created based on documentation available here.

Disclaimer

This library is an unofficial and it is not endorsed by or affiliated with Comgate.

Project Structure

Types (/src/types)

In the src/types directory, you will find TypeScript types corresponding to the Comgate API. These types are rewritten based on the official Comgate documentation. Each file includes the date of creation or last update, along with a link to the relevant section of the Comgate documentation.

Example:

src/types/
  create.ts 
  cancel.ts 

Installation

To install this package, use npm and add it as a development dependency to your project. Run the following command in your project directory:

npm i -D comgate-payment-types

Usage

This library only defines the types based on the documentation, therefore the usage is infinite and depends highly on you and your implementation.

I recommend checking the files in the src/types directory and then using them in your project.

Each type is exported, documentated and can be actually just copy-pasted into your project without installing the library.

An example of usage:

import type { IPaymentCreate, IPaymentCreateResponse } from 'comgate-payment-types'

const created_payment = async (options: IPaymentCreate): Promise<IPaymentCreateResponse> => {
  return new Promise((resolve, reject) => {
    // ... your logic here ...
  })
}

License

This project is licensed under the MIT License. See the LICENSE file for details.