Find payor counterparties — Mercoa

Find payor counterparties. This endpoint lets you find customers linked to the entity.

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Query parameters

namestringOptionalDeprecated

Use search instead. Deprecated. Filter counterparties by name. Partial matches are supported.

searchstringOptional

Filter counterparties by name or email. Partial matches are supported.

networkType"ENTITY" or "NETWORK"Optional

Filter by network type. By default, only ENTITY counterparties are returned.

Allowed values: ENTITYNETWORK

paymentMethodsbooleanOptional

If true, will include counterparty payment methods as part of the response

invoiceMetricsbooleanOptional

If true, will include counterparty invoice metrics as part of the response

counterpartyIdstringOptional

Filter by counterparty ids (Foreign ID is supported)

metadataobjectOptional

Filter counterparties by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

returnMetadatastringOptional

If true, will return simple key/value metadata for the counterparties. For more complex metadata, use the Metadata API.

limitintegerOptional

Number of counterparties to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstringOptional

The ID of the counterparties to start after. If not provided, the first page of counterparties will be returned.

Response

This endpoint returns an object.

countinteger

Total number of counterparties for the given filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.

hasMoreboolean

True if there are more counterparties available for the given filters.

datalist of objects

1 curl -G https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/counterparties/payors \ 2 -H "Authorization: Bearer <token>" \ 3 --data-urlencode name="Big Box" \ 4 -d paymentMethods=true \ 5 -d invoiceMetrics=true

1 { 2 "count": 1, 3 "hasMore": false, 4 "data": [ 5 { 6 "acceptedTos": false, 7 "accountType": "business", 8 "createdAt": "2024-01-01T00:00:00Z", 9 "email": "vendor@bigboxstore.com", 10 "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d", 11 "isCustomer": false, 12 "isNetworkPayee": false, 13 "isNetworkPayor": false, 14 "isPayee": true, 15 "isPayor": false, 16 "name": "Big Box Store", 17 "profile": { 18 "business": { 19 "legalBusinessName": "Big Box Store", 20 "taxIDProvided": false, 21 "email": "vendor@bigboxstore.com", 22 "businessType": "publicCorporation", 23 "ownersProvided": false 24 } 25 }, 26 "status": "unverified", 27 "updatedAt": "2024-01-02T00:00:00Z", 28 "counterpartyType": [ 29 "ENTITY" 30 ], 31 "foreignId": "MY-DB-ID-90909", 32 "paymentMethods": [ 33 { 34 "type": "bankAccount", 35 "accountName": "Vendor Checking Account", 36 "accountNumber": "55934059697648", 37 "accountType": "CHECKING", 38 "bankName": "Chase", 39 "createdAt": "2021-01-01T00:00:00Z", 40 "frozen": false, 41 "id": "pm_7610541f-4619-4033-8620-cfccfb811293", 42 "isDefaultDestination": true, 43 "isDefaultSource": true, 44 "metadata": {}, 45 "routingNumber": "66554433", 46 "status": "NEW", 47 "supportedCurrencies": [ 48 "USD" 49 ], 50 "updatedAt": "2021-01-01T00:00:00Z" 51 } 52 ] 53 } 54 ] 55 }

1	curl -G https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/counterparties/payors \
2	-H "Authorization: Bearer <token>" \
3	--data-urlencode name="Big Box" \
4	-d paymentMethods=true \
5	-d invoiceMetrics=true

1	{
2	"count": 1,
3	"hasMore": false,
4	"data": [
5	{
6	"acceptedTos": false,
7	"accountType": "business",
8	"createdAt": "2024-01-01T00:00:00Z",
9	"email": "vendor@bigboxstore.com",
10	"id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
11	"isCustomer": false,
12	"isNetworkPayee": false,
13	"isNetworkPayor": false,
14	"isPayee": true,
15	"isPayor": false,
16	"name": "Big Box Store",
17	"profile": {
18	"business": {
19	"legalBusinessName": "Big Box Store",
20	"taxIDProvided": false,
21	"email": "vendor@bigboxstore.com",
22	"businessType": "publicCorporation",
23	"ownersProvided": false
24	}
25	},
26	"status": "unverified",
27	"updatedAt": "2024-01-02T00:00:00Z",
28	"counterpartyType": [
29	"ENTITY"
30	],
31	"foreignId": "MY-DB-ID-90909",
32	"paymentMethods": [
33	{
34	"type": "bankAccount",
35	"accountName": "Vendor Checking Account",
36	"accountNumber": "55934059697648",
37	"accountType": "CHECKING",
38	"bankName": "Chase",
39	"createdAt": "2021-01-01T00:00:00Z",
40	"frozen": false,
41	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
42	"isDefaultDestination": true,
43	"isDefaultSource": true,
44	"metadata": {},
45	"routingNumber": "66554433",
46	"status": "NEW",
47	"supportedCurrencies": [
48	"USD"
49	],
50	"updatedAt": "2021-01-01T00:00:00Z"
51	}
52	]
53	}
54	]
55	}