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
entityId
Entity ID or Entity ForeignID
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
format
Format of the file to download. Defaults to CSV.
Allowed values:
search
Filter counterparties by name or email. Partial matches are supported.
networkType
Filter by network type. By default, only ENTITY counterparties are returned.
Allowed values:
paymentMethods
If true, will include counterparty payment methods as part of the response
invoiceMetrics
If true, will include counterparty invoice metrics as part of the response
counterpartyId
Filter by counterparty ids (Foreign ID is supported)
metadata
Filter counterparties by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
returnMetadata
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.
url
mimeType