---
title: Ping
slug: ping
description: Use Butter's Ping endpoint to perform health checks and verify your API credentials, ensuring seamless connectivity with the Butter Payments API.
docTags: 
createdAt: 2024-12-09T23:31:31.548Z
---

{
  "id": "xolkcb7xmVfwBgOViaKd9",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.disputes.services.butterpayments.com/",
    "servers": [
      {
        "url": "https://api.disputes.services.butterpayments.com/"
      }
    ],
    "name": "Ping",
    "description": "Ping the Butter Payments API for a health check as well as verifying your credentials are valid.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "HTTPBasic",
          "name": "HTTPBasic",
          "kind": "optional",
          "type": "http",
          "scheme": "basic"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Successful Response",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "PingResponse",
            "schema": [
              {
                "name": "status",
                "kind": "required",
                "type": "string",
                "example": "",
                "default": "OK"
              }
            ],
            "modelRef": "#/components/schemas/PingResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "aLHTAsWATjiNgfCZ7miNh",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.disputes.services.butterpayments.com/ \\\n     --header 'accept: application/json'"
        },
        {
          "id": "euPBY3uJlZe70rtWOpMpz",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.disputes.services.butterpayments.com/\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "xh-_ai0_wta887WhEGEjq",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.disputes.services.butterpayments.com/\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "FDsiXbI-duqHo_-8L97aE",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.disputes.services.butterpayments.com/\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "aLHTAsWATjiNgfCZ7miNh"
    },
    "results": {
      "languages": [
        {
          "id": "VovDFYNNPcXcWN6QDOYP6",
          "language": "200",
          "code": "// Successful Response\n{\n  \"status\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "VovDFYNNPcXcWN6QDOYP6"
    }
  },
  "children": [
    {
      "id": "ykKmaSsL0xnT4oWhTMs1o",
      "type": "paragraph",
      "children": [
        {
          "text": "Ping the Butter Payments API for a health check as well as verifying your credentials are valid."
        }
      ]
    }
  ]
}