ClientId
and an API key – if you don’t have these, contact Sales to get access to the Mangopay DashboardKey | Type | Default value | Description |
---|---|---|---|
setClientId | string | None | Your Mangopay ClientId – can be found in the Dashboard. |
setClientPassword | string | None | Your Mangopay API key – can be found in the Dashboard. |
setBaseUrl | string | https://api.sandbox.mangopay.com/v2.01/ | The API sandbox URL. Set to the sandbox environment by default. To enable production environment, set it to https://api.mangopay.com |
setConnectTimeout | integer | 60000 | Time to wait in milliseconds while trying to establish a connection before terminating the attempt and generating an error. |
setReadTimeout | integer | 60000 | Time to wait in milliseconds to receive a response before terminating the attempt and generating an error. |
setDebugMode | boolean | false | Activates the debug mode. Recommended only in Sandbox. |
setUkHeaderFlag | 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 . |
idempotencyKey
parameter to your function.
For more information, see the Idempotency article.
Pagination
and Sorting
objects.
In the Pagination
object, you need to specify the page and items per page to return.
In the Sorting
object, you need to use the addField()
method to specify the sort direction.
As a result, the answer will be paginated, and the total number of items and the total number of pages will be provided.
For example, with the List all Users endpoint: