View validation errors for a Settlement

GET

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

GET

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

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

200Retrieved

1 {
2   "FooterErrors": [
3     {
4       "FooterName": "TotalNetSettlementAmount",
5       "Code": "TOTAL_NET_MISCALCULATED",
6       "Description": "Arithmetic check failed. The calculated net amount (149500) does not match the file's stated amount (50000)."
7     },
8     {
9       "FooterName": "TotalSettlementFeesAmount",
10       "Code": "FEES_TOTAL_MISMATCH",
11       "Description": "The footer value (500) does not equal the sum of all ExternalProviderFees found in the transaction lines (450)."
12     }
13   ],
14   "LinesErrors": [
15     {
16       "ExternalProviderReference": "98d7-e5f6-b44c-c3d4",
17       "ExternalTransactionType": "PAYMENT",
18       "Details": [
19         {
20           "Code": "MATCH_REF_NOT_FOUND",
21           "Description": "ExternalProviderReference not found for any existing Intent in the system."
22         }
23       ]
24     },
25     {
26       "ExternalProviderReference": "a2b3-c4d5-e6f7-890a",
27       "ExternalTransactionType": "REFUND",
28       "Details": [
29         {
30           "Code": "INTENT_WRONG_STATUS",
31           "Description": "Intent associated with this transaction is not in a reconcilable state (e.g., AUTHORIZED or CANCELED)."
32         }
33       ]
34     },
35     {
36       "ExternalProviderReference": "f01a-2b3c-4d5e-6f7a",
37       "ExternalTransactionType": "PAYMENT",
38       "Details": [
39         {
40           "Code": "AMOUNT_MISMATCH",
41           "Description": "File Amount (100.00) does not match the Intent's captured amount (95.00)."
42         },
43         {
44           "Code": "FORMAT_DATE_INVALID",
45           "Description": "ExternalProcessingDate format is invalid. Expected DD-MM-YYYY."
46         }
47       ]
48     }
49   ]
50 }

Retrieve information about failed or partially matched settlements.

If your Settlement’s Status is PARTIALLY_MATCHED or FAILED, this endpoint returns information about the errors in your CSV file’s footer or transaction lines.

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.

SettlementIdstringRequired

The unique identifier of the Settlement object.

Query parameters

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

FooterErrorslist of objects

The errors encountered in the CSV footer.

LinesErrorslist of objects

The errors encountered in the CSV's transaction lines.