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

# Get a payment method

> One method with its live status, limits, settlement estimate, and the input `fields` it needs. Check this before creating a recipient or payout on a rail to catch limit or outage problems up front.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/capabilities/{country}/{method}
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
security:
  - bearerAuth: []
paths:
  /v1/capabilities/{country}/{method}:
    get:
      tags:
        - Capabilities
      summary: Get a payment method
      description: >-
        One method with its live status, limits, settlement estimate, and the
        input `fields` it needs. Check this before creating a recipient or
        payout on a rail to catch limit or outage problems up front.
      parameters:
        - schema:
            type: string
            description: ISO 3166-1 alpha-2 country code, case-insensitive.
            example: GH
          required: true
          name: country
          in: path
        - schema:
            type: string
            description: Method code.
            example: gh_mtn
          required: true
          name: method
          in: path
      responses:
        '200':
          description: The method.
          content:
            application/json:
              schema:
                type: object
                properties:
                  method:
                    $ref: '#/components/schemas/PaymentMethod'
                required:
                  - method
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
        '404':
          description: No such resource in this organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: not_found
                message: Method gh_mtn for country GH not found
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    PaymentMethod:
      type: object
      properties:
        code:
          type: string
          description: >-
            The identifier you pass as `code` on recipients, payouts, and
            collections.
          example: gh_mtn
        name:
          type: string
          example: MTN Mobile Money
        type:
          type: string
          enum:
            - mobile_money
            - bank_transfer
            - crypto
            - wallet
        status:
          type: string
          enum:
            - operational
            - degraded
            - outage
          description: Live health from the last 30 minutes of traffic on this rail.
        limits:
          type:
            - object
            - 'null'
          properties:
            min:
              type: number
              example: 1
            max:
              type: number
              example: 50000
            currency:
              type: string
              example: GHS
          required:
            - min
            - max
            - currency
          description: Per-transaction bounds, or null when the rail has none configured.
        estimatedSettlement:
          type: string
          description: >-
            How long the receiver typically waits: `instant`, a minute range, or
            `varies`.
          example: 0-5 minutes
        fields:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: >-
                  The recipient/charge field this describes: `accountNumber` for
                  fiat rails, `address` for crypto.
                example: accountNumber
              label:
                type: string
                example: Phone Number
              type:
                type: string
                enum:
                  - text
                  - phone
                  - select
              placeholder:
                type: string
                example: +233XXXXXXXXX
              description:
                type: string
              group:
                type: string
                description: Fields sharing a group are alternatives — collect one of them.
              options:
                type: array
                items:
                  type: object
                  properties:
                    label:
                      type: string
                    value:
                      type: string
                  required:
                    - label
                    - value
                description: Choices for `select` fields.
            required:
              - key
              - label
              - type
          description: >-
            What to collect from the user to address this method — drive your
            form from this instead of hardcoding per rail.
      required:
        - code
        - name
        - type
        - status
        - limits
        - estimatedSettlement
        - fields
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````