API ReferenceEntityCounterpartyBulk

Download Bulk Payors

Get a URL to download payor counterparties as a CSV/JSON file. This endpoint lets you download customers linked to the entity.

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

formatenumOptional
Format of the file to download. Defaults to CSV.
Allowed values:
searchstringOptional
Filter counterparties by name or email. Partial matches are supported.
networkTypeenumOptional
Filter by network type. By default, only ENTITY counterparties are returned.
Allowed values:
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.

Response

This endpoint returns an object.
urlstring
mimeTypestring

Errors