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

# List Receivers

Retrieves all receivers for a specific user. Returns a paginated list of both INDIVIDUAL and BUSINESS receivers.

***

## Error Codes

### Common Errors

| HTTP Status | Code                   | Message                            |
| ----------- | ---------------------- | ---------------------------------- |
| 401         | `UNAUTHORIZED`         | "API Key is missing"               |
| 401         | `UNAUTHORIZED`         | "Invalid API Key format"           |
| 401         | `UNAUTHORIZED`         | "Invalid API Key"                  |
| 403         | `INVALID_PARTNER_FLOW` | "The partner has an invalid flow." |

### User Ownership Errors

| HTTP Status | Code           | Message                                              |
| ----------- | -------------- | ---------------------------------------------------- |
| 401         | `UNAUTHORIZED` | "Partner information is required for this operation" |
| 401         | `UNAUTHORIZED` | "User is not associated with the partner"            |

### Endpoint-Specific Errors

| HTTP Status | Code                        | Message                                                 |
| ----------- | --------------------------- | ------------------------------------------------------- |
| 500         | `RECEIVER_RETRIEVAL_FAILED` | "Failed to retrieve receivers. Please try again later." |


## OpenAPI

````yaml reference/openapi/ReceiverPartnerControllerV2_getReceiversByUser.json GET /api/partner/v2/receivers
openapi: 3.0.0
info:
  title: Capa Partner API - V2
  description: >-
    Partner API for integrating cryptocurrency on-ramp and off-ramp services
    using Capa's infrastructure. Enable your users to seamlessly convert between
    fiat and crypto.
  version: v2
  contact: {}
servers:
  - url: https://staging-api.capa.fi
  - url: https://production-api.capa.fi
security: []
paths:
  /api/partner/v2/receivers:
    get:
      tags:
        - receivers
      operationId: ReceiverPartnerControllerV2_getReceiversByUser
      parameters:
        - name: userId
          required: true
          in: query
          description: User ID to filter receivers by owner
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            type: string
      responses:
        '200':
          description: Returns the list of receivers associated with the user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      data:
                        description: List of receivers
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Receiver ID
                              example: 9486244c-ff7d-4c22-9984-797179d7deaa
                            userId:
                              type: string
                              description: User ID who created this receiver
                            receiverType:
                              type: string
                              description: Type of receiver
                              example: INDIVIDUAL
                              enum:
                                - INDIVIDUAL
                                - BUSINESS
                            email:
                              type: string
                              description: Email address
                            disabled:
                              type: boolean
                              description: Whether receiver is disabled
                              example: false
                            createdAt:
                              type: string
                              description: Creation timestamp
                            updatedAt:
                              type: string
                              description: Last update timestamp
                          required:
                            - id
                            - userId
                            - receiverType
                            - email
                            - disabled
                            - createdAt
                            - updatedAt
                      count:
                        type: number
                        description: Number of receivers in the current response
                        example: 5
                      total:
                        type: number
                        description: Total number of receivers for the user
                        example: 5
                    required:
                      - data
                      - count
                      - total
                    x-readme-ref-name: ListReceiversHttpResponse
              example:
                success: true
                data:
                  data:
                    - id: 9486244c-ff7d-4c22-9984-797179d7deaa
                      userId: string
                      receiverType: INDIVIDUAL
                      email: string
                      disabled: false
                      createdAt: string
                      updatedAt: string
                  count: 1
                  total: 1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                code: REQUIRED_USER_ID_ERROR
                message: This endpoint requires a user id to be provided
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED:
                  value:
                    success: false
                    code: UNAUTHORIZED
                    message: API Key is missing
                UNAUTHORIZED_2:
                  value:
                    success: false
                    code: UNAUTHORIZED
                    message: Invalid API Key format
                UNAUTHORIZED_3:
                  value:
                    success: false
                    code: UNAUTHORIZED
                    message: Invalid API Key
                UNAUTHORIZED_4:
                  value:
                    success: false
                    code: UNAUTHORIZED
                    message: Partner information is required for this operation
                UNAUTHORIZED_5:
                  value:
                    success: false
                    code: UNAUTHORIZED
                    message: User is not associated with the partner
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                code: USER_NOT_VERIFIED_ERROR
                message: >-
                  User is not allowed to perform the operations because has not
                  completed the KYC verification.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RECEIVER_RETRIEVAL_FAILED:
                  value:
                    success: false
                    code: RECEIVER_RETRIEVAL_FAILED
                    message: Failed to retrieve receivers. Please try again later.
                INTERNAL_SERVER_ERROR:
                  value:
                    success: false
                    code: INTERNAL_SERVER_ERROR
                    message: Internal server error
      security:
        - PartnerApiKey: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        code:
          type: string
          description: Machine-readable error code.
        message:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          description: Optional per-field validation details.
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
      required:
        - success
        - code
        - message
  securitySchemes:
    PartnerApiKey:
      type: apiKey
      in: header
      name: partner-api-key
      description: API key for the affiliated partner performing the request.

````