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

# Read a payout

> Reads one payout. A payout that fails while being sent answers 404 and leaves its merchant's list until Quidkey staff resolve it, when it returns under the same `id`, and that holds when a transaction's `payout` link points at it. Part or all of its money may have moved by then.

Credentials: `partner`, `merchant`

Permission: `payouts:get`



## OpenAPI

````yaml /api-reference/v1/payment-api.json get /payouts/{id}
openapi: 3.1.0
info:
  title: Quidkey API
  version: 1.0.0
  description: >-
    The Quidkey public API.


    Within a version, a response can carry what this document doesn't list yet:
    a new field, a new value of an enum, a new error code. Handle a value you
    don't recognise rather than refusing the response. A client generated from
    this document turns an `enum` into a closed type unless told otherwise, so
    turn on its option for unknown values, such as openapi-generator's
    `enumUnknownDefaultCase`. A request is held to what's listed: a value it
    doesn't list is refused.
  contact:
    name: Quidkey
    url: https://docs.quidkey.com
servers:
  - url: https://api.quidkey.com/v1
security:
  - bearer: []
tags:
  - name: api_key
  - name: bank
  - name: bank_account
  - name: merchant
  - name: payment_link
  - name: payout
  - name: transaction
  - name: webhook_endpoint
paths:
  /payouts/{id}:
    get:
      tags:
        - payout
      summary: Read a payout
      description: >-
        Reads one payout. A payout that fails while being sent answers 404 and
        leaves its merchant's list until Quidkey staff resolve it, when it
        returns under the same `id`, and that holds when a transaction's
        `payout` link points at it. Part or all of its money may have moved by
        then.


        Credentials: `partner`, `merchant`


        Permission: `payouts:get`
      operationId: payout.get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            minLength: 1
            type: string
        - name: view
          in: query
          required: false
          description: The representation to answer with.
          schema:
            type: string
            enum:
              - full
            default: full
      responses:
        '200':
          description: The payout, in the full view.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - result
                  - entities
                  - not_included
                properties:
                  result:
                    $ref: '#/components/schemas/PayoutFull'
                  entities:
                    additionalProperties: false
                    description: Nothing can be included here.
                    type: object
                    properties: {}
                  not_included:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotIncludedEntry'
        '400':
          description: '`VALIDATION_FAILED`: The request is malformed or failed validation.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - VALIDATION_FAILED
        '401':
          description: '`UNAUTHENTICATED`: A valid bearer token is required.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - UNAUTHENTICATED
        '403':
          description: >-
            `FORBIDDEN`: This credential doesn't have permission for this
            endpoint.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - FORBIDDEN
        '404':
          description: '`NOT_FOUND`: Not found.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - NOT_FOUND
        '406':
          description: '`NOT_ACCEPTABLE`: This endpoint doesn''t offer the format in Accept.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - NOT_ACCEPTABLE
        '429':
          description: '`RATE_LIMITED`: Too many requests.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - RATE_LIMITED
        '500':
          description: '`INTERNAL_ERROR`: Something went wrong on our side.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - INTERNAL_ERROR
        '503':
          description: '`SERVICE_UNAVAILABLE`: The service is busy. Try again shortly.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - SERVICE_UNAVAILABLE
