Skip to content

Commit e84817d

Browse files
authored
feat: adding idempotency to transfers (#138)
### TL;DR Added Idempotency-Key header support to transfer endpoints. ### What changed? - Added an optional `Idempotency-Key` header parameter to the transfer-in and transfer-out API endpoints - The header allows clients to safely retry requests without risking duplicate transfers - Included documentation explaining that if the same key is sent multiple times, the server will return the same response as the first request - Added an example UUID format for the header value: `550e8400-e29b-41d4-a716-446655440000`
1 parent defc948 commit e84817d

4 files changed

Lines changed: 56 additions & 0 deletions

File tree

mintlify/openapi.yaml

Lines changed: 18 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi.yaml

Lines changed: 18 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/paths/transfers/transfer_in.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ post:
99
- Same-Currency Transfers
1010
security:
1111
- BasicAuth: []
12+
parameters:
13+
- name: Idempotency-Key
14+
in: header
15+
required: false
16+
description: >
17+
A unique identifier for the request. If the same key is sent multiple times,
18+
the server will return the same response as the first request.
19+
schema:
20+
type: string
21+
example: 550e8400-e29b-41d4-a716-446655440000
1222
requestBody:
1323
required: true
1424
content:

openapi/paths/transfers/transfer_out.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ post:
77
- Same-Currency Transfers
88
security:
99
- BasicAuth: []
10+
parameters:
11+
- name: Idempotency-Key
12+
in: header
13+
required: false
14+
description: >
15+
A unique identifier for the request. If the same key is sent multiple times,
16+
the server will return the same response as the first request.
17+
schema:
18+
type: string
19+
example: 550e8400-e29b-41d4-a716-446655440000
1020
requestBody:
1121
required: true
1222
content:

0 commit comments

Comments
 (0)