v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Entity Link

post/entity_links

Request body

entity_a_idstring required

ID of object being linked

entity_a_typestring required

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

entity_b_idstring required

ID of object being linked

entity_b_typestring required

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

metadataobject

Response

201

idstring

objectstring

live_modeboolean

created_by_actor_namestring

created_by_actor_idstring

created_by_actor_typestring

{"stackTrail":"paths:/entity_links:post:responses:201:content:application/json:schema:properties:discarded_by_actor_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/entity_links:post:responses:201:content:application/json:schema:properties:discarded_by_actor_type","oasType":"schema","type":"unknown"}

entity_a_idstring

entity_a_typestring

entity_b_idstring

entity_b_typestring

metadataobject

{"stackTrail":"paths:/entity_links:post:responses:201:content:application/json:schema:properties:discarded_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "67fca7e9-af82-4af7-84b2-594f591359bc",
  "object": "entity_link",
  "live_mode": true,
  "created_by_actor_name": "Production API Key",
  "created_by_actor_id": "b836e9f2-551e-4f5c-9d00-3e491ea234bc",
  "created_by_actor_type": "APIKey",
  "entity_a_id": "23b67040-e80c-45a2-a462-5381c47700bb",
  "entity_a_type": "payment_order",
  "entity_b_id": "b5d4bdb3-3a1f-4097-9e83-05f3d214f0fd",
  "entity_b_type": "payment_order",
  "created_at": "2024-09-04T19:42:39Z",
  "updated_at": "2024-09-04T19:42:39Z"
}