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

# Set payout method

> The body of the request should contain the appropriate data for the payout method you are setting. The field ids can be found by exporting payouts as .csv on the payouts page.



## OpenAPI

````yaml /api-reference/openapi.json put /affiliates/{affiliate_id}/payout-methods/{payout_method_id}/
openapi: 3.0.3
info:
  title: Tapfiliate REST API
  version: '1.6'
  description: >-
    Reference for the Tapfiliate REST API. See the introduction for
    authentication, pagination and rate limits.
  x-generated-from: ApiBlueprint@e23e51f
servers:
  - url: https://api.tapfiliate.com/1.6
    description: Production
security:
  - ApiKey: []
tags:
  - name: Customers
    description: >-
      People who signed up or paid after being referred by an affiliate. With
      recurring or lifetime commissions, later conversions for the same customer
      go to the same affiliate.
  - name: Conversions
    description: >-
      Sales and other actions you pay commissions for. Each conversion has one
      or more commissions.
  - name: Commissions
    description: >-
      What an affiliate earns for a conversion. Approve or disapprove them
      before payout.
  - name: Affiliates
    description: >-
      The partners who promote your programs, with their meta data, notes,
      payout methods and balances.
  - name: Affiliate Groups
    description: Groups for organising your affiliates.
  - name: Affiliate Prospects
    description: >-
      People who signed up through a recruitment source but are not affiliates
      yet.
  - name: Programs
    description: >-
      Your affiliate programs, the affiliates in them and their commission
      settings.
  - name: Payments
    description: Settle affiliate balances and look up past payments.
  - name: Clicks
    description: Visits through affiliate links, the first step of attribution.
paths:
  /affiliates/{affiliate_id}/payout-methods/{payout_method_id}/:
    put:
      tags:
        - Affiliates
      summary: Set payout method
      description: >-
        The body of the request should contain the appropriate data for the
        payout method you are setting. The field ids can be found by exporting
        payouts as .csv on the payouts page.
      operationId: setPayoutMethod
      parameters:
        - name: affiliate_id
          in: path
          description: The `id` of the affiliate
          required: true
          example: janejameson
          schema:
            type: string
        - name: payout_method_id
          in: path
          description: The `id` of the payout method
          required: true
          example: paypal
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              paypal_address: jane@example-blog.inc
            schema:
              type: object
              properties:
                paypal_address:
                  type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  title:
                    type: string
                  id:
                    type: string
                  details:
                    type: object
                    properties:
                      paypal_address:
                        type: string
                  primary:
                    type: boolean
              example:
                title: Paypal
                id: paypal
                details:
                  paypal_address: jane@example-blog.inc
                primary: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: The request is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorList'
          example:
            errors:
              - message: Missing mandatory parameter(s)
    Unauthorized:
      description: The API key is missing or wrong
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Authentication Failed.
            code: 401
    Forbidden:
      description: No API access or no permission for this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Forbidden
            code: 403
            traceId: 04ed655728a22bc0d39f
    NotFound:
      description: The object does not exist or belongs to another account
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Not Found
            code: 404
            traceId: 7ae8e92b77572da03805
  schemas:
    ErrorList:
      type: object
      description: Business and validation errors raised by an endpoint.
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
                description: Machine-readable code, on 409 responses.
              property_path:
                type: string
                description: The invalid field, on validation errors.
            required:
              - message
      required:
        - errors
    RequestError:
      type: object
      description: >-
        Errors raised before the endpoint runs: authentication, access, unknown
        path, server error.
      properties:
        message:
          type: string
        code:
          type: integer
        traceId:
          type: string
          description: Send this to support to find the request.
      required:
        - message
        - code
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Your API key, from your Tapfiliate account settings.

````

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