# Get a settlement allocation

Retrieves the details of a settlement allocation by its ID.
  Optionally includes paginated payment intents associated with the allocation.

Endpoint: GET /settlement/allocations/{allocationId}
Version: 2026Q4
Security: ClientCredentialsToken

## Security:

  - `ClientCredentialsToken` (unknown)
    http bearer JWT

## Path parameters:

  - `allocationId` (string, required)
    Unique identifier of the settlement allocation.

## Query parameters:

  - `includePaymentIntents` (boolean)
    Whether to include payment intents in the response.

  - `pageToken` (string)
    Token for fetching the next page of results.

  - `pageSize` (integer)
    Number of items per page.

## Header parameters:

  - `X-External-Correlation-Id` (string)
    Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. [Learn more](/guides/developer/headers/correlation-id).

## Response 200:

  - `200` (unknown)
    Settlement allocation details retrieved successfully.

## Response 200 fields (application/json):

  - `id` (string)
    Unique identifier of the settlement allocation.
    Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

  - `expectedTotalAmount` (number)
    Expected total amount for the allocation.
    Example: 1000.5

  - `currency` (string)
    Currency code for the allocation (ISO 4217).
    Example: EUR

  - `state` (string)
    State of a funding allocation.
    Enum: "NEW", "MATCHING_FUNDS", "MATCHED", "MISMATCHED", "PARTIALLY_COMPLETED", "COMPLETED", "CANCELLED"

  - `paymentReference` (string)
    Unique payment reference for the settlement allocation.
    Example: PAY-123456

  - `createdAt` (string)
    Timestamp when the settlement allocation was created.
    Example: 2026-07-10T10:30:16.000Z

  - `updatedAt` (string)
    Timestamp when the settlement allocation was last updated.
    Example: 2026-07-10T11:00:41.000Z

  - `paymentIntents` (array)
    List of payment intents associated with the allocation. Only included when includePaymentIntents is true.

  - `paymentIntents.id` (string)
    Unique identifier of the payment intent in the UUID format.
    Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

  - `paymentIntents.allocationId` (string)
    Unique identifier of the associated settlement allocation in the UUID format.
    Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

  - `paymentIntents.partnerEntityId` (string)
    Partner entity identifier.
    Example: PARTNER-001

  - `paymentIntents.profileId` (string)
    Profile identifier.
    Example: 12345678

  - `paymentIntents.recipientType` (string)
    Type of recipient for a payment intent.
    Enum: "SELLER", "PARTNER_FEE"

  - `paymentIntents.sourceAmount` (number)
    Source amount of the payment.
    Example: 100

  - `paymentIntents.sourceCurrency` (string)
    Source currency code (ISO 4217).
    Example: EUR

  - `paymentIntents.targetAmount` (number)
    Target amount of the payment.
    Example: 85

  - `paymentIntents.targetCurrency` (string)
    Target currency code (ISO 4217).
    Example: GBP

  - `paymentIntents.allocationType` (string)
    Type of allocation for a payment intent.
    Enum: "CREDIT", "DEBIT"

  - `paymentIntents.paymentReference` (string)
    Payment reference.
    Example: REF-001

  - `paymentIntents.reason` (string)
    Reason for the payment.
    Example: Invoice payment

  - `paymentIntents.state` (string)
    State of a payment intent.
    Enum: "NEW", "PARTIALLY_LEDGERED", "LEDGERED", "PARTIALLY_SETTLED", "SETTLED", "CANCELLED"

  - `paymentIntents.fundingSource` (string)
    Source of funding for a payment intent.
    Enum: "WISE_COLLECTION_ACCOUNT", "PARTNER_DEFICIT_ACCOUNT", "SPLIT", "UNDETERMINED"

  - `paymentIntents.createdAt` (string)
    Timestamp when the payment intent was created.
    Example: 2026-07-10T10:35:16.000Z

  - `paymentIntents.updatedAt` (string)
    Timestamp when the payment intent was last updated.
    Example: 2026-07-10T10:45:41.000Z

  - `nextPageToken` (string)
    Token for fetching the next page of payment intents. Null if no more pages.
    Example: def456

## Response 200 headers (application/json):

  - `X-External-Correlation-Id` (string)
    Echoed back when `X-External-Correlation-Id` was included in the request. [Learn more](/guides/developer/headers/correlation-id).
    Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

  - `x-trace-id` (string)
    Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.
    Example: fba501b6d453b96789f52338f019341f

## Response 429:

  - `429` (unknown)
    Rate limit exceeded. Retry after the number of seconds specified in the `Retry-After` header.

## Response 429 headers (application/json):

  - `Retry-After` (integer)
    Number of seconds to wait before retrying the request.
    Example: 5

  - `X-Rate-Limited-By` (string)
    Identifies the rate limiter that triggered the 429 response.
    Example: wise-public-api

  - `X-External-Correlation-Id` (string)
    Echoed back when `X-External-Correlation-Id` was included in the request. [Learn more](/guides/developer/headers/correlation-id).
    Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

  - `x-trace-id` (string)
    Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.
    Example: fba501b6d453b96789f52338f019341f

## Response 200 examples:

  - `Settlement allocation details with payment intents` (unknown)

  - `Settlement allocation details without payment intents` (unknown)