Entity Links

An entity_link represents a link between two objects. Entity Links is currently an Early Access feature and is available for linking Expected Payments, Returns, and Payment Orders.

Attribute

Description

id string

Unique identifier for the entity link

entity_a_id
string

ID of linked object

entity_a_type
string

Type of linked object, can be expected_payment, return or payment_order

entity_b_id
string

ID of linked object

entity_b_type
string

Type of linked object, can be expected_payment, return or payment_order

live_mode
string

This field will be true if this object exists in the live environment or false if it exists in the test environment.

{
  "id": "21bfd337-5d13-4c9a-8f9e-2409023d9627",
  "entiy_a_id": "1bbc5c0e-fdee-4a4b-b16f-d8164444861f",
  "entity_a_type": "payment_order",
  "entiy_b_id": "22ccfb02-fdee-4a4b-b16f-d8164444861f",
  "entity_b_type": "payment_order",
  "created_by_actor_id": "b45c5b0e-fdee-4a4b-b16f-d8164444861f",
  "created_by_actor_type": "user",
  "created_by_actor_name": "Some Name",
  "live_mode": true,
  "created_at": "2019-11-09T00:11:07Z",
  "updated_at": "2019-11-09T00:11:07Z"
}