From 5bf5cc3897624efec3202606a4b251c12ad758eb Mon Sep 17 00:00:00 2001 From: Laurence McKnight <laurence.mcknight@centrapay.com> Date: Thu, 16 Jan 2025 16:01:56 +1300 Subject: [PATCH] Document behaviour on idempotencyKey reuse --- src/content/api/idempotency.mdoc | 1 + 1 file changed, 1 insertion(+) diff --git a/src/content/api/idempotency.mdoc b/src/content/api/idempotency.mdoc index 3b7305a69..c2d87d119 100644 --- a/src/content/api/idempotency.mdoc +++ b/src/content/api/idempotency.mdoc @@ -7,3 +7,4 @@ nav: --- Several key APIs support Idempotency. Idempotency allows requests to be safely retried without risk of performing the operation twice. When calling an API, provide an idempotency key. Then, if a connection error occurs, you can safely repeat the request using the same key without risk of the operation being performed twice. +The result of successful requests to our APIs will be saved alongside their idempotency key. Subsequent requests with the same key return the same result.