version number that goes up by one each time the resource changes. You use it to update safely.
Why it matters
If two people — or two of your own processes — edit the same party at the same time, the second save could quietly wipe out the first. Theversion field prevents this: an update only succeeds if you’re working from the latest copy.
How to update
1
Read the resource
Fetch it and note the
version (for example, 0).2
Send that version with your change
Include the
version you just read in your PATCH request body.3
Handle a conflict
If someone changed the resource after you read it, the API returns
409. Re-fetch to get the new version, reapply your change, and send it again.version returns:
Always send the
version from your most recent read — never a cached or hard-coded value.API version
The Finance API is at v1.10.0, which adds a party’s KYC status and completion links so you can follow up a verification that is waiting on your end customer. v1.9.0 added pay-out route webhooks, thex-tenant-id and X-Correlation-Id request headers, and your company profile. See the changelog for every release.
Next steps
Update a party
Send the
version with your PATCH request.Safe retries with idempotency keys
The other half of safe writes — duplicate-proof creates.