Historical contract: Get Payment Cards

Historical API contract. This page describes an earlier API contract. Methods, paths, and responses may differ from the current API.

Historical meaning

Get Payment Cards

This API endpoint is used to get all payment cards. This is related to the built-in Stripe payment gateway.

Current API

For new integrations, use the linked current API reference or guide.

View the current API reference

Parameters

[
  {
    "name": "language",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "en"
    },
    "required": true
  },
  {
    "name": "project",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "<redacted-personal>"
    },
    "required": true
  },
  {
    "name": "gateway",
    "in": "path",
    "schema": {
      "type": "string"
    },
    "required": true
  },
  {
    "name": "api_version",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "v400"
    },
    "required": true
  }
]

Request body

null

Responses

{
  "200": {
    "description": "200",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": false,\n  \"result\": [\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": true,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    },\n    {\n      \"id\": \"<redacted-payment-id>\",\n      \"last4\": \"1111\",\n      \"brand\": \"Visa\",\n      \"default\": false,\n      \"customer_id\": 0\n    }\n  ]\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": false,
              "default": true
            },
            "result": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "example": "<redacted-payment-id>"
                  },
                  "last4": {
                    "type": "string",
                    "example": "1111"
                  },
                  "brand": {
                    "type": "string",
                    "example": "Visa"
                  },
                  "default": {
                    "type": "boolean",
                    "example": true,
                    "default": true
                  },
                  "customer_id": {
                    "type": "integer",
                    "example": 0,
                    "default": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "400": {
    "description": "400",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": true,\n  \"result\": [\n    \"The Business field is required.\",\n    \"The User field is required.\"\n  ]\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": true,
              "default": true
            },
            "result": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "The Business field is required."
              }
            }
          }
        }
      }
    }
  },
  "401": {
    "description": "401",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": true,\n  \"result\": [\n    \"You do not have permission.\"\n  ]\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": true,
              "default": true
            },
            "result": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "You do not have permission."
              }
            }
          }
        }
      }
    }
  }
}