# List Payment Methods ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/managers/store/payment-methods: get: summary: List Payment Methods deprecated: false description: >- :::note[] **Note:** This API does not return the active payment methods configured in POS. ::: `account.read` - Account Read tags: - Default module/Apps/Merchant APIs/Store Settings - Payment Methods parameters: - name: Authorization in: header description: >- The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API. required: true example: '{{Autherization}}' schema: type: string - name: X-Manager-Token in: header description: >- This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The `X-Manager-Token` should be included in the header of API requests that require store-related information. required: true example: '{{Access-Token}}' schema: type: string - name: Accept-Language in: header description: >- Preferred language for the response. Defaults to `en` if not specified. required: false example: en schema: type: string enum: - en - ar examples: - en responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/200-get-payment-methods' headers: {} x-apidog-name: OK '401': description: '' content: application/json: schema: type: object description: >- Response returned when the request cannot be authenticated because the required credentials are missing, invalid, or expired. properties: status: type: string description: Indicates the overall status of the API response. examples: - error message: type: object description: >- Contains structured details explaining why the request could not be authenticated. properties: type: type: string description: Indicates the category of the response message. examples: - error code: type: string description: >- A machine-readable code identifying the authentication error. Returns null when no specific code is available. examples: - UNAUTHORIZED nullable: true name: type: string description: >- A short, human-readable title describing the authentication error. Returns null when no title is available. examples: - Unauthorized nullable: true description: type: string description: >- A human-readable explanation of why the request could not be authenticated. Returns null when no detailed explanation is available. examples: - >- Authentication credentials are missing, invalid, or expired. nullable: true required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - message x-apidog-orders: - status - message examples: - status: error message: type: error code: UNAUTHORIZED name: Unauthorized description: >- Authentication credentials are missing, invalid, or expired. x-apidog-ignore-properties: [] examples: '1': summary: Example 1 value: status: error message: type: error code: ERROR_SESSION_MISSING name: Sorry description: Please login first. '2': summary: Example 2 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Login session expired. Please login again. '3': summary: Example 3 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Invalid authentication headers: {} x-apidog-name: Unauthorized '500': description: '' content: application/json: schema: type: object properties: status: type: string description: Status of the error. message: $ref: '#/components/schemas/ResponseEnvelopMessage' required: - status - message x-apidog-orders: - status - message x-apidog-ignore-properties: [] example: status: error message: type: error code: MSG_HIDDEN name: Error description: Internal Server Error headers: {} x-apidog-name: Internal Server error security: [] x-apidog-folder: Default module/Apps/Merchant APIs/Store Settings x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-9148607-run components: schemas: 200-get-payment-methods: type: object properties: code: type: string description: A status code representing the response result. payload: type: array items: type: object properties: enabled: type: boolean description: >- A flag indicating whether the payment method is enabled (1) or disabled (0). code: type: string description: >- A unique identifier code for the payment method, which can be used for reference in other parts of the system. fees: type: number description: >- The fee associated with this payment method, represented as an integer. fees_string: type: string description: >- A string representation of the fee, which might include symbols, currency, or formatting. type: type: string description: >- The type/category of the payment method, which could define whether it’s a card, digital wallet, bank transfer, etc. nullable: true name: type: string description: The display name of the payment method. icons: type: array items: type: string examples: - >- https://zid-testing.s3.eu-west-1.amazonaws.com/static/cod.png examples: - - >- https://zid-testing.s3.eu-west-1.amazonaws.com/static/cod.png description: >- An array of URLs pointing to images/icons for the payment method. These icons are used to visually represent the payment method in the UI. id: type: integer description: A unique identifier for the payment method. examples: - 0 x-apidog-orders: - enabled - code - fees - fees_string - type - name - icons - id x-apidog-ignore-properties: [] description: >- An array of payment method objects, each representing a specific payment method available. x-stoplight: id: o6etcw866qqru x-apidog-orders: - code - payload x-apidog-ignore-properties: [] x-apidog-folder: '' ResponseEnvelopMessage: type: object properties: type: type: string description: Type of response message returned by the API. examples: - success code: type: string description: Response code returned by the API, if available. examples: - MSG_POPUP_OK nullable: true name: type: string description: Name or title of the response message, if available. examples: - Coupons nullable: true description: type: string description: Detailed description of the response message, if available. examples: - Coupons created successfully nullable: true required: - type - code - name - description description: Additional response metadata. x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.zid.sa/ description: Prod Env security: [] ```