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

# Get current partner settings



## OpenAPI

````yaml /raas-widgets/openapi.json get /partner/settings
openapi: 3.0.0
info:
  title: RaaS Widgets Partner API
  description: >
    REST API for RaaS Widgets partner integrations. Create magic links for
    embeddable flows, manage end users, track transfer operations, handle CIP
    verification, and configure webhooks for real-time event notifications.


    This specification covers the **Partner-accessible API** only (`X-API-Key`
    against `/partner/*`). Widget and Superadmin APIs are out of scope.


    ## Authentication


    All endpoints require an API key passed in the `X-API-Key` header. Use
    `raas_sandbox_*` keys for the sandbox environment and `raas_live_*` keys for
    production.


    ## Environments


    | Environment | Base URL |

    |---|---|

    | Sandbox | `https://raas-widgets-backend-sandbox.up.railway.app` |
  version: 1.18.0
  contact: {}
servers:
  - url: https://raas-widgets-backend-sandbox.up.railway.app
    description: Sandbox
security: []
tags:
  - name: Partner - Magic Links
    description: Create, list, and manage magic links for flows
  - name: Partner - Flows
    description: List enabled flows and the full flow catalog
  - name: Partner - Users
    description: View and manage end users associated with your partner account
  - name: Partner - Operations
    description: Track money transfer operations and their statuses
  - name: Partner - Requests
    description: List and inspect money-request records
  - name: Partner - Deferred Payouts
    description: List, inspect, and cancel deferred payout remittances
  - name: Partner - CIP
    description: Customer Identification Program (CIP) verification management
  - name: Partner - Data Requests
    description: Fulfill data requests for additional user information
  - name: Partner - Settings
    description: Configure partner-level settings (redirect URLs, logo, etc.)
  - name: Partner - Webhooks
    description: Configure webhook endpoints and inspect delivery history
  - name: Partner - Pricing
    description: >-
      Indicative pre-quote summaries (best / worst / averages) for partner
      integrations
paths:
  /partner/settings:
    get:
      tags:
        - Partner - Settings
      summary: Get current partner settings
      operationId: PartnerSettingsController_getSettings
      parameters: []
      responses:
        '200':
          description: Partner settings retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerSettingsResponseDto'
        '401':
          description: Unauthorized
      security:
        - api-key: []
components:
  schemas:
    PartnerSettingsResponseDto:
      type: object
      properties:
        sessionExpiredRedirectUrl:
          type: object
          description: URL to redirect users when their session expires
          example: https://app.example.com/transfer
          nullable: true
        supportEmail:
          type: object
          description: Support contact email shown in the widget
          example: support@example.com
          nullable: true
        supportWhatsappNumber:
          type: object
          description: Support WhatsApp number in E.164 format
          example: '+14155550123'
          nullable: true
        logoUrl:
          type: object
          description: Public URL for the partner logo shown in widgets
          example: https://api.example.com/api/v1/partners/partner_abc123/logo
          nullable: true
        requestMoney:
          description: Request Money API link configuration
          allOf:
            - $ref: '#/components/schemas/PartnerRequestMoneySettingsDto'
      required:
        - sessionExpiredRedirectUrl
        - supportEmail
        - supportWhatsappNumber
        - logoUrl
        - requestMoney
    PartnerRequestMoneySettingsDto:
      type: object
      properties:
        landingBaseUrl:
          type: object
          description: >-
            HTTPS base URL for the payer landing page. The API appends ?ref= or
            &ref= with the operation code for landingLink.
          example: https://app.example.com/pay
          nullable: true
        whatsappBaseUrl:
          type: object
          description: WhatsApp base URL (https://wa.me/<number>) used to build waLink.
          example: https://wa.me/502123456789
          nullable: true
        whatsappMessageTemplate:
          type: object
          description: >-
            Plain-text WhatsApp message template. Supports {{referenceId}} and
            {{landingLink}} placeholders.
          example: 'Pay {{referenceId}} here: {{landingLink}}'
          nullable: true
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your partner API key. Use `raas_sandbox_*` keys for the sandbox
        environment and `raas_live_*` keys for production.

````