Skip to main content
Cancel an adjudication/settlement prior to funding
curl --request POST \
  --url https://api.sandbox.thrivory.com/v1/settlements/{settlement_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "settlement_id": "<string>",
  "status": "funded",
  "funded_amount": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string

Provide a unique key per request to enable safe retries

Path Parameters

settlement_id
string
required

Response

Settlement canceled

settlement_id
string
required
status
enum<string>
required
Available options:
funded,
failed,
canceled
funded_amount
number
timestamp
string<date-time>