Skip to content

Get a settlement allocation

Request

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

Security
ClientCredentialsToken
Path
allocationIdstring^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...required

Unique identifier of the settlement allocation.

Example:f47ac10b-58cc-4372-a567-0e02b2c3d479
Query
includePaymentIntentsboolean

Whether to include payment intents in the response.

Example:includePaymentIntents=true
pageTokenstring

Token for fetching the next page of results.

Example:pageToken=abc123
pageSizeinteger, (int32), <= 50

Number of items per page.

Example:pageSize=20
Headers
X-External-Correlation-Idstring, (uuid), <= 36 characters

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Example:f47ac10b-58cc-4372-a567-0e02b2c3d479
curl -i -X GET \
  'https://api.wise.com/2026Q4/settlement/allocations/f47ac10b-58cc-4372-a567-0e02b2c3d479?includePaymentIntents=true&pageToken=abc123&pageSize=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-External-Correlation-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479'

Responses

Settlement allocation details retrieved successfully.

Headers
X-External-Correlation-Idstring, (uuid), <= 36 characters

Echoed back when X-External-Correlation-Id was included in the request. Learn more.

Example:"f47ac10b-58cc-4372-a567-0e02b2c3d479"
x-trace-idstring

Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.

Example:"fba501b6d453b96789f52338f019341f"
Bodyapplication/json
idstring

Unique identifier of the settlement allocation.

Example:"f47ac10b-58cc-4372-a567-0e02b2c3d479"
expectedTotalAmountnumber, (decimal), > 0

Expected total amount for the allocation.

Example:1000.5
currencystring, = 3 characters^[A-Z]{3}$

Currency code for the allocation (ISO 4217).

Example:"EUR"
statestring

Current state of the settlement allocation.

Enum:"NEW""MATCHING_FUNDS""MATCHED""MISMATCHED""PARTIALLY_COMPLETED""COMPLETED""CANCELLED"
paymentReferencestring

Unique payment reference for the settlement allocation.

Example:"PAY-123456"
createdAtstring, (date-time)

Timestamp when the settlement allocation was created.

Example:"2026-07-10T10:30:16.000Z"
updatedAtstring, (date-time)

Timestamp when the settlement allocation was last updated.

Example:"2026-07-10T11:00:41.000Z"
paymentIntentsArray of objects

List of payment intents associated with the allocation. Only included when includePaymentIntents is true.

nextPageTokenstring

Token for fetching the next page of payment intents. Null if no more pages.

Example:"def456"
Response
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "expectedTotalAmount": 1000.5,
  "currency": "EUR",
  "state": "MATCHED",
  "paymentReference": "PAY-123456",
  "createdAt": "2026-07-10T10:30:16.000Z",
  "updatedAt": "2026-07-10T11:00:41.000Z",
  "paymentIntents": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "allocationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "partnerEntityId": "PARTNER-001",
      "profileId": "12345678",
      "recipientType": "SELLER",
      "sourceAmount": 100,
      "sourceCurrency": "EUR",
      "targetAmount": 85,
      "targetCurrency": "GBP",
      "allocationType": "CREDIT",
      "paymentReference": "REF-001",
      "reason": "Invoice payment",
      "state": "NEW",
      "fundingSource": "WISE_COLLECTION_ACCOUNT",
      "createdAt": "2026-07-10T10:35:41.147522",
      "updatedAt": "2026-07-10T10:45:41.147522"
    }
  ],
  "nextPageToken": "def456"
}