---
updatedAt: 2026-04-24T16:38:27.000Z
agentTools:
  projectIndex: https://developers.cloudbeds.com/llms.txt
---

# getPaymentMethods

Get a list of active methods for a property, or list of properties

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Cloudbeds API",
    "description": "<p>\n    Welcome to the documentation for <strong>Cloudbeds API Version v1.3</strong>!\n    If you are looking to learn how to use the Cloudbeds API to access guest information, reservations, or similar data\n    for your Cloudbeds customers, then you've come to the right place.\n</p>\n\n<p>\n    In this document you will find all the API methods we provide along with explanations for parameters and response\n    examples.\n</p>\n\n<p>\n    If you have questions about different implementation steps (e.g. how to implement OAuth 2.0), please refer to our\n    <a href=\"https://integrations.cloudbeds.com/hc/en-us\">Integrations Portal</a>.\n</p>\n\n<p>\n    Be sure to <a href=\"https://go.pardot.com/l/308041/2018-07-24/qb2lg\">subscribe</a> to the monthly\n    Cloudbeds API announcement mailing list to receive information on new additions and improvements to the\n    Cloudbeds API and related developer tools.\n</p>\n\n<p>\n    <strong>Endpoint:</strong> https://api.cloudbeds.com/api/v1.3/{method}\n</p>\n\n<p>\n    <strong>HTTPS:</strong> Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.\n</p>\n\n<p>\n    <strong>Request Format:</strong> HTTP GET, POST and PUT (Content-Type: application/x-www-form-urlencoded)\n</p>\n\n<p>\n    <strong>Response Format:</strong> JSON\n</p>\n\n<p>\n    <strong>Response Header:</strong> X-Request-ID is added to response headers in all calls to help accelerate support\n    and troubleshooting.\n</p>\n\n<p>\n    <strong>\n        <a href=\"https://integrations.cloudbeds.com/hc/en-us/articles/14104678058267-API-Documentation#postman-collection\">\n            <img src=\"https://run.pstmn.io/button.svg\" alt=\"Run in Postman\">\n        </a>\n    </strong> use this link to access our Public collection in Postman.\n</p>",
    "version": "v1.3"
  },
  "servers": [
    {
      "url": "https://api.cloudbeds.com/api/v1.3/"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      },
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "",
            "tokenUrl": "",
            "scopes": {
              "delete:adjustment": "delete:adjustment",
              "delete:appPropertySettings": "delete:appPropertySettings",
              "delete:roomblock": "delete:roomblock",
              "read:allotmentBlock": "read:allotmentBlock",
              "read:appPropertySettings": "read:appPropertySettings",
              "read:communication": "read:communication",
              "read:currency": "read:currency",
              "read:customFields": "read:customFields",
              "read:dashboard": "read:dashboard",
              "read:group": "read:group",
              "read:guest": "read:guest",
              "read:hotel": "read:hotel",
              "read:houseAccount": "read:houseAccount",
              "read:housekeeping": "read:housekeeping",
              "read:item": "read:item",
              "read:package": "read:package",
              "read:payment": "read:payment",
              "read:rate": "read:rate",
              "read:reservation": "read:reservation",
              "read:room": "read:room",
              "read:roomblock": "read:roomblock",
              "read:taxesAndFees": "read:taxesAndFees",
              "read:user": "read:user",
              "write:adjustment": "write:adjustment",
              "write:allotmentBlock": "write:allotmentBlock",
              "write:appError": "write:appError",
              "write:appPropertySettings": "write:appPropertySettings",
              "write:communication": "write:communication",
              "write:customFields": "write:customFields",
              "write:group": "write:group",
              "write:guest": "write:guest",
              "write:hotel": "write:hotel",
              "write:houseAccount": "write:houseAccount",
              "write:housekeeping": "write:housekeeping",
              "write:item": "write:item",
              "write:payment": "write:payment",
              "write:rate": "write:rate",
              "write:reservation": "write:reservation",
              "write:room": "write:room",
              "write:roomblock": "write:roomblock"
            }
          }
        }
      }
    },
    "schemas": {
      "GetPaymentMethodsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "description": "Returns if the request could be completed",
            "type": "boolean"
          },
          "data": {
            "description": "",
            "type": "object",
            "properties": {
              "propertyID": {
                "description": "Property ID",
                "type": "string"
              },
              "methods": {
                "description": "List of active methods enabled",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "method": {
                      "description": "Payment Method",
                      "type": "string"
                    },
                    "code": {
                      "description": "Payment Code",
                      "type": "string"
                    },
                    "name": {
                      "description": "Payment Name (in given lang)",
                      "type": "string"
                    },
                    "cardTypes": {
                      "description": "IF type = 'credit' the enabled card types. Having the array's keys as its type and the value as its name.",
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "cardCode": {
                            "description": "",
                            "type": "string",
                            "nullable": true
                          },
                          "cardName": {
                            "description": "",
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      "nullable": true
                    }
                  }
                }
              },
              "gateway": {
                "description": "Payment Gateway used by property",
                "type": "object",
                "properties": {
                  "name": {
                    "description": "Gateway name",
                    "type": "string"
                  },
                  "currency": {
                    "description": "3 letters iso code",
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "paths": {
    "/getPaymentMethods": {
      "get": {
        "tags": [
          "Payment"
        ],
        "summary": "getPaymentMethods",
        "description": "Get a list of active methods for a property, or list of properties",
        "responses": {
          "200": {
            "description": "200 Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetPaymentMethodsResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": [
              "read:payment"
            ]
          },
          {
            "OAuth2": [
              "read:payment"
            ]
          }
        ],
        "parameters": [
          {
            "description": "ID for the property to be queried",
            "name": "propertyID",
            "schema": {
              "type": "string"
            },
            "required": false,
            "in": "query"
          },
          {
            "description": "Language that payment methods name should return (if available).",
            "name": "lang",
            "schema": {
              "type": "string",
              "enum": [
                "en",
                "pt-br",
                "es"
              ],
              "default": "en"
            },
            "required": false,
            "in": "query"
          }
        ]
      }
    }
  }
}
```