EntityCounterparty

Find payor counterparties

GET
https://api.mercoa.com/entity/:entityId/counterparties/payors

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

Path parameters

entityId
string

Query parameters

name
optional string

Filter by counterparty name

networkType
optional enum

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

Allowed values: ENTITYNETWORK
paymentMethods
optional boolean

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

counterpartyId
optional string

Filter by counterparty ids

limit
optional integer

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

startingAfter
optional string

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

Response

This endpoint return an object.
count
integer

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.

hasMore
boolean

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

data
list of objects
GET
/entity/:entityId/counterparties/payors
curl -G https://api.mercoa.com/entity/:entityId/counterparties/payors \
-H "Authorization: Bearer <token>" \
-d name=string \
-d networkType=ENTITY
Response
{
"count": 0,
"hasMore": true,
"data": [
{
"acceptedTos": true,
"accountType": "business",
"counterpartyType": [
"ENTITY"
],
"createdAt": "2023-01-01T00:00:00Z",
"email": "string",
"id": "string",
"isCustomer": true,
"isPayee": true,
"isPayor": true,
"name": "string",
"paymentMethods": [
{
"type": "bankAccount",
"accountName": "string",
"accountNumber": "string",
"accountType": "CHECKING",
"bankName": "string",
"createdAt": "2023-01-01T00:00:00Z",
"id": "string",
"isDefaultDestination": true,
"isDefaultSource": true,
"routingNumber": "string",
"status": "NEW",
"supportedCurrencies": [
"AED"
],
"updatedAt": "2023-01-01T00:00:00Z",
"checkOptions": {
"enabled": true,
"initialCheckNumber": 0,
"routingNumberOverride": "string",
"accountNumberOverride": "string",
"signatoryName": "string",
"signatureImage": "string"
}
}
],
"profile": {
"business": {
"legalBusinessName": "string",
"taxIDProvided": true,
"email": "string",
"businessType": "soleProprietorship",
"phone": {
"countryCode": "string",
"number": "string"
},
"doingBusinessAs": "string",
"website": "string",
"description": "string",
"address": {
"addressLine1": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"addressLine2": "string",
"country": "string"
},
"ownersProvided": true
},
"individual": {
"email": "string",
"name": {
"firstName": "string",
"lastName": "string",
"middleName": "string",
"suffix": "string"
},
"birthDateProvided": true,
"governmentIDProvided": true,
"phone": {
"countryCode": "string",
"number": "string"
},
"address": {
"addressLine1": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"addressLine2": "string",
"country": "string"
}
}
},
"status": "unverified",
"updatedAt": "2023-01-01T00:00:00Z",
"emailTo": "string",
"emailToAlias": [
"string"
],
"foreignId": "string"
}
]
}