Skip to main content

Set up a funder API integration

V
Written by Victor Fteha

Every funder API integration in MCA Pilot follows the same setup flow: request credentials, configure the funder in Development, submit a test deal, and switch to Production after the funder confirms the test.

Standard setup steps

  1. Email the funder’s API contact to request credentials and development access.

  2. In MCA Pilot, go to the Funders page and create or click into the funder.

  3. Open the Submission Method tab and click Edit in the top right.

  4. Choose API Integration as the Submission Method.

  5. Select the funder for API Funder and Development for API Environment.

  6. Enter the credentials in the API Key field. The exact format depends on the funder—see the funder-specific table below.

  7. Submit a test deal that includes the required info and documents for that funder.

  8. If the test succeeds, copy the response (or the Application Name, if the funder uses one) and email it back to the funder to request production access.

  9. Once the funder sends production credentials, return to the funder settings, enter the new credentials, and change API Environment to Production.

Each funder requires slightly different fields and documents. The funder-specific guides below list exactly what a test deal needs for that integration.

Funder contacts and credential formats

Funder

Contact

API Key format

Six comma-separated values: Consumer Key, Client Secret, Unique General Email, Unique General Password, Unique Partner API Key, Sales Rep Email

Single API key

UAT key for Development; production key for Production

Comma-separated: username, password, client ID, client secret

Single API key

Single API key

Verify a test submission

After you submit a test deal, check the submission on the deal page:

  • Hover over the submission and click Check Status to refresh the latest response from the funder.

  • Some funders also show an Open in Funder button that opens the submission directly in the funder’s portal.

If the submission is successful, copy the response details and send them to the funder contact to request production access.

Switch to production

  1. Wait for the funder to issue production credentials.

  2. Return to the funder’s funder page in MCA Pilot.

  3. Open Submission MethodEdit.

  4. Replace the API Key with the production credentials.

  5. Change API Environment to Production and save.

Fix a failed submission

If a test submission errors, hover over the submission and click View error to see the exact message. Fix the missing or invalid fields on the deal and resubmit.

Common causes of test failures are missing required fields, invalid phone numbers, or missing documents. Each funder guide lists the required fields and formats for that integration.

Next steps

Did this answer your question?