@monei-js/node-sdk
Version:
Node.js SDK for MONEI Digital Payment Gateway
45 lines (44 loc) • 3.96 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.7.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
* @export
* @interface PaymentNextAction
*/
export interface PaymentNextAction {
/**
* - `CONFIRM` - Your customer needs to be redirected to a [hosted payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page/) or confirm payment using [payment token](https://docs.monei.com/integrations/build-custom-checkout/#3-confirm-the-payment-client-side). The **redirectUrl** will point to the hosted payment page. - `FRICTIONLESS_CHALLENGE` - Your customer needs to be redirected to the frictionless 3d secure challenge page provided by the bank. The **redirectUrl** will point to the frictionless 3d secure challenge page provided by the bank. - `CHALLENGE` - Your customer needs to be redirected to the 3d secure challenge page provided by the bank. The **redirectUrl** will point to the 3d secure challenge page provided by the bank. - `COMPLETE` - The payment is completed. The **redirectUrl** will be the **completeUrl** if it was provided when the payment was created. - `BIZUM_CHALLENGE` - Your customer will be redirected to the Bizum hosted payment page.
* @type {string}
* @memberof PaymentNextAction
*/
type?: PaymentNextActionTypeEnum;
/**
* If `true` you have to redirect your customer to the **redirectUrl** to continue payment process.
* @type {boolean}
* @memberof PaymentNextAction
*/
mustRedirect?: boolean;
/**
* Redirect your customer to this url to continue payment process.
* @type {string}
* @memberof PaymentNextAction
*/
redirectUrl?: string;
}
export declare const PaymentNextActionTypeEnum: {
readonly CONFIRM: "CONFIRM";
readonly CHALLENGE: "CHALLENGE";
readonly FRICTIONLESS_CHALLENGE: "FRICTIONLESS_CHALLENGE";
readonly BIZUM_CHALLENGE: "BIZUM_CHALLENGE";
readonly COMPLETE: "COMPLETE";
};
export type PaymentNextActionTypeEnum = (typeof PaymentNextActionTypeEnum)[keyof typeof PaymentNextActionTypeEnum];