entity > counterparty

Find payor counterparties

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

get/entity/{entityId}/counterparties/payors

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity/{entityId}/counterparties/payors
  • Auth: HTTP bearer

Path parameters

entityIdstring required

Entity ID or Entity ForeignID

Query parameters

namestring

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

searchstring

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

networkType'ENTITY' | 'NETWORK'

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

paymentMethodsboolean

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

invoiceMetricsboolean

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

counterpartyIdstring

Filter by counterparty ids (Foreign ID is supported)

keystring required

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

returnMetadatastring

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

limitinteger

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

startingAfterstring

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

Response

Response with status 200

countinteger required

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 required

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

Changes

No recorded changes to this operation across all 1 revision of this API.