Relationships

List Relationships

List relationships where the authenticated account is the parent or the child. Each relationship includes basic details of the parent and child accounts, not just their IDs.

Results are ordered newest first and paginated with an opaque cursor. When has_more is true, pass the returned cursor to the next call to fetch the next page. Treat the cursor as an opaque value and URL-encode it when sending.

get/v2/relationships

Request

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

Query parameters

parent_account_idstring

Filter by parent account ID

child_account_idstring

Filter by child account ID

enabledboolean

Filter by the relationship's enabled status

limitinteger

Number of relationships per page (1-100). Defaults to 20

cursorstring

Opaque pagination cursor from a previous response. Omit to fetch the first page

Response

Relationships retrieved successfully

has_moreboolean

Whether more relationships exist after this page

cursorstring

Opaque cursor for fetching the next page. Only present when has_more is true

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
    }
  ],
  "has_more": true,
  "cursor": "MjAyNC0wNy0wMVQwMDowMDowMFp8bXJfMWEyYjNjNGQ1ZTZmN2E4YjljMGQxZTJm"
}

Changes

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