> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.paywithatoa.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Payout Transactions

> Retrieve payout transactions via the Atoa Payouts API, request parameters, response schema and code samples in cURL, Python, JavaScript, PHP, Go and Java.

This API retrieves a paginated list of transactions associated with a specific payout ID.

### Authorization

Bearer `<token>`

### Path Parameters

<ParamField path="payoutId" type="string" required>
  Unique identifier of the payout. This can be obtained from the [Payouts
  API](/api-reference/Payouts/getPayouts).
</ParamField>

### Query Parameters

<ParamField query="limit" type="integer" optional>
  Maximum number of records to return per page. Default: 10
</ParamField>

<ParamField query="page" type="integer" optional>
  Page number for pagination, starting from 0. Default: 0
</ParamField>

### Response

<ResponseField name="data" type="array">
  List of transaction records

  <Expandable title="Transaction Object">
    <ResponseField name="paymentIdempotencyId" type="string">
      Unique identifier for the payment transaction
    </ResponseField>

    <ResponseField name="paymentRequestId" type="string">
      Unique identifier for the payment request. Only present if the payment was processed through the [Process Payment API](/api-reference/Payment/process-payment).
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      ISO 8601 timestamp of when the transaction was created
    </ResponseField>

    <ResponseField name="amount" type="string">
      Transaction amount with decimal precision
    </ResponseField>

    <ResponseField name="currency" type="string">
      Currency code (e.g., GBP)
    </ResponseField>

    <ResponseField name="refundId" type="string">
      Unique identifier for the refund transaction (null if not a refund). Only present if the transaction was processed through the [Refund API](/api-reference/Refund/initiateRefund).
    </ResponseField>

    <ResponseField name="refundPaymentReference" type="string">
      Reference to the original payment being refunded. Only present if the transaction is a refund (when isRefund=true).
    </ResponseField>

    <ResponseField name="payoutReferenceId" type="string">
      Reference identifier for the associated payout
    </ResponseField>

    <ResponseField name="transactionFinalizedAt" type="string">
      ISO 8601 timestamp of when the transaction was finalized
    </ResponseField>

    <ResponseField name="isRefund" type="boolean">
      Indicates whether the transaction is a refund (true/false)
    </ResponseField>

    <ResponseField name="callbackParams" type="object">
      Optional additional parameters provided in callbacks. Only present if the payment was processed through the [Process Payment API](/api-reference/Payment/process-payment).
    </ResponseField>

    <ResponseField name="notes" type="string">
      Optional notes associated with the transaction. Only present if the payment was processed through the [Process Payment API](/api-reference/Payment/process-payment).
    </ResponseField>

    <ResponseField name="metadata" type="object">
      Only present when metadata was supplied on the payment. See [Process Payment](/api-reference/Payment/process-payment) for the field limits.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="page" type="integer">
  Current page number
</ResponseField>

<ResponseField name="itemPerPage" type="integer">
  Number of items per page
</ResponseField>

<ResponseField name="totalCount" type="integer">
  Total number of records matching the query
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
      "data": [
        {
              "paymentIdempotencyId": "ATOA1745577029069",
              "paymentRequestId": "04869b92-7462-4d89-adbb-c169e735dbaa", // Only present if the payment was processed through the Process-Payment.
              "createdAt": "2025-04-25T10:30:36.655Z",
              "amount": "123.00",
              "currency": "GBP",
              "refundId": null,
              "refundPaymentReference": null,
              "payoutReferenceId": "APY4zt9jjqozv7",
              "transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
              "isRefund": false,
              "callbackParams": { 
                  "test": "67"
              }, // Only present if the payment was processed through the Process-Payment.
              "notes": "Customer payment for order #12345", // Only present if the payment was processed through the Process-Payment.
              "metadata": { // Only present if metadata was supplied when creating the payment.
                  "bookingId": "BK-42427",
                  "orderReference": "ORD-1"
              }
          },
          {
              "paymentIdempotencyId": "ATOA1745734720994",
              "createdAt": "2025-04-27T06:18:48.086Z",
              "amount": "162.06",
              "currency": "GBP",
              "refundId": null,
              "refundPaymentReference": null,
              "payoutReferenceId": "APY4zt9jjqozv7",
              "transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
              "isRefund": false
          },
          {
              "paymentIdempotencyId": "ATOA1745577449258",
              "createdAt": "2025-04-25T10:37:38.988Z",
              "amount": "1000.00",
              "currency": "GBP",
              "refundId": null,
              "refundPaymentReference": null,
              "payoutReferenceId": "APY4zt9jjqozv7",
              "transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
              "isRefund": false
          },
          {
              "paymentIdempotencyId": "ATOA1745557721665",
              "createdAt": "2025-04-25T10:35:08.683Z",
              "amount": "45.76",
              "currency": "GBP",
              "refundId": "5e82db42-bc4a-4098-802d-a7be0c5d50ad",
              "refundPaymentReference": "ATOA1745557721665",
              "payoutReferenceId": "APY4zt9jjqozv7",
              "transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
              "isRefund": true
          }
      ],
      "page": 0,
      "itemPerPage": 4,
      "totalCount": 4
  }
  ```

  ```json 400 theme={null}
  {
    "name": "AJV_VALIDATION_ERROR",
    "message": "Bad request on parameter \"request.path.id\".\nValue must match format \"uuid\". Given value: \"{payoutId}\"",
    "status": 400,
    "errors": [
      {
        "instancePath": "",
        "schemaPath": "#/format",
        "keyword": "format",
        "params": {
          "format": "uuid"
        },
        "message": "must match format \"uuid\"",
        "data": "{payoutId}",
        "dataPath": ""
      }
    ]
  }
  ```

  ```json 401 theme={null}
  {
    "name": "INVALID_CREDENTIAL",
    "message": "Invalid token",
    "status": 401,
    "errors": []
  }
  ```

  ```json 404 theme={null}
  {
    "name": "TRANSACTION_NOT_FOUND",
    "message": "No transactions found for this payout",
    "status": 404,
    "errors": []
  }
  ```

  ```json 500 theme={null}
  {
    "name": "INTERNAL_SERVER_ERROR",
    "message": "Internal Server Error",
    "status": 500,
    "errors": []
  }
  ```
</ResponseExample>