Skip to main content

Onboard as a provider

Fiat on-ramp providers who seek to integrate their service into the MetaMask Fiat On-Ramp must use the following process.

Process overview​

  1. Review the integration requirements and discuss with the On-Ramp team the compatibility of the provider solution.

  2. Decide if the provider will meet the On-Ramp technical specifications or if the On-Ramp team must develop a dedicated connector. This decision will have a strong impact on the release schedule of the integration.

  3. Implement the On-Ramp technical specifications, or provide documentation on a custom implementation and let the MetaMask On-Ramp team create the connector.

  4. Submit provider information to the On-Ramp team.

  5. Give the On-Ramp team access to two web servers:

    • A staging environment with test data and authentication and payment methods.
    • A production environment.

The On-Ramp team then:

  1. Reviews and validates the information.
  2. Extensively tests the web servers and its integration into the On-Ramp.

Once all tests are validated, the provider integration is enabled in the MetaMask On-Ramp server. If the MetaMask On-Ramp technical specifications are used, the On-Ramp team can enable the provider solution with a simple switch in the server without requiring any software updates.

Integration methods​

On-ramp providers have two ways to integrate with the MetaMask Fiat On-Ramp:

  • Standard integration - The provider implements the MetaMask On-Ramp technical specifications using OpenAPI (for example, using Swagger). See the OpenAPI specification. This is the quickest way to integrate.

  • Custom integration - The On-Ramp team can create a connector to the provider implementation which doesn't conform to the MetaMask On-Ramp technical specifications. This requires more work from the On-Ramp team and takes more time. The required time depends on the existing features of the target provider solution.

    important

    A custom integration may require more maintenance effort from MetaMask and might impact user experience.

Provider information​

All providers must submit the following information to the MetaMask On-Ramp team:

  • The provider name (as displayed to users)

  • Dark and light logos (size and resolution to be communicated later)

  • A short description of the provider (500 characters maximum, written in English)

  • The business address of the provider

  • A list of labeled links (for example, "Homepage": "https://…", "Terms of service": "https://…")

    important

    Provider information is submitted to ConsenSys but can't be updated without ConsenSys validation.

Integration testing​

Once an integration has been implemented, it can be tested using our testing environment. An activation key is given to each provider to enable their specific features. Only people with this key can see the provider features not released to production.