> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wava.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get available payment gateways

> Retrieve the list of payment gateways available for your store. Returns all active gateways with their specific requirements, supported currencies, and display information.

Use this endpoint to:
- Display payment options dynamically in your checkout
- Determine which fields to collect from the buyer based on each gateway's requirements
- Get gateway logos and descriptions for UI display
- Check which gateways support direct API orders vs. hosted checkout only

Amount validation (min/max limits per gateway) is performed during order creation, not during gateway discovery.




## OpenAPI

````yaml /api-reference/openapi.yaml get /orders/paymentGateways
openapi: 3.0.3
info:
  title: Wava Public API
  description: >
    # Wava API Documentation


    Wava Technologies provides a unified payment processing platform for
    Colombian and Latin American digital payment methods. This documentation
    covers all integration options available to merchants and partners.


    ## Integration Options


    | Method | Description | Best For |

    |--------|-------------|----------|

    | **Direct API** | Full control over payment flow | Custom checkout
    experiences |

    | **Payment Links** | Shareable URLs for payment collection | Quick
    invoicing, social selling |

    | **Dynamic Links** | Payment links without fixed amount | Donations, tips,
    variable pricing |

    | **Partners API** | Manage stores and process payments on their behalf |
    Platforms, aggregators, resellers |

    | **E-commerce Plugins** | Pre-built integrations | Tiendanube, WooCommerce
    stores |

    | **Stripe Connect** | Card payments via connected Stripe accounts |
    Merchants wanting card acceptance |


    ## Authentication


    All API requests require authentication via a merchant key in the request
    header:


    ```

    merchant-key: YOUR_MERCHANT_KEY

    ```


    Partner API requests additionally require two headers for two-factor
    authentication:


    ```

    X-API-Key: YOUR_PARTNER_API_KEY

    X-API-Secret: YOUR_PARTNER_SECRET_KEY

    ```


    Contact Wava support to obtain your credentials and configure your store for
    API access.


    ## Environments


    | Environment | Base URL | Purpose |

    |------------|----------|---------|

    | **Production** | `https://api.wava.co/v1` | Live transactions |

    | **Development** | `https://api.dev.wava.co/v1` | Testing and development |


    ## Supported Payment Methods


    | Gateway | Description | Currency | Requirements | Flow |

    |---------|-------------|----------|--------------|------|

    | **Nequi** | Mobile wallet | COP | Phone number + National ID | Push
    notification approval |

    | **Daviplata** | Digital wallet | COP | National ID + Document type (CC,
    CE, TI only) | SMS OTP verification |

    | **Breb (Bre-B)** | Interbank transfer | COP | National ID + Document type
    (CC, CE, TI only) | QR code / transfer key |

    | **Stripe** | Card payments | Multiple | Connected Stripe account | Card
    form (not available via Direct API) |


    **Note:** All direct API orders require `id_number` and `id_type` in the
    shopper object, regardless of the payment gateway. This is required for
    compliance and buyer identification. The API also accepts
    `national_id_number` and `id_national_document_type` as aliases.


    ## Changes from v1


    - **New gateway: Breb** — Interbank transfers via QR code or transfer key

    - **Payment Links API** — Create shareable payment URLs programmatically

    - **Dynamic Links** — Payment links where the buyer enters the amount

    - **Partners API** — Platform partners can operate on behalf of onboarded
    stores

    - **Simplified field names**: `id_number` and `id_type` are the recommended
    shopper fields. Legacy names `national_id_number` and
    `id_national_document_type` are still accepted as aliases.
  version: 2.0.0
  contact:
    name: Wava API Support
    email: soporte@wava.co
    url: https://wava.co/contacto
servers:
  - url: https://api.wava.co/v1
    description: Production server
  - url: https://api.dev.wava.co/v1
    description: Development server
security:
  - MerchantKeyAuth: []
