Skip to main content
GET
/
v3.0
/
{ClientId}
/
payins
/
intents
/
settlements
/
{settlementId}
// GET has no body parameters

{
    "SettlementId": "int_stlmnt_019b27af-db89-7114-9fe9-3c625519e1cb",
    "Status": "PENDING_UPLOAD",
    "CreationDate": 1765897395,
    "DeclaredIntentAmount": 0,
    "FundsMissingAmount": 0,
    "FileName": "Example_File_Name_2025-12-16T15-03-15.csv"
}

​
Path parameters

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

​
Responses

200 - OK

​
SettlementId
string
The unique identifier of the Settlement.
​
Status
string
The status of the Settlement:
  • PENDING_UPLOAD – Settlement object and UploadUrl generated.
  • UPLOADED – Settlement file uploaded and received.
  • CREATED – Valid settlement file received, reconciliation in progress. A file is considered valid when it includes all required columns and a properly formatted footer.
  • UNMATCHED – None of the entries in the settlement file match the declared intents.
  • 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).
  • CANCELLED – Settlement file rejected due to a reconciliation error.
If status becomes FAILED or CANCELLED, then call POST Create a Settlement and secure URL for file upload to create a new object. If the status becomes UNMATCHED or remains in PARTIALLY_MATCHED unexpectedly, then call PUT Update a Settlement and generate a new upload URL only a new URL is required for the existing SettlementId.
​
CreationDate
Unix timestamp
The date and time the Settlement was created.
​
SettlementDate
Unix timestamp
The creation date of the settlement from the provider.
​
ExternalProviderName
string
The supported third-party PSP processing the transaction.Note: The uppercase value is expected. The API returns the sentence-case value.
​
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 TotalNetSettlementAmount 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
​
FileName
string
The FileName submitted to the POST Create a Settlement and generate upload URL endpoint, with a timestamp of the Settlement creation date automatically appended by Mangopay.
{
    "SettlementId": "int_stlmnt_019b27af-db89-7114-9fe9-3c625519e1cb",
    "Status": "PENDING_UPLOAD",
    "CreationDate": 1765897395,
    "DeclaredIntentAmount": 0,
    "FundsMissingAmount": 0,
    "FileName": "Example_File_Name_2025-12-16T15-03-15.csv"
}

// GET has no body parameters