List all Settlements

GET

/v3.0/:ClientId/payins/intents/settlements

GET

/v3.0/:ClientId/payins/intents/settlements

$ curl https://api.sandbox.mangopay.com/v3.0/{ClientId}/payins/intents/settlements \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 [
2   {
3     "SettlementId": "int_stlmnt_019b2756-c2f8-78a6-9a8f-1a0d354cef20",
4     "Status": "RECONCILED",
5     "CreationDate": 1765891663,
6     "SettlementDate": 1750291200,
7     "ExternalProviderName": "Stripe",
8     "DeclaredIntentAmount": 50000,
9     "ExternalProcessorFeesAmount": 500,
10     "ActualSettlementAmount": 49500,
11     "FundsMissingAmount": 0,
12     "FileName": "Example_File_Name_2025-12-16T13-25.csv"
13   },
14   {
15     "SettlementId": "int_stlmnt_019b27af-db89-7114-9fe9-3c625519e1cb",
16     "Status": "PENDING_FUNDS_RECEPTION",
17     "CreationDate": 1765897395,
18     "SettlementDate": 1750377600,
19     "ExternalProviderName": "Stripe",
20     "DeclaredIntentAmount": 75000,
21     "ExternalProcessorFeesAmount": 750,
22     "ActualSettlementAmount": 74250,
23     "FundsMissingAmount": 74250,
24     "FileName": "Example_File_Name_2025-12-16T15-03.csv"
25   }
26 ]

Retrieve a paginated list of settlements, with optional filters for provider, currency, date range, and status.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Query parameters

BeforeDateintegerOptional

The date before which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDateintegerOptional

The date after which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

StatusstringOptional

Allowed values: PENDING_UPLOAD, UPLOADED, CREATED, FAILED, UNMATCHED, PARTIALLY_MATCHED, PENDING_FUNDS_RECEPTION, RECONCILED, INSUFFICIENT_FUNDS, CANCELLED

The status of the Settlement. You can filter on multiple values by separating them with a comma.

**Allowed values:** `PENDING_UPLOAD`, `UPLOADED`, `CREATED`, `FAILED`, `UNMATCHED`, `PARTIALLY_MATCHED`, `PENDING_FUNDS_RECEPTION`, `RECONCILED`, `INSUFFICIENT_FUNDS`, `CANCELLED` The status of the Settlement. You can filter on multiple values by separating them with a comma.

ExternalProviderNamestringOptional

The third-party PSP name to filter by.

CurrencystringOptional

The three-letter ISO 4217 code of the currency to filter by.

pageintegerOptional

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageintegerOptional

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

Response

Success