Introduction

The Monext Online API is RESTful, meaning that it uses HTTP verbs (POST, PUT, GET...) to perform functions on resources.

Specifically, POST is used to create a resource, PUT to update a resource, and GET to retrieve a resource or a collection of resources.

For example, to create a new wallet resource you would send a POST requests to Wallets.

POST and PUT requests usually require data to be passed in the message body to define the attributes of the object being created or updated.

Versioning

The API version is indicated in each endpoint resource path. For example, https://api-sandbox.retail.monext.com/v1/ indicates the API is at version 1.

Monext Online increments the version number when it releases a new version containing backwards-incompatible changes.

Some minor changes, mostly for improvements, could happen without version changes.

Open API Specifications

The Open API specification files : Open API Specification files

Postman

Postman collection

Endpoints

Environment	Base URL
Production	https://api.retail.monext.com
Sandbox	https://api-sandbox.retail.monext.com

Security

The Monext Online API processes sensitive data. That's why we pay special attention to security.

Monext Online data centers deploy the latest in hardware and software security best practices.
Communication with all Monext Online services requires TLS1.2.
All communication is made by using standard features of HTTPs.
Monext Online maintains PCI-DSS compliance certifications.

Authentication

Monext Retail API requires authentication for all requests.

To access the API, you must contact Monext to obtain your merchantId and API Key.

Monext authenticates the HTTP user agent using the Basic Access Authentication method. The API Key must be included in the HTTP Authorization header as follows:

Authorization: Basic Base64Encode(merchantId:APIKey)

Make sure to replace merchantId and APIKey with your own credentials.

Responses

Monext Online API calls return HTTP status codes. Some API calls also return JSON response bodies that include information about the resource. When you create any Monext Online resource, the system associates an internal unique identifier for referencing that resource.

HTTP Status Code

Each API call returns a success or error HTTP status codes following the RFC7231.

Success

The following status codes of HTTP are used: 2xx - the request was successfully accepted and was or will be processed.

Error

The following status codes of HTTP are used:

4xx - the request was rejected due to a problem with the information sent by the client.

5xx - something unexpected occurred while fulfilling the request; the request may or may not have been processed, depending on the error.

Whenever a client receives a 5xx response, it should not assume anything about the processing state of such request.

Help and support

If you need support or further information, please contact Monext Retail Support Team.

Glossary


MXWallet	Virtual wallet handled by Monext that stores one or several payment instruments of a holder. It's a convenient and secure tools to handle recurring or one click payments. The virtual wallet can contain several payment instruments referenced by a 'paymentInstrumentRank'.
Payment Instrument	It represents an identified payment instrument of a holder used for the transmission or payment of money or monetary value. It may be a : * credit card (AmEx, Bancontact, CB, Mastercard, etc...) * Paypal account; * XPay account; * bank account ; * etc…
PaymentInstrumentRank	Index used in a MXWallet to distinguish the different payment instruments.
Payment InstrumentType	The payment instrument type groups payment instruments of the same type. Payment Instrument type is characterized by a code, paymentInstrumentCode, and a name, paymentInstrumentName. The code is a Monext internal value that never changes and the name is the public name given by the PSP that may change along the time. The payment instrument type is charactrized by its code which is a Monext code and its name which is the commercial name of the payement instrument.
paymentMethodID	Identifier of the Monext digital entity representing either the merchant acquiring contract or the Payment Service Provider contract.
PaymentType	Specifies the payment use case ; for example ONE_OFF, RECURRING, INSTALLMENT, ...