Relationships

Get Relationship

Retrieve a relationship by ID. The response includes basic details of the parent and child accounts, not just their IDs. Only the parent account or the child account of the relationship can access it.

get/v2/relationships/{id}

Request

Base URL
https://api.paymongo.com
URL
https://api.paymongo.com/v2/relationships/{id}
Auth
HTTP basic

Path parameters

idstring required

Unique identifier for the relationship

Response

Relationship retrieved successfully

Example response

{
  "data": {
    "id": "mr_1a2b3c4d5e6f7a8b9c0d1e2f",
    "parent_account_id": "org_1a2b3c4d5e6f7a8b9c0d1e2f",
    "child_account_id": "org_2b3c4d5e6f7a8b9c0d1e2f3a",
    "enabled": true,
    "linking_request_id": "lr_3c4d5e6f7a8b9c0d1e2f3a4b",
    "policies": {
      "transfer": {
        "ViewTransfer": {
          "label": "View all transfers",
          "policy_id": null
        },
        "ManageTransfer": {
          "label": "Manage all transfers",
          "policy_id": null
        }
      }
    },
    "parent_account": {
      "id": "org_2b3c4d5e6f7a8b9c0d1e2f3a",
      "account_type": "merchant",
      "activation_status": "activated",
      "enabled": true,
      "trade_name": "Juan's Coffee",
      "legal_name": "Juan Dela Cruz Coffee Trading",
      "business_type": "sole_proprietor"
    },
    "child_account": {
      "id": "org_2b3c4d5e6f7a8b9c0d1e2f3a",
      "account_type": "merchant",
      "activation_status": "activated",
      "enabled": true,
      "trade_name": "Juan's Coffee",
      "legal_name": "Juan Dela Cruz Coffee Trading",
      "business_type": "sole_proprietor"
    },
    "created_at": 1719849600,
    "updated_at": 1720022400
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.