# Payrix Entity Refs API

**Canonical:** https://apis.io/apis/payrix/payrix-entityrefs-api/  
**Provider:** Payrix — https://apis.io/providers/payrix/  
**Base URL:** https://api.payrix.com  
**Documentation:** https://docs.worldpay.com/api-specification/payrix/merchant

Payrix Entity Refs API is one of 133 APIs that [Payrix](https://apis.io/providers/payrix/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include EntityRefs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

An entityRef may be used to store referential IDs for merchants, facilitators and even vendors. For a merchant, at least a mid and funding entityRef is required for proper transacting and funding. For a facilitator, at least the entity and funding entityRefs should be defined for proper merchant boarding, transaction processing and funding operations as well as any other references required for operating on the selected platform.

## Operations (2)

| Method | Path | Summary |
|---|---|---|
| GET | `/entityRefs/{id}` | getEntityRefsId |
| GET | `/entityRefs` | getEntityRefs |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/payrix/refs/heads/main/openapi/payrix-entityrefs-api-openapi.yml
- **Documentation** — https://docs.worldpay.com/api-specification/payrix/merchant
- **Documentation** — https://docs.worldpay.com/api-specification/payrix/partner

## Other Payrix APIs (12)

- [Payrix Accounts API](https://apis.io/apis/payrix/payrix-accounts-api/)
- [Payrix Accounts Verifications API](https://apis.io/apis/payrix/payrix-accounts-verifications-api/)
- [Payrix Adjustments API](https://apis.io/apis/payrix/payrix-adjustments-api/)
- [Payrix Aggregation Result Groups API](https://apis.io/apis/payrix/payrix-aggregation-result-groups-api/)
- [Payrix Aggregation Results API](https://apis.io/apis/payrix/payrix-aggregation-results-api/)
- [Payrix Aggregations API](https://apis.io/apis/payrix/payrix-aggregations-api/)
- [Payrix Alert Actions API](https://apis.io/apis/payrix/payrix-alert-actions-api/)
- [Payrix Alert Triggers API](https://apis.io/apis/payrix/payrix-alert-triggers-api/)
- [Payrix Alerts API](https://apis.io/apis/payrix/payrix-alerts-api/)
- [Payrix API Keys API](https://apis.io/apis/payrix/payrix-api-keys-api/)
- [Payrix Apple Domains API](https://apis.io/apis/payrix/payrix-apple-domains-api/)
- [Payrix Apple Domains Mass Enablement API](https://apis.io/apis/payrix/payrix-apple-domains-mass-enablement-api/)

## Tags

EntityRefs

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/payrix/payrix-entityrefs-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/payrix/.