# List residuals

`GET /accounts/{accountID}/residuals`

API version: `v2026.07.00`. Send `X-Moov-Version: v2026.07.00` to get the behavior described here.

> AI agents: search and read all Moov docs with the docs MCP server at https://docs.moov.io/mcp (no API key). Setup: https://docs.moov.io/guides/developer-tools/mcp-ai/docs-mcp/index.md

List all residuals associated with an account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
you'll need to specify the `/accounts/{accountID}/profile.read` scope.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Moov-Version` | header | string |  | Set this header to v2026.07.00 to use the API described in this specification. When omitted, the server defaults to v2024.01.00, the earliest supported version, which may not match the behavior documented here. An unrecognized well-formed version uses the latest supported version that is not newer than the requested version, when one exists. For example, `v2026.08.00` uses `v2026.07.00`. A malformed value, such as `2022`, returns a `404` response. Values: `v2026.07.00`. |
| `skip` | query | integer (int64) |  | The number of entries to skip when paginating a large result set. |
| `count` | query | integer (int64) |  | Page size. When omitted, the server defaults to `200`. |
| `accountID` | path | string | Yes | A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer). |
| `startDateTime` | query | string (RFC-3339) |  | Optional date-time to inclusively filter all residuals with a period start after this date-time. |
| `endDateTime` | query | string (RFC-3339) |  | Optional date-time to exclusively filter all residuals with a period end before this date-time. |

## Response 200

The request completed successfully.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `[].residualID` | string | Yes | Unique identifier for this residual payment calculation. |
| `[].partnerAccountID` | string | Yes | The partner account ID this residual belongs to. |
| `[].periodStart` | string (date-time) | Yes | Start date and time of the residual calculation period. |
| `[].periodEnd` | string (date-time) | Yes | End date and time of the residual calculation period. |
| `[].merchantFees` | object | Yes | Total amount of merchant fees collected during the period. This represents the partner's revenue from merchant fees. |
| `[].merchantFees.currency` | string | Yes | A 3-letter ISO 4217 currency code. |
| `[].merchantFees.valueDecimal` | string | Yes | A decimal-formatted numerical string that represents up to 9 decimal place precision. For example, $12.987654321 is '12.987654321'. |
| `[].partnerCost` | object | Yes | Partner's total cost (buy rate) during the period. |
| `[].partnerCost.currency` | string | Yes | A 3-letter ISO 4217 currency code. |
| `[].partnerCost.valueDecimal` | string | Yes | A decimal-formatted numerical string that represents up to 9 decimal place precision. For example, $12.987654321 is '12.987654321'. |
| `[].netIncome` | object | Yes | Net income calculated as merchant fee revenue minus partner costs. |
| `[].netIncome.currency` | string | Yes | A 3-letter ISO 4217 currency code. |
| `[].netIncome.valueDecimal` | string | Yes | A decimal-formatted numerical string that represents up to 9 decimal place precision. For example, $12.987654321 is '12.987654321'. |
| `[].revenueShare` | string | Yes | The revenue share percentage the partner receives, expressed as a decimal string (e.g., "25.00" for 25%). |
| `[].residualAmount` | object | Yes | The amount the partner receives as their share of the net income (netIncome × revenueShare). |
| `[].residualAmount.currency` | string | Yes | A 3-letter ISO 4217 currency code. |
| `[].residualAmount.valueDecimal` | string | Yes | A decimal-formatted numerical string that represents up to 9 decimal place precision. For example, $12.987654321 is '12.987654321'. |
| `[].createdOn` | string (date-time) | Yes | Timestamp when the residual was created. |
| `[].updatedOn` | string (date-time) | Yes | Timestamp when the residual was last updated. |

## Errors

| Status | Meaning |
| --- | --- |
| 401 | The request contained missing or expired authentication. |
| 403 | The user is not authorized to make the request. |
| 429 | Request was refused due to rate limiting. |
| 500 | The request failed due to an unexpected error. |
| 504 | The request failed because a downstream service failed to respond. |

## Examples

### cURL

```bash
curl -X GET "https://api.moov.io/accounts/{accountID}/residuals" \
  -H "Authorization: Bearer {token}" \
  -H "X-Moov-Version: v2026.07.00"
```

### Typescript (SDK)

```typescript
import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.feePlans.listResiduals({
    skip: 60,
    count: 20,
    accountID: "8b40b967-ae12-4851-8be2-7b0c39978ce7",
  });

  console.log(result);
}

run();
```

Full reference with SDK examples in every language: https://docs.moov.io/api/moov-accounts/partner-billing/list-residuals/