Settlement object example
{
    "SettlementId": "int_stlmnt_01975582-2b19-7699-aaf3-a8167936254f",
    "Status": "RECONCILED",
    "CreationDate": 1749486283,
    "SettlementDate": "2025-06-09",
    "ExternalProviderName": "Stripe",
    "DeclaredIntentAmount": 10500,
    "ExternalProcessorFeesAmount": 500,
    "ActualSettlementAmount": 10000,
    "FundsMissingAmount": 0
}

The Settlement object represents the payment of Intents to Mangopay.

Read more about Mangopay Echo →

​
Attributes

​
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