@monei-js/node-sdk
Version:
Node.js SDK for MONEI Digital Payment Gateway
76 lines (75 loc) • 7.68 kB
TypeScript
/**
* MONEI API v1
* The MONEI API is organized around REST principles. Our API is designed to be intuitive and developer-friendly. ### Base URL All API requests should be made to: ``` https://api.monei.com/v1 ``` ### Environment MONEI provides two environments: - **Test Environment**: For development and testing without processing real payments - **Live Environment**: For processing real transactions in production ### Client Libraries We provide official SDKs to simplify integration: - [PHP SDK](https://github.com/MONEI/monei-php-sdk) - [Python SDK](https://github.com/MONEI/monei-python-sdk) - [Node.js SDK](https://github.com/MONEI/monei-node-sdk) - [Postman Collection](https://postman.monei.com/) Our SDKs handle authentication, error handling, and request formatting automatically. You can download the OpenAPI specification from the https://js.monei.com/api/v1/openapi.json and generate your own client library using the [OpenAPI Generator](https://openapi-generator.tech/). ### Important Requirements - All API requests must be made over HTTPS - If you are not using our official SDKs, you **must provide a valid `User-Agent` header** with each request - Requests without proper authentication will return a `401 Unauthorized` error ### Error Handling The API returns consistent error codes and messages to help you troubleshoot issues. Each response includes a `statusCode` attribute indicating the outcome of your request. ### Rate Limits The API implements rate limiting to ensure stability. If you exceed the limits, requests will return a `429 Too Many Requests` status code.
*
* The version of the OpenAPI document: 1.8.3
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from '../axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { ApplePayCertificatesRemove200Response } from '../model';
import type { RegisterApplePayDomainRequest } from '../model';
/**
* ApplePayDomainApi - axios parameter creator
* @export
*/
export declare const ApplePayDomainApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Registers a domain with Apple Pay. This endpoint allows you to register your website domain with Apple Pay, which is required before you can accept Apple Pay payments on your website. The domain must be accessible via HTTPS and have a valid SSL certificate. Before registering, you must download this [domain association file](https://assets.monei.com/apple-pay/apple-developer-merchantid-domain-association/) and host it at `/.well-known/apple-developer-merchantid-domain-association` on your site. For example, if you\'re registering `example.com`, make that file available at `https://example.com/.well-known/apple-developer-merchantid-domain-association`. After registration, Apple will verify your domain. Once verified, you can display Apple Pay buttons and process Apple Pay payments on your website.
* @summary Register Domain
* @param {RegisterApplePayDomainRequest} registerApplePayDomainRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
register: (registerApplePayDomainRequest: RegisterApplePayDomainRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ApplePayDomainApi - functional programming interface
* @export
*/
export declare const ApplePayDomainApiFp: (configuration?: Configuration) => {
/**
* Registers a domain with Apple Pay. This endpoint allows you to register your website domain with Apple Pay, which is required before you can accept Apple Pay payments on your website. The domain must be accessible via HTTPS and have a valid SSL certificate. Before registering, you must download this [domain association file](https://assets.monei.com/apple-pay/apple-developer-merchantid-domain-association/) and host it at `/.well-known/apple-developer-merchantid-domain-association` on your site. For example, if you\'re registering `example.com`, make that file available at `https://example.com/.well-known/apple-developer-merchantid-domain-association`. After registration, Apple will verify your domain. Once verified, you can display Apple Pay buttons and process Apple Pay payments on your website.
* @summary Register Domain
* @param {RegisterApplePayDomainRequest} registerApplePayDomainRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
register(registerApplePayDomainRequest: RegisterApplePayDomainRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplePayCertificatesRemove200Response>>;
};
/**
* ApplePayDomainApi - factory interface
* @export
*/
export declare const ApplePayDomainApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Registers a domain with Apple Pay. This endpoint allows you to register your website domain with Apple Pay, which is required before you can accept Apple Pay payments on your website. The domain must be accessible via HTTPS and have a valid SSL certificate. Before registering, you must download this [domain association file](https://assets.monei.com/apple-pay/apple-developer-merchantid-domain-association/) and host it at `/.well-known/apple-developer-merchantid-domain-association` on your site. For example, if you\'re registering `example.com`, make that file available at `https://example.com/.well-known/apple-developer-merchantid-domain-association`. After registration, Apple will verify your domain. Once verified, you can display Apple Pay buttons and process Apple Pay payments on your website.
* @summary Register Domain
* @param {RegisterApplePayDomainRequest} registerApplePayDomainRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
register(registerApplePayDomainRequest: RegisterApplePayDomainRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplePayCertificatesRemove200Response>;
};
/**
* ApplePayDomainApi - object-oriented interface
* @export
* @class ApplePayDomainApi
* @extends {BaseAPI}
*/
export declare class ApplePayDomainApi extends BaseAPI {
/**
* Registers a domain with Apple Pay. This endpoint allows you to register your website domain with Apple Pay, which is required before you can accept Apple Pay payments on your website. The domain must be accessible via HTTPS and have a valid SSL certificate. Before registering, you must download this [domain association file](https://assets.monei.com/apple-pay/apple-developer-merchantid-domain-association/) and host it at `/.well-known/apple-developer-merchantid-domain-association` on your site. For example, if you\'re registering `example.com`, make that file available at `https://example.com/.well-known/apple-developer-merchantid-domain-association`. After registration, Apple will verify your domain. Once verified, you can display Apple Pay buttons and process Apple Pay payments on your website.
* @summary Register Domain
* @param {RegisterApplePayDomainRequest} registerApplePayDomainRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ApplePayDomainApi
*/
register(registerApplePayDomainRequest: RegisterApplePayDomainRequest, options?: RawAxiosRequestConfig): Promise<ApplePayCertificatesRemove200Response>;
}