---
agentTools:
  projectIndex: https://tyms.readme.io/llms.txt
---

# Get Payment Accounts

This is what will be used as category for payment type - Cash | Bank. For bank, uuid will be used.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Tyms (Sandbox)",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://staging-api.tyms.io/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "secret-key",
        "in": "header",
        "x-default": "sk_2938310299229"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/chart/payments/account": {
      "get": {
        "summary": "Get Payment Accounts",
        "description": "This is what will be used as category for payment type - Cash | Bank. For bank, uuid will be used.",
        "operationId": "payment-accounts",
        "parameters": [
          {
            "name": "secret-key",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"message\": \"Payments account retrieved successfully\",\n    \"data\": [\n        {\n            \"name\": \"Petty cash\",\n            \"type\": \"Cash\",\n            \"uuid\": null\n        },\n        {\n            \"name\": \"Cash\",\n            \"type\": \"Cash\",\n            \"uuid\": null\n        },\n        {\n            \"name\": \"GT Bank - Olanase Yezid\",\n            \"type\": \"Bank\",\n            \"uuid\": \"336bef6f82024b47b8de8b53ed0583b5\"\n        },\n        {\n            \"name\": \"GTBank - Samuel Olamide\",\n            \"type\": \"Bank\",\n            \"uuid\": \"afbaa83aebdb4126abb8bbb81fdf0842\"\n        }\n    ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "example": "Payments account retrieved successfully"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "example": "Petty cash"
                          },
                          "type": {
                            "type": "string",
                            "example": "Cash"
                          },
                          "uuid": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {},
              "examples": {
                "Request Example": {
                  "value": {
                    "status": "success",
                    "message": "Payments account retrieved successfully",
                    "data": [
                      {
                        "name": "Petty cash",
                        "type": "Asset",
                        "uuid": null
                      },
                      {
                        "name": "Cash",
                        "type": "Asset",
                        "uuid": null
                      },
                      {
                        "name": "GT Bank - Olanase Yezid",
                        "type": "Bank",
                        "uuid": "336bef6f82024b47b8de8b53ed0583b5"
                      },
                      {
                        "name": "GTBank - Samuel Olamide",
                        "type": "Bank",
                        "uuid": "afbaa83aebdb4126abb8bbb81fdf0842"
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "66af161f6f18be002a6dc48f:650c579a6dcebb0033a95f55"
}
```