The Mangopay Node.js SDK makes working with the Mangopay API easier in a Node.js environment. This SDK is open-source and available on GitHub.
Mangopay Node.js SDK →Prerequisites
To run the Mangopay Node.js SDK, you’ll need:
ClientId
and an API key – if you don’t have these, contact Sales to get access to the Mangopay DashboardNote - Mangopay SDK compatibility
The Node.js SDK is only compatible with the v2.01 version of the Mangopay API.
The configuration object of the SDK supports all the following properties:
Key | Type | Default value | Description |
---|---|---|---|
clientId | string | null | Your Mangopay ClientId – can be found in the Dashboard. |
clientApiKey | string | null | Your Mangopay API key – can be found in the Dashboard. |
baseUrl | string | http://api.sandbox.mangopay.com/ | The API sandbox URL. Set to the sandbox environment by default. To enable production environment, set it to http://api.mangopay.com/ |
debugMode | boolean | false | Activates the debug mode. Recommended only in Sandbox. |
logClass | function() {console.log(arguments)} | function() {console.log(arguments)} | |
connectionTimeout | integer | 30000 | Set the time to wait (in milliseconds) while trying to establish a connection before terminating the attempt and generating an error. |
responseTimeout | integer | 80000 | Set response timeout limit (in milliseconds). |
apiVersion | string | v2.01 | The API version. |
errorHandler | null | function(options, err) {console.error(options, err)} | Set a custom error handler. |
ukHeaderFlag | boolean | false | Platforms that have contracted with Mangopay’s UK entity (MANGOPAY U.K. LIMITED) must include the following header in all requests. If you’re using an SDK, you need to set it to true . |
All endpoints are documented with the related Node.js SDK method throughout the Mangopay documentation. The code examples provided should be adjusted for your usage.
The SDK is compatible with TypeScript and provides a set of predefined models. They are available in the /lib/models/ GitHub folder.
Across the Mangopay endpoint documentation, the usage of the SDK is documented with promises. If you prefer callbacks, here is an example on how to use them:
For endpoints that support pagination and filtering, you can use options.parameters
to specify these options:
For reading the server response headers, you can use resolveWithFullResponse. This is useful to access information about the pagination or rate limiting.
Found a problem with the SDK? Create an issue on GitHub:
Report an issue →