{
  "opencollection": "1.0.0",
  "info": {
    "name": "Paxos Account Members Orchestration Rules API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Orchestration Rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Orchestration Rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.paxos.com/v2/orchestration/rules",
            "params": [
              {
                "name": "profile_id",
                "value": "",
                "type": "query",
                "description": "Optional filter by profile ID"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Optional filter by statuses\n\n - ACTIVE: The rule is active, deposits matching the `source_asset` and `source` of this rule start a conversion and\nsubsequent delivery of the `destination_asset` to the specified `destination`.\n - DELETED: The rule has been deleted, newly deposited `source_assets` to the `source` of this rule will not be converted.\nThe deposited `source_asset` is still going to be credited to the Profile specified by `profile_id`.\n - PENDING: The rule creation is pending approval(s) before the rule becomes ACTIVE.\n - REJECTED: The rule creation has been rejected during the approval process."
              },
              {
                "name": "source_asset",
                "value": "",
                "type": "query",
                "description": "Optional filter by source asset"
              },
              {
                "name": "destination_asset",
                "value": "",
                "type": "query",
                "description": "Optional filter by destination asset"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Optionally filter by the UUIDs of the orchestration rules. Limit 100."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Sort order for the results. Defaults to DESC by created_at time."
              },
              {
                "name": "page_cursor",
                "value": "",
                "type": "query",
                "description": "Optional Cursor for getting the next page of results."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List all orchestration rules, optionally filtering and paging the results.\n\nBy default, orchestration rules are returned in reverse chronological (descending)\norder by creation time. If no query parameters are supplied,\nthe response will include up to the last 100 rules which were created.\n\nThe paginated results default to display up to 100 rules, unless\notherwise specified with the `limit` parameter. The maximum `limit` value is 1000.\nEvery paginated response contains a `next_page_cursor` field"
        },
        {
          "info": {
            "name": "Create Orchestration Rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.paxos.com/v2/orchestration/rules",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a persistent orchestration rule that automatically triggers orchestrations\nwhen matching deposits are received.\n\nThe rule will:\n1. Generate deposit instructions associated with the rule.\n2. Continuously monitor incoming deposits to those instructions.\n3. Automatically execute orchestrations to the specified destination.\n\nSupported Sources:\n\n- Crypto deposit\n- Fiat deposit\n\nSupported Destinations:\n\n- Crypto address on a supported network\n- Bank account\n- Profile ID\n\nError conditions:\n- [A"
        },
        {
          "info": {
            "name": "Delete Orchestration Rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.paxos.com/v2/orchestration/rules/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the orchestration rule to delete"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deactivates an orchestration rule by updating its status to DELETED.\nOnce deleted, the rule will no longer trigger new orchestrations.\nAny orchestrations previously created by the rule will continue to be processed.\n\nThe request accepts a single rule ID and returns the updated rule resource\nwith its status set to DELETED upon success."
        }
      ]
    }
  ],
  "bundled": true
}