Skip to main content
POST
Error
Group two or more existing PENDING or UNDER_REVIEW settlements into a single batch. The source settlements become children of the new batch and continue through their individual lifecycles under one approval.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
settlementIds
string[]
required

IDs of existing settlements to merge

​
batchReference
string
​
callbackUrl
string
​
integratorNote
string

Response

201