Mark transient account as settled

Mark a transient account as settled after processing

Authorization

X-API-Key<token>

In: header

Path Parameters

accountIdstring

Transient account UUID

Formatuuid

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid

Request Body

settledboolean

Whether the account is settled

settlementReference?string | null

Reference for the settlement transaction

settlementAmount?number | null

Amount settled

Formatdecimal

notes?string | null

Additional notes about the settlement

Response Body

curl -X PATCH "https://virtual-accounts-api.vantacrest.com/company/v1/transient-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/settled" \
  -H "X-API-Key: string" \
  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{
    "settled": true
  }'

curl -X PATCH "https://virtual-accounts-api.vantacrest.com/company/v1/transient-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/settled" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "settled": true  }'

{
  "data": {}
}

{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}