tags:
  - name: Payment Gateways
    description: >
      Discover available payment methods for your store. Use these endpoints to
      determine which gateways are active, their requirements, and supported
      currencies.


      Call this endpoint before creating orders to dynamically build your
      payment form based on each gateway's requirements.
  - name: Orders
    description: >
      Create and manage payment orders with direct API processing. This is the
      core integration for merchants who want full control over the checkout
      experience.


      **Supported flows:**

      - **Nequi**: Push notification → buyer approves in app → webhook
      confirmation

      - **Daviplata**: Order created → SMS OTP sent → submit OTP → confirmation

      - **Breb**: Order created → QR code + transfer key returned → buyer
      completes transfer → webhook confirmation


      **Order lifecycle:** `pending` → `processing` → `confirmed` / `cancelled`
      / `refunded`


      **Important:** All direct API orders require `id_number` and `id_type` in
      the shopper object for compliance purposes, regardless of the payment
      gateway.
  - name: Links
    description: >
      Create shareable payment URLs that redirect buyers to a hosted checkout
      page. Payment links are ideal for invoicing, social media selling, or any
      scenario where you want to collect payment without building a custom
      checkout.


      **Payment link types:**

      - **Standard link**: Fixed amount — buyer selects payment method and
      completes payment

      - **Dynamic link**: No fixed amount — buyer enters the amount before
      paying. Create by omitting the `amount` field.


      Links are accessed by buyers at `https://checkout.wava.co/{hash}`.
  - name: Partners
    description: >
      The Partners API allows approved platform partners to manage stores and
      process payments on their behalf. Partners can onboard merchants, create
      orders and payment links, and access transaction data for their portfolio
      of stores.


      **Authentication**: Partners include both the `X-API-Key` and
      `X-API-Secret` headers (partner two-factor authentication) plus the
      `merchant-key` (store identification). The partner credentials
      authenticate the partner, and the merchant key identifies which store the
      operation is for.


      Contact Wava to apply for partner access.
  - name: Utilities
    description: >
      Helper endpoints that provide reference data needed for payment
      processing, such as document types by country. Use these to build
      localized payment forms.
  - name: Integrations
    description: >
      Pre-built integrations for e-commerce platforms and third-party services.


      **Available integrations:**

      - **Tiendanube**: Automatic payment processing for Tiendanube stores

      - **WooCommerce**: WordPress plugin for WooCommerce checkout

      - **Stripe Connect**: Accept card payments through a connected Stripe
      account


      See the dedicated guide for each integration for setup instructions and
      configuration.
externalDocs:
  description: Full Documentation Portal
  url: https://docs.wava.co
