Introduction

Basic Principles

Welcome to the Marlim.co API Reference Guide for Western Union Global! Our API is RESTful and it is through it that you integrate your system with ours.

All calls to our API are using the common REST verbs and all responses are returned in JSON format.

Environments

To transact with Marlim.co you have access to two different API Keys and two different Environments: Sandbox and Production. In this way, it is possible to differentiate the environment by choosing the appropriate api_key and the base endpoint for the type of operation you want to perform, following the guidance below:

Sandbox

https://sandbox.api.wu.global.marlim.co

Production

https://api.wu.global.marlim.co

warning

The authentication keys for the production environment have the power to perform any operation in our API, so it is extremely important that you keep them in a safe place, and that you do not expose them on the client-side of your application.

Authentication

Whenever your application calls one of our endpoints, you must pass your API Key added to the Header of the request as a form of authentication, using the following format:

"api_key": "sua_api_key_value"

Note

Your api key must be requested from our Support or Development team.

Response Codes

Our API uses standard HTTP codes as a return to indicate both the success of a request and to indicate failure. He follows:

Code	Meaning
200	Everything went as it should and your request was successfully processed.
400	Some mandatory parameter was not passed, or the parameters passed are not correct.
401	Lack of authorization to access this endpoint.
403	The value passed in the parameter is incorrect.
404	Endpoint or some value not found.
405	Unauthorized method.
408	60 seconds timeout reached.
500	Internal Marlim error, please try again. If it continues, please contact us.

Version

The most current version of the API is: v1