Getting Started

Step 1: API Keys and Concepts

Creating your Mercoa Instance

To create your Mercoa instance, please book a call with our team here. We’ll help you get set up and answer any questions you may have.

Getting your API Keys

You can find your API key and Organization ID in the Mercoa Dashboard.

Do not expose this key on the front-end, it is for back-end use only.

Mercoa Architecture

Mercoa architecture overview

Creating a Payer Entity

A payer entity is a person or business that pays bills on your platform or app.

When creating your first payer, we recommend using the Mercoa Dashboard.

You can also create a payer using the Mercoa API.

POST
1curl -X POST https://api.mercoa.com/entity \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "isCustomer": true,
6  "accountType": "business",
7  "profile": {
8    "business": {
9      "legalBusinessName": "Acme Inc.",
10      "email": "customer@acme.com",
11      "businessType": "llc",
12      "phone": {
13        "countryCode": "1",
14        "number": "4155551234"
15      },
16      "website": "http://www.acme.com",
17      "address": {
18        "addressLine1": "123 Main St",
19        "city": "San Francisco",
20        "stateOrProvince": "CA",
21        "postalCode": "94105",
22        "addressLine2": "Unit 1",
23        "country": "US"
24      },
25      "taxId": {
26        "ein": {
27          "number": "12-3456789"
28        }
29      }
30    }
31  },
32  "isPayor": true,
33  "isPayee": false,
34  "foreignId": "MY-DB-ID-12345"
35}'

You can create a payer with just a name and email address. Mercoa can automatically collect the rest of the payer’s information with our Payer Onboarding flow.

Once you’ve created your payer, you will have an entityId that you can use to create a token for the payer.

Entity IDs always start with ent_ followed by a UUID.

Enable Mercoa Payments

If you are using Mercoa’s payment rails, you will need to collect data required to run KYB. Follow our payments guide for more information.

Built with