paths:
  /orders/paymentGateways:
    get:
      tags:
        - Payment Gateways
      summary: Get available payment gateways
      description: >
        Retrieve the list of payment gateways available for your store. Returns
        all active gateways with their specific requirements, supported
        currencies, and display information.


        Use this endpoint to:

        - Display payment options dynamically in your checkout

        - Determine which fields to collect from the buyer based on each
        gateway's requirements

        - Get gateway logos and descriptions for UI display

        - Check which gateways support direct API orders vs. hosted checkout
        only


        Amount validation (min/max limits per gateway) is performed during order
        creation, not during gateway discovery.
      operationId: getPaymentGateways
      parameters:
        - name: currency
          in: query
          description: >-
            Filter gateways by currency. Defaults to your store's primary
            currency.
          required: false
          schema:
            type: string
            example: COP
            pattern: ^[A-Z]{3}$
      responses:
        '200':
          description: Payment gateways retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PaymentGatewaysResponse'
              examples:
                colombian_gateways:
                  summary: Colombian payment gateways
                  value:
                    data:
                      store_currency: COP
                      accepted_currencies:
                        - COP
                      payment_gateways:
                        - id_payment_gateway: 1
                          gateway_name: Nequi
                          allowed_currencies:
                            - COP
                          requires_phone: true
                          required_shopper_national_id: false
                          description: Paga con tu celular usando Nequi
                          gateway_logo: https://cdn.wava.co/logos/nequi.png
                          supports_direct_api: true
                        - id_payment_gateway: 2
                          gateway_name: Daviplata
                          allowed_currencies:
                            - COP
                          requires_phone: false
                          required_shopper_national_id: true
                          description: Paga con Daviplata usando tu cédula
                          gateway_logo: https://cdn.wava.co/logos/daviplata.png
                          supports_direct_api: true
                        - id_payment_gateway: 9
                          gateway_name: Breb
                          allowed_currencies:
                            - COP
                          requires_phone: false
                          required_shopper_national_id: true
                          description: Transferencia interbancaria con QR o clave
                          gateway_logo: https://cdn.wava.co/logos/breb.png
                          supports_direct_api: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/StoreNotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    PaymentGatewaysResponse:
      type: object
      properties:
        store_currency:
          type: string
          description: Default currency for your store.
          example: COP
        accepted_currencies:
          type: array
          items:
            type: string
          description: All currencies accepted by your store.
          example:
            - COP
        payment_gateways:
          type: array
          items:
            $ref: '#/components/schemas/PaymentGateway'
    PaymentGateway:
      type: object
      properties:
        id_payment_gateway:
          type: integer
          description: Gateway ID to use in order creation requests.
          example: 1
        gateway_name:
          type: string
          description: Display name of the payment gateway.
          example: Nequi
        allowed_currencies:
          type: array
          items:
            type: string
          description: Currencies supported by this gateway.
          example:
            - COP
        requires_phone:
          type: boolean
          description: >-
            If true, the buyer's phone number is used to initiate payment (e.g.,
            Nequi push notification).
          example: true
        required_shopper_national_id:
          type: boolean
          description: >-
            If true, the buyer's national ID and document type are additionally
            used by the gateway to initiate payment (e.g., Daviplata, Breb).
            Note that national ID fields are required on all direct API orders
            regardless of this flag.
          example: false
        description:
          type: string
          description: Localized description for display in checkout UI.
          example: Paga con tu celular usando Nequi
        gateway_logo:
          type: string
          format: uri
          description: URL to the gateway logo for checkout UI display.
          example: https://cdn.wava.co/logos/nequi.png
        supports_direct_api:
          type: boolean
          description: >-
            If true, this gateway supports Direct API order creation. If false,
            only available through payment links or hosted checkout.
          example: true
    ErrorResponse:
      type: object
      required:
        - code
        - message
        - error
      properties:
        code:
          type: integer
          description: Numeric error code grouped by category. See Error Codes section.
          example: 4001
        api_code:
          type: string
          description: Machine-readable error identifier.
          example: PAYMENT_GATEWAY_REQUIRED
        message:
          type: string
          description: Human-readable error message.
          example: Payment gateway is required
        description:
          type: string
          description: Detailed explanation and resolution guidance.
          example: A payment gateway must be specified to process the order
        error:
          type: boolean
          example: true
        gateway_name:
          type: string
          description: Relevant payment gateway (included in gateway-specific errors).
          example: Nequi
        provided_currency:
          type: string
          description: Currency provided in request (included in currency errors).
          example: USD
        supported_currency:
          type: string
          description: Expected currency (included in currency errors).
          example: COP
        validation_errors:
          type: array
          description: Field-level validation errors.
          items:
            type: object
            properties:
              field:
                type: string
                example: phone_number
              message:
                type: string
                example: Phone number is required for Nequi payments
  responses:
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid_merchant_key:
              summary: Invalid merchant key
              value:
                code: 4007
                api_code: INVALID_MERCHANT_KEY
                message: Invalid merchant key
                description: The provided merchant key is invalid or expired
                error: true
    StoreNotFound:
      description: Store not found or inactive
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            store_not_found:
              summary: Store not found
              value:
                code: 3001
                api_code: STORE_NOT_FOUND
                message: Store not found
                description: The specified store does not exist
                error: true
            store_inactive:
              summary: Store inactive
              value:
                code: 3002
                api_code: STORE_INACTIVE
                message: Store inactive
                description: The store is not active and cannot process orders
                error: true
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal_error:
              summary: Internal server error
              value:
                code: 7001
                api_code: INTERNAL_SERVER_ERROR
                message: Internal server error
                description: An unexpected error occurred while processing your request
                error: true
  securitySchemes:
    MerchantKeyAuth:
      type: apiKey
      in: header
      name: merchant-key
      description: |
        Merchant key for store identification. Required for all API requests.
        ```
        merchant-key: YOUR_MERCHANT_KEY
        ```

````