Idempotency Header

The HTTP Idempotency-Key request header field can be specified in our APIs in any "POST" and "PATCH" endpoints.

Syntax

Add “Idempotency-Key“ header to POST or PATCH request:

Idempotency-Key = <string_value>

The following example shows an idempotency key using "UUID" [RFC4122]:

curl -X 'POST'  
  '<https://api.fortressapi.com/api/trust/v2/payments'>  
  -H 'accept: application/json'  
  -H 'Content-Type: application/json'  
  -H 'Idempotency-Key: 285e197c-b580-45f4-8c5f-7c27ac73e221'  
  -d '{  
  "source": {  
    "custodialAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"  
  },  
  "destination": {  
    "custodialAccountId": "1487ac29-cd90-4abd-a925-b0c1cb183765"  
  },  
  "comment": "",  
  "funds": 100,  
  "useIsa": false  
}'

Restrictions

Uniqueness of Idempotency Key
The idempotency key that is supplied as part of every "POST" endpoint and could be used exclusively for it. But the same idempotency key could be reused on different endpoints while maintaining guarantees within the each one separately.

Idempotency Key Validity and Expiry
The resource may enforce time based idempotency keys, thus, be able to purge or delete a key upon its expiry.

Idempotency Fingerprint
An idempotency fingerprint may be used in conjunction with an idempotency key to determine the uniqueness of a request. Such a fingerprint is generated from request payload data by the resource server.