---
title: "GET /api/payments/strategies"
method: GET
path: "/api/payments/strategies"
tags: ["api", "payment-strategies"]
---

# GET /api/payments/strategies

`GET /api/payments/strategies`

Get Payment Strategies

## Query parameters

- `top` string
- `skip` string
- `name` string
- `optionId` string

## Response `200`

OK

- GETPaymentStrategiesGetPaymentStrategies200Response
  - `docs` object[]
    - `_id` string, required — The ID of the payment strategy
    - `sellerId` string, required — The ID of the seller
    - `name` string, required — The name of the payment strategy
    - `policy` object, required — The payment policy of the payment strategy
      - `allowedPaymentGateways` object[], required — The allowed payment gateways
        - `gatewayId` string, required — The ID of the payment gateway
      - `changePaymentMethodPolicy` 'always' | 'never' — The change payment method policy
      - `paymentCompletionPolicy` object — The payment completion policy
        - `target` 'none' | 'event_start_date' | 'event_end_date', required — The target for the payment completion policy
    - `options` object[], required — The payment options of the payment strategy
      - `_id` string — The ID of the payment option
      - `status` 'ENABLED' | 'DISABLED', required — The status of the payment option
      - `name` string, required — The name of the payment option
      - `scheme` 'one-off' | 'installments', required — The scheme of the payment option
      - `installmentOptions` object — The installment options of the payment option
        - `interval` 'DAY' | 'WEEK' | 'MONTH', required — The interval of the installment
        - `numberOfInstallments` integer, required — The number of installments
        - `every` integer, required — The number of intervals for each installment
        - `timingOptions` object — The placement options of the payment option
          - `type` 'first_installment' | 'last_installment', required — The type of the placement option
          - `offsetOptions` union
            - object — The offset options of the placement option
              - …
            - object — The offset options of the placement option
              - …
      - `downPaymentOptions` object — The down payment options of the payment option
        - `type` 'none' | 'percent' | 'fixed', required — The type of the down payment
        - `value` number, float, required — The value of the down payment
      - `requirements` object — The requirements of the payment option
        - `minAmount` number, float — The minimum amount
        - `maxAmount` number, float — The maximum amount
      - `feeOptions` object — The fee options of the payment option
        - `outerChargeVar` number, float — The variable outer charge
        - `outerChargeFix` number, float — The fixed outer charge
  - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)