Skip to main content

Checklist

Enterprises and Marketplaces can integrate with the uP API using the following steps:

Integration steps

  1. API walkthrough: during this step members of the NomuPay team will help you understand how to integrate with the uP API by:

    • Providing a detailed overview of the integration process, discussing and agreeing on proposed timelines and milestones, establishing guidelines concerning communication and meeting cadence, and aligning on roles and expectations for all involved parties.

    • Walking you through the uP Payout API Reference to ensure your team is comfortable with the uP API documentation. Our team will be available throughout your integration to provide additional guidance and answer any questions that may arise.

    • Explaining the notion of webhooks, and how you can use them with your uP API integration.

  2. Sandbox setup Once you have completed the API walkthrough, a member of the NomuPay team will provide you with your Sandbox API credentials. Please note that https://api.sandbox.nomupay.com is the service endpoint for the Sandbox uP API environment.

  3. Integration testing and certification Once you’ve received your sandbox API credentials you can start your integration testing. Besides validating your uP API integration, the test payments can be used to generate report data. The report data will be shared as .csv files and can be used as samples for your reporting integration. Note you will also be provided with a set of obligatory test cases. You must pass these test cases successfully before the NomuPay team can move you from the Sandbox environment to the Live environment. When all tests have been passed successfully your integration is considered certified and you are ready to move to a Live setup.

  4. Live setup Once you have successfully completed testing, a member of the NomuPay team will provide you with your Live API credentials. Please not that https://api.nomupay.com is the service endpoint for the Live uP API environment.

  5. Pilot testing The final stage of the integration requires testing live payments in production. This will require facilitating a set of payments to a handful of your recipients. Once these payments have successfully processed, the NomuPay team will use these Live payments to generate report data for review and approval.