components:
  headers:
    RequestId:
      description: Identifies this request. Quote it to support.
      schema:
        type: string
    RetryAfter:
      description: How many seconds to wait before retrying.
      schema:
        minimum: 0
        type: integer
  schemas:
    PayoutFull:
      additionalProperties: false
      type: object
      required:
        - _type
        - _uri
        - _view
        - id
        - created_at
        - updated_at
        - merchant
        - status
        - origin
        - amount
        - gross_amount
        - fee_amount
        - net_amount
        - refund_retained_amount
        - refund_retention_rate
        - bank_reference
        - transaction_count
        - transactions
        - sent_at
      properties:
        _type:
          const: payout
          type: string
        _uri:
          pattern: ^/
          description: The canonical URI, relative to the version root.
          type: string
        _view:
          const: full
          type: string
        id:
          type: string
        created_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        updated_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        merchant:
          $ref: '#/components/schemas/MerchantLink'
        status:
          type: string
          enum:
            - pending
            - processing
            - sent
          description: >-
            Where the payout stands.


            - `pending`: Created and not yet sent, including a payout held by a
            pause on the merchant or its account. One paused partway may already
            have moved its `refund_retained_amount`.

            - `processing`: Sending has started. It stays here if sending is
            interrupted, until Quidkey staff reconcile it, and part or all of
            the money may already have moved.

            - `sent`: The provider accepted the transfer. That doesn't confirm
            the money arrived: a transfer that later bounces comes back as a
            credit on the account and doesn't change this.
        origin:
          type: string
          enum:
            - scheduled
            - manual
          description: >-
            `scheduled`: made by the merchant's schedule. `manual`: made by
            Quidkey staff.
        amount:
          type: object
          allOf:
            - $ref: '#/components/schemas/Money'
            - type: object
              required:
                - value
              properties:
                value:
                  minimum: 0
                  maximum: 9007199254740991
                  type: integer
          description: >-
            What the merchant receives: `net_amount` minus
            `refund_retained_amount`.
        gross_amount:
          type: object
          allOf:
            - $ref: '#/components/schemas/Money'
            - type: object
              required:
                - value
              properties:
                value:
                  minimum: 0
                  maximum: 9007199254740991
                  type: integer
          description: >-
            The covered transactions before fees, in the payout currency:
            `net_amount` plus `fee_amount`.
        fee_amount:
          type: object
          allOf:
            - $ref: '#/components/schemas/Money'
            - type: object
              required:
                - value
              properties:
                value:
                  minimum: 0
                  maximum: 9007199254740991
                  type: integer
          description: Quidkey's fees on those transactions, including any tax on them.
        net_amount:
          type: object
          allOf:
            - $ref: '#/components/schemas/Money'
            - type: object
              required:
                - value
              properties:
                value:
                  minimum: 0
                  maximum: 9007199254740991
                  type: integer
          description: After fees, before anything is retained.
        refund_retained_amount:
          type: object
          allOf:
            - $ref: '#/components/schemas/Money'
            - type: object
              required:
                - value
              properties:
                value:
                  minimum: 0
                  maximum: 9007199254740991
                  type: integer
          description: >-
            Moved, or to be moved, to the merchant's refund account instead of
            being paid out.
        refund_retention_rate:
          anyOf:
            - $ref: '#/components/schemas/Rate'
            - type: 'null'
          description: The rate this payout used. `null` when none is held.
        bank_reference:
          type: string
          description: >-
            The reference the transfer is sent under. Banks don't always show
            it.
        transaction_count:
          minimum: 0
          type: integer
        transactions:
          $ref: '#/components/schemas/TransactionCollectionLink'
        sent_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
          description: >-
            When the provider accepted the transfer. Not when it arrived. `null`
            until sent.
    NotIncludedEntry:
      additionalProperties: false
      type: object
      required:
        - link
        - reason
      properties:
        link:
          $ref: '#/components/schemas/AnyLink'
        reason:
          type: string
          enum:
            - no_permission
            - not_published
          description: >-
            Why this link has no entity.


            - `no_permission`: This credential can't read it. Fetching it
            answers 403, or 404 where a 403 would reveal that it exists.

            - `not_published`: The API doesn't show it: a type it doesn't
            publish, or a record it doesn't show on a type it does, such as a
            failed payout. Fetching it, where it has a URI, answers 404.
    Error:
      additionalProperties: false
      type: object
      required:
        - error
      properties:
        error:
          additionalProperties: false
          type: object
          required:
            - code
            - message
            - details
            - retryable
            - request_id
          properties:
            code:
              description: Branch on this. New codes can appear.
              type: string
            message:
              description: For people. It can change.
              type: string
            details:
              type: array
              items:
                $ref: '#/components/schemas/ErrorDetail'
            retryable:
              description: >-
                Whether sending the same request again unchanged, after a wait,
                can succeed with nothing else changing.
              type: boolean
            request_id:
              description: Quote this to support.
              type: string
    MerchantLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: merchant
          type: string
        id:
          type: string
      x-link-target:
        resource: merchant
        kind: resource
        is_published: true
        views:
          - full
    Money:
      description: An amount of money. Decimal values are refused, not rounded.
      additionalProperties: false
      type: object
      required:
        - value
        - currency
      properties:
        value:
          description: In the currency's ISO 4217 minor units, so GBP 45.00 is 4500.
          type: integer
        currency:
          pattern: ^[A-Z]{3}$
          type: string
    Rate:
      pattern: ^\d+(\.\d{1,8})?$
      description: >-
        A fraction as a decimal string, with at most 8 decimal places:
        `"0.0500"` is 5%.
      type: string
    TransactionCollectionLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: collection
          type: string
      x-link-target:
        resource: transaction
        kind: collection
        is_published: true
        views:
          - full
          - summary
    AnyLink:
      anyOf:
        - additionalProperties: false
          type: object
          required:
            - _link
            - _type
            - id
          properties:
            _link:
              pattern: ^/
              type: string
            _type:
              type: string
            id:
              type: string
        - additionalProperties: false
          type: object
          required:
            - _type
            - id
          properties:
            _type:
              type: string
            id:
              type: string
      x-link-target:
        resource: any
        kind: any
        is_published: true
    ErrorDetail:
      anyOf:
        - additionalProperties: false
          type: object
          required:
            - field
            - message
          properties:
            field:
              type: string
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - required_actions
            - message
          properties:
            required_actions:
              description: The `required_actions` codes holding this back.
              type: array
              items:
                type: string
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - available_percent
            - message
          properties:
            available_percent:
              $ref: '#/components/schemas/Percent'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - agreement
            - message
          properties:
            agreement:
              $ref: '#/components/schemas/AgreementLink'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - agreement
            - current_agreement
            - message
          properties:
            agreement:
              $ref: '#/components/schemas/AgreementLink'
            current_agreement:
              $ref: '#/components/schemas/AgreementLink'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - legal_entity
            - message
          properties:
            legal_entity:
              $ref: '#/components/schemas/LegalEntityLink'
            message:
              type: string
    Percent:
      pattern: ^\d+(\.\d+)?$
      description: 'A percentage as a decimal string: `"25.00"` is 25%.'
      type: string
    AgreementLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: agreement
          type: string
        id:
          type: string
      x-link-target:
        resource: agreement
        kind: resource
        is_published: true
        views:
          - full
    LegalEntityLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: legal_entity
          type: string
        id:
          type: string
      x-link-target:
        resource: legal_entity
        kind: resource
        is_published: true
        views:
          - full
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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