Skip to main content

Testing the Platform API

We provide several tools to help you test our API. From our OpenAPI specification to our test institutions, you can make requests to our API to learn more about integrating your application with our connectivity solutions.

When To Use MX Bank vs. MXCU​

We offer four test institutions that you can use:

  • MXCU (OAuth) takes you through a hypothetical OAuth flow that results in the MX platform receiving an OAuth token it uses to connect the member.
  • MXCU (Credential) is a credential-based authentication where you'll enter the MXCU credentials.
  • MX Bank has more account types and features available than both MXCU institutions. It also lets you test different connection statuses.
  • MX Bank (OAuth) previously was our only test institution for OAuth flows. We recommend you instead use the MXCU (OAuth) institution if you want to test an OAuth-flow since it offers a full OAuth experience.

If you plan on using an MXCU test institution, see Testing with MXCU

If you plan on using an MX Bank test institution, see Testing with MX Bank

Using our API with Postman​

Use Postman to learn more about our API and its request and response payloads. If you haven't already, we encourage you to download Postman. If you need more information on how to use Postman, visit their Learning Center.

We currently host an OpenAPI Specification that can be imported as a Postman collection. You can visit our spec on our GitHub or import it directly using the following link.


_10
https://raw.githubusercontent.com/mxenabled/openapi/master/openapi/mx_platform_api.yml

When using our OpenAPI specification in Postman you'll need your api_key and client_id from the Client Dashboard. This can be used with Basic Authentication where your client_id is the username and your api_key is the password.

info

Our OpenAPI specification currently uses tags to gather common requests together. When you import the specification as a collection, we encourage you to set the folder organization to "Tags" for the best experience.

On this page