Skip to main content
POST
/
resale
/
settlements
Settle resale proceeds
curl --request POST \
  --url https://api.nuwebgroup.com/v1/resale/settlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resaleContractIds": [
    1,
    2,
    3
  ],
  "autoPayout": true
}
'
{
  "data": {
    "type": "resaleSettlementResults",
    "attributes": {
      "summary": {
        "totalRequested": 3,
        "totalSucceeded": 2,
        "totalFailed": 1,
        "totalProceedsConfirmed": 9000,
        "totalPayoutsCreated": 9000
      },
      "results": [
        {
          "resaleContractId": 1,
          "success": true,
          "error": null,
          "proceedsConfirmed": 4500,
          "payoutCreated": 4500
        },
        {
          "resaleContractId": 2,
          "success": true,
          "error": null,
          "proceedsConfirmed": 4500,
          "payoutCreated": 4500
        },
        {
          "resaleContractId": 3,
          "success": false,
          "error": "Contract not found or not eligible for settlement",
          "proceedsConfirmed": 0,
          "payoutCreated": 0
        }
      ]
    }
  },
  "meta": {
    "processedAt": "2025-01-15T10:30:00.000000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.nuwebgroup.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Headers

​
X-NU-COMPANY-ID
integer

The ID of the company this operation should be performed against.

​
Accept-Language
string

Sets the preferred language for localised response content (e.g. en, fr, de). If the requested language is not supported by the company, the company fallback language will be assumed.

Body

application/json

Request body for settling resale proceeds.

​
resaleContractIds
integer[]
required

An array of resale contract IDs to settle. Maximum 20 IDs per request.

​
autoPayout
boolean
default:false

If true, automatically create and confirm payout transactions, indicating that proceeds have been settled outside of the platform.

Response

Successfully processed resale settlement request.

​
data
object
​
meta
object