Skip to main content
PUT
/
v3.0
/
{ClientId}
/
payins
/
intents
/
settlements
/
{SettlementId}
curl -X PUT ".../v3.0/{ClientId}/payins/intents/settlements/{SettlementId}"" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "file=@/example/file-path.csv"

{
    "SettlementId": "int_stlmnt_019778c1-fe45-7864-8d2c-c2394e0f105c",
    "Status": "UPLOADED",
    "CreationDate": 1750077669,
    "DeclaredIntentAmount": 0,
    "ExternalProcessorFeesAmount": 0,
    "ActualSettlementAmount": 0,
    "FundsMissingAmount": 0
}

​
Path parameters

​
SettlementId
string
required
The unique identifier of the Settlement object.

​
Body parameters

​
file
csv
required
The settlement file, provided by the external PSP and formatted to comply with Mangopay’s settlement file structure.

​
Responses

200 - OK

​
SettlementId
string
The unique identifier of the Settlement.
​
Status
string
The status of the Settlement:
  • UPLOADED – Settlement file received.
  • CREATED – Settlement file parsed but reconciliation not possible for any lines.
  • UNMATCHED – Settlement file parsed and reconciliation in progress.
  • PARTIALLY_MATCHED – Settlement file parsed and some lines matched successfully.
  • PENDING_FUNDS_RECEPTION – Settlement file parsed and fully matched with Intents; waiting for funds to arrive on the escrow wallet.
  • INSUFFICIENT_FUNDS – Partial amount received: FundsMissingAmount shows the shortfall.
  • RECONCILED – Full settlement amount (ActualSettlementAmount) received on the escrow wallet.
  • FAILED – Settlement file rejected due to a technical error (e.g. format, timeout).
​
CreationDate
Unix timestamp
The date and time the Settlement was created.
​
DeclaredIntentAmount
integer
The total amount declared through Intent API calls, using the following calculation: (Sum of captured intents) - (Sum of refunded amounts) + (Sum of refund reversed amounts) - (Sum of DISPUTED disputes) + (Sum of DISPUTED_WON disputes)
​
ExternalProcessorFeesAmount
integer
The total fees charged by the external provider
​
ActualSettlementAmount
integer
The total amount due to the platform, to be held in the escrow wallet. This amount corresponds to the TotalSettlementAmount of the settlement file.A negative amount results in this parameter being set to zero, indicating no incoming funds to the escrow wallet.
​
FundsMissingAmount
integer
The difference between ActualSettlementAmount and the amount received on the escrow wallet
curl -X PUT ".../v3.0/{ClientId}/payins/intents/settlements/{SettlementId}"" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "file=@/example/file-path.csv"

{
    "SettlementId": "int_stlmnt_019778c1-fe45-7864-8d2c-c2394e0f105c",
    "Status": "UPLOADED",
    "CreationDate": 1750077669,
    "DeclaredIntentAmount": 0,
    "ExternalProcessorFeesAmount": 0,
    "ActualSettlementAmount": 0,
    "FundsMissingAmount": 0
}
⌘I