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

# Get Aggregator



## OpenAPI

````yaml get /v1/aggregators/{raast-aggregator-id}
openapi: 3.1.0
info:
  title: Raast Wire
  version: 1.0.0
  description: ''
servers:
  - url: https://api.getsafepay.com/raastwire
security: []
tags:
  - name: Aggregators
  - name: Access Keys
  - name: Merchants
  - name: Raast Merchants
  - name: Payments
  - name: Refunds
  - name: QRs
  - name: Utilities
  - name: Aliases
  - name: Ledgers
  - name: Webhooks
paths:
  /v1/aggregators/{raast-aggregator-id}:
    get:
      tags:
        - Aggregators
      summary: Get Aggregator
      parameters:
        - $ref: '#/components/parameters/AggregatorIdParam'
      responses:
        '201':
          $ref: '#/components/responses/AggregatorResponse'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - apiKey: []
components:
  parameters:
    AggregatorIdParam:
      name: raast-aggregator-id
      in: path
      required: true
      schema:
        type: string
        example: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e
      description: The unique identifier for the aggregator
  responses:
    AggregatorResponse:
      description: This response contains details of an aggregator
      headers:
        Content-Length:
          $ref: '#/components/headers/ContentLengthHeader'
        Date:
          $ref: '#/components/headers/DateHeader'
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/StandardResponse'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Aggregator'
                    description: Aggregator resource found for the supplied identifier
          examples:
            AggregatorFound:
              value:
                api_version: v1
                data:
                  id: '2'
                  token: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e
                  partner_id: partner_ed4f0480-36c8-4a5a-8cd4-381bc4d83f2c
                  bank_account_id: acc_c03a57cb-a616-42a7-b1dc-de473217a558
                  name: DLocal
                  is_active: true
                  is_super: true
                  vault_enabled: true
                  bank_account:
                    id: '11'
                    token: acc_c03a57cb-a616-42a7-b1dc-de473217a558
                    vault_token: lock_464309f2-572f-493f-8272-e503277b06fd
                    title: JFIZG
                    iban: PK85HABB0002157901170103
                    redacted_iban: PK85HABB************0103
                    hashed_iban: MioWSkE1a8HST07eqMVnfz/zZIzPFqhKGMIjDTOjPWc=
                    servicer: HABBPKKARTG
                    bank: ''
                    depositor_id: dep_31b1166f-de14-4e66-ba4a-2a321ca55a77
                    owner: raast
                    kind: 5
                    version: v1
                    created_at: '2025-03-13T09:12:35Z'
                    updated_at: '2025-12-04T13:22:23Z'
                  keys:
                    - id: '2'
                      token: ak_fa66e6f5-cd88-4d8a-8fe7-0eb1898d20a3
                      key_id: key_452442dc-d6b3-4cbb-bcc6-8781ef2d3498
                      aggregator_id: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e
                      is_active: true
                      name: Staging key
                      secret: >-
                        18108aad30da06075e6f02fab3166926827538363842185faf6e3e694ea5d481
                      created_at: '2025-03-13T09:12:51Z'
                      updated_at: '2025-03-13T09:12:51Z'
                    - id: '4'
                      token: ak_da8f1c10-346a-4be8-895a-b6187a9a9662
                      key_id: key_28d69595-4ae4-4645-b9d8-300fa5211845
                      aggregator_id: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e
                      is_active: true
                      name: prod key
                      secret: >-
                        23052bb4602992643b8cd3aaee10a1054a5b071a2ecd3bf2e39ba5072ad3f4cd
                      created_at: '2025-05-23T10:02:26Z'
                      updated_at: '2025-08-05T12:51:05Z'
                  created_at: '2025-03-13T09:12:34Z'
                  updated_at: '2025-12-04T15:39:33Z'
    NotFound:
      description: Resource not found
      headers:
        Content-Length:
          $ref: '#/components/headers/ContentLengthHeader'
        Date:
          $ref: '#/components/headers/DateHeader'
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/ErrorResponse'
              - type: object
                properties:
                  code:
                    example: error.not_found
                  message:
                    example: Requested resource not found
  headers:
    ContentLengthHeader:
      schema:
        type: string
        example: '256'
    DateHeader:
      schema:
        type: string
        example: Sat, 12 Aug 2023 08:55:04 GMT
  schemas:
    StandardResponse:
      type: object
      description: Standard response structure for successful operations
      properties:
        api_version:
          type: string
          example: v1
          description: The current version of the API spec
        data:
          type: object
          description: Contains the response data
    Aggregator:
      type: object
      description: Aggregator resource containing configuration and linked access keys
      properties:
        token:
          type: string
          description: Public token assigned to the aggregator
          example: agg_tok_2b42c4d0
        partner_id:
          type: string
          description: Partner identifier associated with the aggregator account
          example: partner_123456
        bank_account_id:
          type: string
          description: Identifier of the default settlement bank account
          example: ba_2cab1524-805d-4a09-8e51-924ddf3f43ea
        name:
          type: string
          description: Human-readable name of the aggregator
          example: Example Aggregator
        is_active:
          type: boolean
          description: Indicates whether the aggregator is currently active
          example: true
        is_super:
          type: boolean
          description: Indicates whether the aggregator has super admin privileges
          example: true
        vault_enabled:
          type: boolean
          description: Specifies if Safepay vault features are enabled for the aggregator
          example: true
        bank_account:
          $ref: '#/components/schemas/BankAccount'
          description: Bank account resource associated with the aggregator when available
        keys:
          type: array
          description: Collection of access keys associated with the aggregator
          items:
            $ref: '#/components/schemas/AccessKey'
        created_at:
          description: Timestamp indicating when the aggregator was created
          allOf:
            - $ref: '#/components/schemas/Timestamp'
        updated_at:
          description: Timestamp indicating the last update to the aggregator
          allOf:
            - $ref: '#/components/schemas/Timestamp'
    ErrorResponse:
      type: object
      description: Standard error response structure
      properties:
        code:
          type: string
          description: Error code identifying the type of error
        message:
          type: string
          description: Human-readable error message
    BankAccount:
      type: object
      properties:
        id:
          type: string
          description: Internal Safepay identifier for the bank account
        token:
          type: string
        vault_token:
          type: string
        title:
          type: string
        iban:
          type: string
        redacted_iban:
          type: string
        hashed_iban:
          type: string
        servicer:
          type: string
        bank:
          type: string
        depositor_id:
          type: string
        owner:
          type: string
        kind:
          type: integer
        version:
          type: string
        created_at:
          $ref: '#/components/schemas/Timestamp'
        updated_at:
          $ref: '#/components/schemas/Timestamp'
    AccessKey:
      type: object
      description: Access key credential used to authenticate aggregator API requests
      properties:
        id:
          type: string
          description: Internal identifier for the access key
          example: ak_da8f1c10-346a-4be8-895a-b6187a9a9662
        token:
          type: string
          description: Public token that represents the access key
          example: ak_tok_fede37a6
        key_id:
          type: string
          description: External identifier for the key exposed to clients
          example: key_live_e111f1c10
        aggregator_id:
          type: string
          description: Aggregator identifier that owns the access key
          example: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e
        is_active:
          type: boolean
          description: Indicates whether the key can be used for authentication
          example: true
        name:
          type: string
          description: Friendly label assigned to the access key
          example: Primary Production Key
        secret:
          type: string
          description: >-
            Secret value issued for the key; only returned on creation or
            rotation
          example: sk_live_uMPN7cX2b1
        created_at:
          description: Timestamp indicating when the key was provisioned
          allOf:
            - $ref: '#/components/schemas/Timestamp'
        updated_at:
          description: Timestamp indicating the last update applied to the key
          allOf:
            - $ref: '#/components/schemas/Timestamp'
    Timestamp:
      type: string
      format: date-time
      description: ISO 8601 timestamp in UTC
      example: '2025-03-13T09:12:34.000Z'
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-SFPY-AGGREGATOR-SECRET-KEY
      in: header

````