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

# List a payout's transactions

> Lists the transactions one payout is made of, in the order they were added to it: the sale proceeds it released, the refunds and chargebacks it took back, and the commissions carved out of it. Their `amount_minor_units` add up to the payout's `amount_minor_units`. Pages count the payout's items (`transaction_count` on the payout), and one item can read as more than one transaction that must stay together, so a page can hold more rows than `per_page`.

Requires the `payouts` permission at `read`. An API key holds a permission at the lower of its own level (`read` for a read-only key) and its holder's role; a key without it is refused with 403.



## OpenAPI

````yaml /api-reference/commerce-v1.openapi.json get /v1/commerce/payouts/{id}/transactions
openapi: 3.0.3
info:
  description: >-
    Public REST API for COPE vendor integrations. Authenticate with a COPE API
    key and call the endpoints described below.
  title: COPE Public API
  version: v1
servers:
  - description: Production
    url: https://api.cope.com
security:
  - cope_sk: []
paths:
  /v1/commerce/payouts/{id}/transactions:
    get:
      tags:
        - Payouts
      summary: List a payout's transactions
      description: >-
        Lists the transactions one payout is made of, in the order they were
        added to it: the sale proceeds it released, the refunds and chargebacks
        it took back, and the commissions carved out of it. Their
        `amount_minor_units` add up to the payout's `amount_minor_units`. Pages
        count the payout's items (`transaction_count` on the payout), and one
        item can read as more than one transaction that must stay together, so a
        page can hold more rows than `per_page`.


        Requires the `payouts` permission at `read`. An API key holds a
        permission at the lower of its own level (`read` for a read-only key)
        and its holder's role; a key without it is refused with 403.
      operationId: commerce.payouts.transactions.list
      parameters:
        - description: id public identifier.
          example: po_A1b2C3d4E5f6G7h8
          in: path
          name: id
          required: true
          schema:
            example: po_A1b2C3d4E5f6G7h8
            pattern: ^po_[A-Za-z0-9]{8,32}$
            type: string
        - description: >-
            Page number for paginated results. Values below 1 and non-numeric
            values are ignored and the first page is returned; a page past the
            last one returns the last page. `current_page` is accepted as an
            older name for it and wins when both are sent.
          in: query
          name: page
          required: false
          schema:
            minimum: 1
            type: integer
        - description: >-
            Number of records per page. Defaults to 12; values above 25 are
            clamped to 25; values below 1 and non-numeric values are ignored and
            the default is used. `items` and `limit` are accepted as older names
            for it, read only when `per_page` is absent.
          in: query
          name: per_page
          required: false
          schema:
            maximum: 25
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      additionalProperties: false
                      properties:
                        amount_minor_units:
                          description: >-
                            In minor units of `currency`. POSITIVE when it adds
                            to the payout, NEGATIVE when it takes from it.
                          type: integer
                        currency:
                          type: string
                        earnings_type:
                          description: >-
                            Whose earnings the transaction moved:
                            `vendor_earnings` for your own sales,
                            `promoter_earnings` for commissions you earned as a
                            promoter, `jvp_earnings` for joint-venture shares.
                            Null on a commission paid out of your sale.
                          enum:
                            - vendor_earnings
                            - promoter_earnings
                            - jvp_earnings
                          nullable: true
                          type: string
                        object:
                          enum:
                            - payout_transaction
                          type: string
                        order:
                          additionalProperties: false
                          description: The order the transaction belongs to, when known.
                          nullable: true
                          properties:
                            id:
                              example: ord_A1b2C3d4E5f6
                              pattern: ^ord_[A-Za-z0-9]{8,32}$
                              type: string
                            object:
                              enum:
                                - order
                              type: string
                          required:
                            - object
                            - id
                          type: object
                        payment:
                          additionalProperties: false
                          description: >-
                            The payment the transaction belongs to, when known:
                            GET /v1/commerce/payments/{id}.
                          nullable: true
                          properties:
                            id:
                              example: py_A1b2C3d4E5f6
                              pattern: ^py_[A-Za-z0-9]{8,32}$
                              type: string
                            object:
                              enum:
                                - payment
                              type: string
                          required:
                            - object
                            - id
                          type: object
                        product:
                          additionalProperties: false
                          nullable: true
                          properties:
                            id:
                              example: prod_A1b2C3d4
                              pattern: ^prod_[A-Za-z0-9]{8,32}$
                              type: string
                            name:
                              description: >-
                                The product's name as it was when the payout was
                                made.
                              nullable: true
                              type: string
                            object:
                              enum:
                                - product
                              type: string
                          required:
                            - object
                            - id
                            - name
                          type: object
                        type:
                          description: >-
                            What the transaction is. `initial_payout` and
                            `deferred_payout`: the two parts a sale's proceeds
                            are released in. `reserve`: the part of a sale that
                            was held back and is now released. `refund`,
                            `chargeback`, `refund_reversal`,
                            `chargeback_reversal`: a movement taken from or
                            returned to the payout. `affiliate_commission`,
                            `joint_venture_commission`: a commission paid by
                            COPE to a promoter or partner out of your sale.
                            `unclaimed_promoter_commission`: the share of your
                            proceeds you owe a promoter you pay yourself.
                            `adjustment`: any other correction.
                          enum:
                            - reserve
                            - initial_payout
                            - deferred_payout
                            - affiliate_commission
                            - refund
                            - chargeback
                            - refund_reversal
                            - chargeback_reversal
                            - adjustment
                            - joint_venture_commission
                            - unclaimed_promoter_commission
                          type: string
                      required:
                        - object
                        - type
                        - earnings_type
                        - amount_minor_units
                        - currency
                        - order
                        - payment
                        - product
                      type: object
                    type: array
                  pagination:
                    additionalProperties: false
                    properties:
                      current_page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                      total_pages:
                        type: integer
                    required:
                      - total_pages
                      - current_page
                      - per_page
                      - total_count
                    type: object
                required:
                  - data
                  - pagination
                type: object
          description: Successful response
        '400':
          content:
            application/problem+json:
              examples:
                unparsable_request:
                  summary: Unparsable request
                  value:
                    code: invalid_request
                    detail: >-
                      The request could not be parsed. Check the query string
                      and the request body.
                    request_id: 0b6e3f2a-8c4d-4f1e-9a7b-5d2c8e1f4a90
                    status: 400
                    title: Invalid Request
                    type: https://docs.cope.com/errors/invalid_request
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Invalid request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Missing or invalid bearer token
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Bearer token is not authorized for this route
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Resource not found
        '503':
          content:
            application/problem+json:
              examples:
                user_not_ready:
                  summary: The key's user is not available yet
                  value:
                    code: user_not_ready
                    detail: Retry after 2 seconds
                    errors:
                      - code: user_not_ready
                        detail: Retry after 2 seconds
                    request_id: 0b6e3f2a-8c4d-4f1e-9a7b-5d2c8e1f4a90
                    status: 503
                    title: User Not Ready
                    type: https://docs.cope.com/errors/user_not_ready
                tenant_not_ready:
                  summary: The key's business is not available yet
                  value:
                    code: tenant_not_ready
                    detail: Retry after 2 seconds
                    errors:
                      - code: tenant_not_ready
                        detail: Retry after 2 seconds
                    request_id: 0b6e3f2a-8c4d-4f1e-9a7b-5d2c8e1f4a90
                    status: 503
                    title: Tenant Not Ready
                    type: https://docs.cope.com/errors/tenant_not_ready
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: >-
            The API key is valid but its user or business is not available to
            this API yet (`user_not_ready`, `tenant_not_ready`). Retry after the
            `Retry-After` seconds.
      security:
        - cope_sk: []
components:
  schemas:
    PublicProblemDetail:
      additionalProperties: false
      properties:
        code:
          type: string
        detail:
          nullable: true
          type: string
        errors:
          items:
            additionalProperties: false
            properties:
              code:
                type: string
              detail:
                type: string
              param:
                type: string
            required:
              - code
              - detail
            type: object
          type: array
        request_id:
          description: >-
            Correlates this response with COPE's logs; the response also carries
            it as `X-Request-Id`. It is the `X-Request-Id` you sent when that is
            1-128 letters, digits, `_`, `@` or `-`, and otherwise one COPE
            generated. Quote it when you contact support.
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      required:
        - type
        - title
        - status
        - code
        - request_id
      type: object
  securitySchemes:
    cope_sk:
      description: >-
        Bearer credential for the public API: a live COPE API key (`ck_live_*`;
        keys issued earlier as `cope_sk_live_*` keep working). Dashboard sign-in
        tokens are not accepted.
      scheme: bearer
      type: http

````

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