Counterparty Schema
Field reference for counterparty (merchant) data in enriched output.
| Field | Type | Optional | Description |
|---|---|---|---|
| l3CounterpartyId | String (max 36) | No | The unique identifier for the counterparty. UUID format. |
| l3CounterpartyName | String (max 128) | Yes | Name of the counterparty. |
| parentId | String (max 36) | Yes | The unique identifier of the parent counterparty (where applicable). For counterparties that provide multiple services, such as Tesco, there may be numerous child counterparties for each service, e.g., Tesco Mobile, which link back to a more generic parent, i.e., Tesco. |
| parentName | String (max 36) | Yes | Name of the parent counterparty (where applicable). |
| fullCompanyName | String (max 128) | Yes | Company name. Can be the extended name or registered name of the counterparty. |
| logoUrl | String (max 128) | Yes | Logo URL of counterparty. Suitable for displaying in a consumer-facing app. |
| website | String (max 512) | Yes | Website URL of counterparty. |
| registeredLocation | String (max 128) | Yes | Registered address of company. |
| l3CounterpartyCategory | String (max 32) | Yes | Category used to group similar counterparties. The level 3 category, industry, assigned to the counterparty. |
| l2CategoryName | String (max 32) | Yes | Most appropriate transaction category name for transactions to this counterparty. The predominant level 2 category assigned to the counterparty, e.g. a petrol station, will be "gasoline". |
| l4LoanType | String (max 43) | Yes | The level 4 loan type. Only present for loan provider counterparties. One of "Unsecured", "Secured", "Buy Now Pay Later", "High Cost Short Term Credit", "Debt Collection Agency/Debt Management Plan". |