{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bud API Services: Documentation Aggregation Buckets Savings Goals V2 API",
    "version": "2.10.10"
  },
  "items": [
    {
      "info": {
        "name": "Savings Goals V2",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Savings Goal V2",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.thisisbud.com/goals/v2/savings/goal",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a savings goal for the given account.\n\nThe `allocation_ratio` defines the proportion of the account balance that is considered allocated to this goal. For example, an `allocation_ratio` of `0.2` means that 20% of the account balance is treated as the goal balance.\n\nThe `goal_balance` returned in the response is calculated as the current account balance multiplied by the `allocation_ratio`.\n"
        },
        {
          "info": {
            "name": "Retrieve Savings Goals V2",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.thisisbud.com/goals/v2/savings/goals",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "RxsYshVGded4JeilkXgWKdXA",
                "type": "query",
                "description": "Use this parameter to filter the results on data associated with the given account id.\n\nExample: `RxsYshVGded4JeilkXgWKdXA`\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieve all savings goals for the customer. The results can be filtered by the `account_id` query parameter.\n\nThe `goal_balance` for each goal is calculated as the current account balance multiplied by the `allocation_ratio`.\n"
        },
        {
          "info": {
            "name": "Retrieve Savings Goal V2",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.thisisbud.com/goals/v2/savings/goals/:savings_goal_id",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "savings_goal_id",
                "value": "81a68821-dca6-4771-80d4-002c7fce412e",
                "type": "path",
                "description": "The ID of the savings goal.\n\nExample: `81a68821-dca6-4771-80d4-002c7fce412e`\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieve a savings goal by its `savings_goal_id`.\n\nThe `goal_balance` is calculated as the current account balance multiplied by the `allocation_ratio`.\n"
        },
        {
          "info": {
            "name": "Update Savings Goal V2",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.thisisbud.com/goals/v2/savings/goals/:savings_goal_id",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "savings_goal_id",
                "value": "81a68821-dca6-4771-80d4-002c7fce412e",
                "type": "path",
                "description": "The ID of the savings goal.\n\nExample: `81a68821-dca6-4771-80d4-002c7fce412e`\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update a savings goal with the given `savings_goal_id`. All fields are optional.\n\nThe `goal_balance` returned in the response is recalculated as the current account balance multiplied by the updated `allocation_ratio`.\n"
        },
        {
          "info": {
            "name": "Remove Savings Goal V2",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.thisisbud.com/goals/v2/savings/goals/:savings_goal_id",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "savings_goal_id",
                "value": "81a68821-dca6-4771-80d4-002c7fce412e",
                "type": "path",
                "description": "The ID of the savings goal.\n\nExample: `81a68821-dca6-4771-80d4-002c7fce412e`\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Remove a savings goal with the given `savings_goal_id`.\n"
        }
      ]
    }
  ],
  "bundled": true
}