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

# Get Customer Capabilities

> Returns the on-ramp and off-ramp capabilities available for a customer, including the supported rails and their activation status for each currency and corridor.



## OpenAPI

````yaml GET /v2/customers/{customer_id}/capabilities
openapi: 3.1.0
info:
  title: EngageXPay API
  version: 1.0.0
  description: >-
    A simple API specification for EngageXPay, a financial services platform
    that provides a range of banking and payment solutions for businesses and
    individuals. This API allows developers to integrate EngageXPay's services
    into their applications, enabling functionalities such as customer
    management, transaction processing, and access to financial data.
servers:
  - url: https://sandbox.api.engagexpay.com
    description: Sandbox server
  - url: https://api.engagexpay.com
    description: Production server
security: []
tags:
  - name: Authentication
    description: A modified OAuth 2.0 Client Credential Flow
  - name: Customers
    description: Customer management and document upload operations
  - name: Balances
    description: Retrieve wallet balance information
  - name: Catalogue
    description: |
      A set of endpoints to retrieve contextual data to assemble requests
      to EngageXPay's API
  - name: Beneficiaries
    description: Manage beneficiary accounts for payments and transfers
  - name: Transactions
    description: Transaction history and management for beneficiaries
  - name: Virtual Accounts
    description: Create and manage virtual accounts for USD to USDC conversions
  - name: Fees & FX Rates
    description: Retrieve fees and foreign exchange rates
paths:
  /v2/customers/{customer_id}/capabilities:
    get:
      tags:
        - Customers
      summary: Get Customer Capabilities
      description: >-
        Returns the on-ramp and off-ramp capabilities available for a customer,
        including the supported rails and their activation status for each
        currency and corridor.
      parameters:
        - name: customer_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          example: ed54db74-7dbe-47d2-8ea0-c2bf2a9dda06
      responses:
        '200':
          description: Customer capabilities retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      on_ramp:
                        type: array
                        items:
                          type: object
                          properties:
                            currency:
                              type: string
                              description: Payin currency.
                              example: USD
                            rail:
                              type: string
                              description: Payin rail for this currency.
                              example: ACH
                            status:
                              type: boolean
                              description: >-
                                Whether this route is currently enabled for the
                                customer.
                              example: true
                            crypto:
                              type: array
                              description: >-
                                Chains and tokens the payin can settle to. See
                                [Supported rails and
                                currencies](https://docs.engagexpay.com/guides/coverage/supported-rails-and-currencies).
                              items:
                                type: object
                                properties:
                                  chain:
                                    type: string
                                    example: POLYGON
                                  tokens:
                                    type: array
                                    items:
                                      type: string
                                    example:
                                      - USDC
                      off_ramp:
                        type: array
                        items:
                          type: object
                          properties:
                            corridor:
                              type: string
                              description: Payout country, ISO 3166-1 alpha-3.
                              example: BGD
                            currency_wise_rail:
                              type: array
                              items:
                                type: object
                                properties:
                                  currency:
                                    type: string
                                    example: BDT
                                  scheme:
                                    type: string
                                    nullable: true
                                    description: >-
                                      Payout scheme for this currency, LOCAL or
                                      INTERNATIONAL. Null when the corridor has
                                      no scheme distinction.
                                    example: LOCAL
                                  rails:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        rail:
                                          type: string
                                          nullable: true
                                          description: >-
                                            Named rail within the scheme, for
                                            example SPEI. Null when the scheme has
                                            no named rail.
                                          example: SPEI
                                        status:
                                          type: boolean
                                          description: >-
                                            Whether this route is currently enabled
                                            for the customer.
                                          example: true
                                        crypto:
                                          type: array
                                          description: >-
                                            Chains and tokens that can fund a payout
                                            on this route. See [Supported rails and
                                            currencies](https://docs.engagexpay.com/guides/coverage/supported-rails-and-currencies).
                                          items:
                                            type: object
                                            properties:
                                              chain:
                                                type: string
                                                example: POLYGON
                                              tokens:
                                                type: array
                                                items:
                                                  type: string
                                                example:
                                                  - USDC
              examples:
                OK:
                  summary: OK
                  value:
                    data:
                      on_ramp:
                        - currency: USD
                          rail: SWIFT
                          status: true
                          crypto:
                            - chain: BASE
                              tokens:
                                - USDC
                            - chain: ETHEREUM
                              tokens:
                                - USDC
                            - chain: POLYGON
                              tokens:
                                - USDC
                            - chain: SOLANA
                              tokens:
                                - USDC
                        - currency: USD
                          rail: ACH
                          status: true
                          crypto:
                            - chain: BASE
                              tokens:
                                - USDC
                            - chain: ETHEREUM
                              tokens:
                                - USDC
                            - chain: POLYGON
                              tokens:
                                - USDC
                            - chain: SOLANA
                              tokens:
                                - USDC
                        - currency: USD
                          rail: FEDWIRE
                          status: true
                          crypto:
                            - chain: BASE
                              tokens:
                                - USDC
                            - chain: ETHEREUM
                              tokens:
                                - USDC
                            - chain: POLYGON
                              tokens:
                                - USDC
                            - chain: SOLANA
                              tokens:
                                - USDC
                      off_ramp:
                        - corridor: AUS
                          currency_wise_rail:
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: BGD
                          currency_wise_rail:
                            - currency: BDT
                              scheme: LOCAL
                              rails:
                                - rail: null
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: CAN
                          currency_wise_rail:
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: DEU
                          currency_wise_rail:
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: GBR
                          currency_wise_rail:
                            - currency: GBP
                              scheme: LOCAL
                              rails:
                                - rail: null
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: IND
                          currency_wise_rail:
                            - currency: INR
                              scheme: LOCAL
                              rails:
                                - rail: null
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: MEX
                          currency_wise_rail:
                            - currency: MXN
                              scheme: LOCAL
                              rails:
                                - rail: SPEI
                                  status: false
                                  crypto: []
                        - corridor: NPL
                          currency_wise_rail:
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: PAK
                          currency_wise_rail:
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                            - currency: PKR
                              scheme: null
                              rails:
                                - rail: null
                                  status: false
                                  crypto: []
                        - corridor: PHL
                          currency_wise_rail:
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: POL
                          currency_wise_rail:
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: SGP
                          currency_wise_rail:
                            - currency: SGD
                              scheme: LOCAL
                              rails:
                                - rail: null
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                        - corridor: USA
                          currency_wise_rail:
                            - currency: USD
                              scheme: INTERNATIONAL
                              rails:
                                - rail: SWIFT
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                            - currency: USD
                              scheme: LOCAL
                              rails:
                                - rail: ACH
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
                                - rail: FEDWIRE
                                  status: true
                                  crypto:
                                    - chain: BASE
                                      tokens:
                                        - USDC
                                    - chain: ETHEREUM
                                      tokens:
                                        - USDC
                                    - chain: POLYGON
                                      tokens:
                                        - USDC
                                    - chain: SOLANA
                                      tokens:
                                        - USDC
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  responses:
    AuthenticationError:
      description: Authentication failed due to invalid credentials
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Authentication failed
    NotFoundError:
      description: Resource not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Resource not found
    ValidationError:
      description: Failed due to a formatting error.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              errors:
                type: array
                items:
                  type: object
                  additionalProperties:
                    type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token authentication. Obtain token from [Issue a
        Token](https://docs.engagexpay.com/api-reference/authentication/issue-a-token)
        endpoint

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.