@settlemint/dalp-cli 3.1.32-main.42815734828 → 3.1.32-main.42853725435

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4257,9 +4257,9 @@
4257
4257
  "fields": []
4258
4258
  }
4259
4259
  ],
4260
- "requestBodyDescription": null,
4260
+ "requestBodyDescription": "A request to cancel every open order of the participant named in the path, on one market or on the whole venue. It is a venue mass-cancel proposal filtered to that participant's wallet, so it waits for a second approver while the venue's maker-checker is on.",
4261
4261
  "hasRequestBody": true,
4262
- "bodyIsComplex": true,
4262
+ "bodyIsComplex": false,
4263
4263
  "bodyFields": [
4264
4264
  {
4265
4265
  "name": "reason",
@@ -4271,6 +4271,17 @@
4271
4271
  "pattern": null,
4272
4272
  "examples": [],
4273
4273
  "fields": []
4274
+ },
4275
+ {
4276
+ "name": "marketId",
4277
+ "in": "query",
4278
+ "required": false,
4279
+ "description": "Trading Venue market identifier",
4280
+ "type": "string",
4281
+ "enum": null,
4282
+ "pattern": null,
4283
+ "examples": [],
4284
+ "fields": []
4274
4285
  }
4275
4286
  ],
4276
4287
  "examples": [
@@ -14949,43 +14960,128 @@
14949
14960
  }
14950
14961
  ]
14951
14962
  },
14952
- "custodyOps/depositInstructionsList": {
14953
- "name": "custodyOps/depositInstructionsList",
14954
- "method": "GET",
14955
- "url": "/api/v2/custody-ops/deposit-instructions",
14956
- "summary": "List your deposit funding instructions",
14957
- "description": "Returns where the acting participant sends funds: one entry for each active custody wallet and each deposit token the operator accepts, with the network, the wallet address that receives the transfer, and the token to send. Only tokens that belong to the active organization are listed: its own tokens the operator accepts, and the external tokens it registered by hand and has not dismissed. The list is empty until the operator accepts a token or the organization registers an external token by hand. Each wallet address is the participant's own, so the address identifies the deposit and no separate reference is needed. An entry is listed only once its deposit watch runs: call `POST /api/v2/custody-ops/deposit-watches` first, so no address is answered before transfers to it are watched.",
14958
- "help": "Returns where the acting participant sends funds: one entry for each active custody wallet and each deposit token the operator accepts, with the network, the wallet address that receives the transfer, and the token to send. Only tokens that belong to the active organization are listed: its own tokens the operator accepts, and the external tokens it registered by hand and has not dismissed. The list is empty until the operator accepts a token or the organization registers an external token by hand. Each wallet address is the participant's own, so the address identifies the deposit and no separate reference is needed. An entry is listed only once its deposit watch runs: call `POST /api/v2/custody-ops/deposit-watches` first, so no address is answered before transfers to it are watched.",
14963
+ "custodyOps/gatewayAutoClaimPatch": {
14964
+ "name": "custodyOps/gatewayAutoClaimPatch",
14965
+ "method": "PATCH",
14966
+ "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/auto-claim",
14967
+ "summary": "Set whether fulfilled requests are paid without a claim",
14968
+ "description": "Queues the gateway's auto-claim switch, signed by the wallet you act with.",
14969
+ "help": "Queues the gateway's auto-claim switch, signed by the wallet you act with.",
14959
14970
  "tags": [
14960
14971
  "Custody operations"
14961
14972
  ],
14962
- "pathParams": [],
14973
+ "pathParams": [
14974
+ {
14975
+ "name": "gatewayAddress",
14976
+ "in": "path",
14977
+ "required": true,
14978
+ "description": "A valid Ethereum address (42 characters, starting with 0x)",
14979
+ "type": "string",
14980
+ "enum": null,
14981
+ "pattern": "^0x[a-fA-F0-9]{40}$",
14982
+ "examples": [
14983
+ "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
14984
+ ],
14985
+ "fields": []
14986
+ }
14987
+ ],
14963
14988
  "queryParams": [],
14964
- "headerParams": [],
14989
+ "headerParams": [
14990
+ {
14991
+ "name": "Idempotency-Key",
14992
+ "in": "header",
14993
+ "required": false,
14994
+ "description": "Caller-generated key that makes a repeated request resolve to the first attempt instead of starting a second one.",
14995
+ "type": "string",
14996
+ "enum": null,
14997
+ "pattern": null,
14998
+ "examples": [
14999
+ "3f1c9a26-4c1e-4a53-9c6a-9c9d3e1b7a11"
15000
+ ],
15001
+ "fields": []
15002
+ },
15003
+ {
15004
+ "name": "Prefer",
15005
+ "in": "header",
15006
+ "required": false,
15007
+ "description": "RFC 7240 preference; separate directives with commas. Absent or `respond-async` answers 202 Accepted at once with the queued transaction's status URL. `wait` waits for settlement up to 99 seconds; `wait=N` waits up to N seconds, clamped to 5 through 99. Every wait also ends before the request deadline. A write that settles in time answers with its settled result; one that has not answers the same 202 as async. `Preference-Applied` echoes the directives honoured. Poll `Location` after 202 instead of resubmitting.",
15008
+ "type": "string",
15009
+ "enum": null,
15010
+ "pattern": null,
15011
+ "examples": [],
15012
+ "fields": []
15013
+ }
15014
+ ],
14965
15015
  "requestBodyDescription": null,
14966
- "hasRequestBody": false,
14967
- "bodyIsComplex": false,
14968
- "bodyFields": [],
14969
- "examples": []
15016
+ "hasRequestBody": true,
15017
+ "bodyIsComplex": true,
15018
+ "bodyFields": [
15019
+ {
15020
+ "name": "enabled",
15021
+ "in": "query",
15022
+ "required": true,
15023
+ "description": "Whether a fulfilled request is paid out without a claim.",
15024
+ "type": "boolean",
15025
+ "enum": null,
15026
+ "pattern": null,
15027
+ "examples": [],
15028
+ "fields": []
15029
+ }
15030
+ ],
15031
+ "examples": [
15032
+ {
15033
+ "description": "Queues the gateway's auto-claim switch, signed by the wallet you act with.",
15034
+ "path": {
15035
+ "gatewayAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15036
+ }
15037
+ }
15038
+ ]
14970
15039
  },
14971
- "custodyOps/depositWatchesStart": {
14972
- "name": "custodyOps/depositWatchesStart",
14973
- "method": "POST",
14974
- "url": "/api/v2/custody-ops/deposit-watches",
14975
- "summary": "Start watching your deposit addresses",
14976
- "description": "Starts the deposit watch for every active custody wallet and each deposit token the acting participant can be funded with, the same wallets and tokens the deposit instructions list once watched. The request has no body: the platform derives every target from the acting participant. Calling it again returns the same targets and starts nothing new. The call is refused with a conflict when a target address and token are already watched for a different wallet, owner or reset epoch. A target is watching, with its address and asset key, once its detector runs. A target on a wallet whose transfers the indexer does not record yet is answered preparing, with no address, and no detector starts for it; call the route again to start it. An empty list means the organization accepts no deposit token yet.",
14977
- "help": "Starts the deposit watch for every active custody wallet and each deposit token the acting participant can be funded with, the same wallets and tokens the deposit instructions list once watched. The request has no body: the platform derives every target from the acting participant. Calling it again returns the same targets and starts nothing new. The call is refused with a conflict when a target address and token are already watched for a different wallet, owner or reset epoch. A target is watching, with its address and asset key, once its detector runs. A target on a wallet whose transfers the indexer does not record yet is answered preparing, with no address, and no detector starts for it; call the route again to start it. An empty list means the organization accepts no deposit token yet.",
15040
+ "custodyOps/gatewayDefaultPayoutPatch": {
15041
+ "name": "custodyOps/gatewayDefaultPayoutPatch",
15042
+ "method": "PATCH",
15043
+ "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/default-payout",
15044
+ "summary": "Set the default payout address",
15045
+ "description": "Queues the address receipts sent by plain transfer are paid to. An address that is not on the gateway's approved list answers 422.",
15046
+ "help": "Queues the address receipts sent by plain transfer are paid to. An address that is not on the gateway's approved list answers 422.",
14978
15047
  "tags": [
14979
15048
  "Custody operations"
14980
15049
  ],
14981
- "pathParams": [],
15050
+ "pathParams": [
15051
+ {
15052
+ "name": "gatewayAddress",
15053
+ "in": "path",
15054
+ "required": true,
15055
+ "description": "A valid Ethereum address (42 characters, starting with 0x)",
15056
+ "type": "string",
15057
+ "enum": null,
15058
+ "pattern": "^0x[a-fA-F0-9]{40}$",
15059
+ "examples": [
15060
+ "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15061
+ ],
15062
+ "fields": []
15063
+ }
15064
+ ],
14982
15065
  "queryParams": [],
14983
15066
  "headerParams": [
14984
15067
  {
14985
15068
  "name": "Idempotency-Key",
14986
15069
  "in": "header",
14987
15070
  "required": false,
14988
- "description": "Retry key for one mutation. Reuse it only for the same method, path, and body on a route that documents replay safety. If omitted, the platform generates a UUIDv7 key; replay-safe writes echo it in the `Idempotency-Key` response header. A lost response still requires status reconciliation.",
15071
+ "description": "Caller-generated key that makes a repeated request resolve to the first attempt instead of starting a second one.",
15072
+ "type": "string",
15073
+ "enum": null,
15074
+ "pattern": null,
15075
+ "examples": [
15076
+ "3f1c9a26-4c1e-4a53-9c6a-9c9d3e1b7a11"
15077
+ ],
15078
+ "fields": []
15079
+ },
15080
+ {
15081
+ "name": "Prefer",
15082
+ "in": "header",
15083
+ "required": false,
15084
+ "description": "RFC 7240 preference; separate directives with commas. Absent or `respond-async` answers 202 Accepted at once with the queued transaction's status URL. `wait` waits for settlement up to 99 seconds; `wait=N` waits up to N seconds, clamped to 5 through 99. Every wait also ends before the request deadline. A write that settles in time answers with its settled result; one that has not answers the same 202 as async. `Preference-Applied` echoes the directives honoured. Poll `Location` after 202 instead of resubmitting.",
14989
15085
  "type": "string",
14990
15086
  "enum": null,
14991
15087
  "pattern": null,
@@ -14994,18 +15090,37 @@
14994
15090
  }
14995
15091
  ],
14996
15092
  "requestBodyDescription": null,
14997
- "hasRequestBody": false,
14998
- "bodyIsComplex": false,
14999
- "bodyFields": [],
15000
- "examples": []
15093
+ "hasRequestBody": true,
15094
+ "bodyIsComplex": true,
15095
+ "bodyFields": [
15096
+ {
15097
+ "name": "payout",
15098
+ "in": "query",
15099
+ "required": true,
15100
+ "description": null,
15101
+ "type": "string",
15102
+ "enum": null,
15103
+ "pattern": null,
15104
+ "examples": [],
15105
+ "fields": []
15106
+ }
15107
+ ],
15108
+ "examples": [
15109
+ {
15110
+ "description": "Queues the address receipts sent by plain transfer are paid to. An address that is not on the gateway's approved list answers 422.",
15111
+ "path": {
15112
+ "gatewayAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15113
+ }
15114
+ }
15115
+ ]
15001
15116
  },
15002
- "custodyOps/gatewayAutoClaimPatch": {
15003
- "name": "custodyOps/gatewayAutoClaimPatch",
15004
- "method": "PATCH",
15005
- "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/auto-claim",
15006
- "summary": "Set whether fulfilled requests are paid without a claim",
15007
- "description": "Queues the gateway's auto-claim switch, signed by the wallet you act with.",
15008
- "help": "Queues the gateway's auto-claim switch, signed by the wallet you act with.",
15117
+ "custodyOps/gatewayDepositCreate": {
15118
+ "name": "custodyOps/gatewayDepositCreate",
15119
+ "method": "POST",
15120
+ "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/deposits",
15121
+ "summary": "Deposit a coin into a gateway",
15122
+ "description": "Queues the deposit from the wallet you act with, preceded by an approval for the exact amount when the allowance is short. Answers 200 when settled within the preference window, otherwise 202 with the transaction to poll.",
15123
+ "help": "Queues the deposit from the wallet you act with, preceded by an approval for the exact amount when the allowance is short. Answers 200 when settled within the preference window, otherwise 202 with the transaction to poll.",
15009
15124
  "tags": [
15010
15125
  "Custody operations"
15011
15126
  ],
@@ -15056,33 +15171,44 @@
15056
15171
  "bodyIsComplex": true,
15057
15172
  "bodyFields": [
15058
15173
  {
15059
- "name": "enabled",
15174
+ "name": "token",
15060
15175
  "in": "query",
15061
15176
  "required": true,
15062
- "description": "Whether a fulfilled request is paid out without a claim.",
15063
- "type": "boolean",
15177
+ "description": null,
15178
+ "type": "string",
15064
15179
  "enum": null,
15065
15180
  "pattern": null,
15066
15181
  "examples": [],
15067
15182
  "fields": []
15183
+ },
15184
+ {
15185
+ "name": "amount",
15186
+ "in": "query",
15187
+ "required": true,
15188
+ "description": "Amount in base units. Queues an approval first when the allowance is short.",
15189
+ "type": "string",
15190
+ "enum": null,
15191
+ "pattern": "^[1-9][0-9]{0,77}$",
15192
+ "examples": [],
15193
+ "fields": []
15068
15194
  }
15069
15195
  ],
15070
15196
  "examples": [
15071
15197
  {
15072
- "description": "Queues the gateway's auto-claim switch, signed by the wallet you act with.",
15198
+ "description": "Queues the deposit from the wallet you act with, preceded by an approval for the exact amount when the allowance is short. Answers 200 when settled within the preference window, otherwise 202 with the transaction to poll.",
15073
15199
  "path": {
15074
15200
  "gatewayAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15075
15201
  }
15076
15202
  }
15077
15203
  ]
15078
15204
  },
15079
- "custodyOps/gatewayDefaultPayoutPatch": {
15080
- "name": "custodyOps/gatewayDefaultPayoutPatch",
15081
- "method": "PATCH",
15082
- "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/default-payout",
15083
- "summary": "Set the default payout address",
15084
- "description": "Queues the address receipts sent by plain transfer are paid to. An address that is not on the gateway's approved list answers 422.",
15085
- "help": "Queues the address receipts sent by plain transfer are paid to. An address that is not on the gateway's approved list answers 422.",
15205
+ "custodyOps/gatewayDepositRead": {
15206
+ "name": "custodyOps/gatewayDepositRead",
15207
+ "method": "GET",
15208
+ "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/deposits/{depositId}",
15209
+ "summary": "Read a deposit",
15210
+ "description": "Returns one deposit with its stage history. A deposit waiting for the custodian shows the receipts held and the custodian's answer. A deposit that is not indexed answers 404.",
15211
+ "help": "Returns one deposit with its stage history. A deposit waiting for the custodian shows the receipts held and the custodian's answer. A deposit that is not indexed answers 404.",
15086
15212
  "tags": [
15087
15213
  "Custody operations"
15088
15214
  ],
@@ -15098,234 +15224,69 @@
15098
15224
  "examples": [
15099
15225
  "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15100
15226
  ],
15101
- "fields": []
15102
- }
15103
- ],
15104
- "queryParams": [],
15105
- "headerParams": [
15106
- {
15107
- "name": "Idempotency-Key",
15108
- "in": "header",
15109
- "required": false,
15110
- "description": "Caller-generated key that makes a repeated request resolve to the first attempt instead of starting a second one.",
15111
- "type": "string",
15112
- "enum": null,
15113
- "pattern": null,
15114
- "examples": [
15115
- "3f1c9a26-4c1e-4a53-9c6a-9c9d3e1b7a11"
15116
- ],
15117
- "fields": []
15118
- },
15119
- {
15120
- "name": "Prefer",
15121
- "in": "header",
15122
- "required": false,
15123
- "description": "RFC 7240 preference; separate directives with commas. Absent or `respond-async` answers 202 Accepted at once with the queued transaction's status URL. `wait` waits for settlement up to 99 seconds; `wait=N` waits up to N seconds, clamped to 5 through 99. Every wait also ends before the request deadline. A write that settles in time answers with its settled result; one that has not answers the same 202 as async. `Preference-Applied` echoes the directives honoured. Poll `Location` after 202 instead of resubmitting.",
15124
- "type": "string",
15125
- "enum": null,
15126
- "pattern": null,
15127
- "examples": [],
15128
- "fields": []
15129
- }
15130
- ],
15131
- "requestBodyDescription": null,
15132
- "hasRequestBody": true,
15133
- "bodyIsComplex": true,
15134
- "bodyFields": [
15135
- {
15136
- "name": "payout",
15137
- "in": "query",
15138
- "required": true,
15139
- "description": null,
15140
- "type": "string",
15141
- "enum": null,
15142
- "pattern": null,
15143
- "examples": [],
15144
- "fields": []
15145
- }
15146
- ],
15147
- "examples": [
15148
- {
15149
- "description": "Queues the address receipts sent by plain transfer are paid to. An address that is not on the gateway's approved list answers 422.",
15150
- "path": {
15151
- "gatewayAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15152
- }
15153
- }
15154
- ]
15155
- },
15156
- "custodyOps/gatewayDepositCreate": {
15157
- "name": "custodyOps/gatewayDepositCreate",
15158
- "method": "POST",
15159
- "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/deposits",
15160
- "summary": "Deposit a coin into a gateway",
15161
- "description": "Queues the deposit from the wallet you act with, preceded by an approval for the exact amount when the allowance is short. Answers 200 when settled within the preference window, otherwise 202 with the transaction to poll.",
15162
- "help": "Queues the deposit from the wallet you act with, preceded by an approval for the exact amount when the allowance is short. Answers 200 when settled within the preference window, otherwise 202 with the transaction to poll.",
15163
- "tags": [
15164
- "Custody operations"
15165
- ],
15166
- "pathParams": [
15167
- {
15168
- "name": "gatewayAddress",
15169
- "in": "path",
15170
- "required": true,
15171
- "description": "A valid Ethereum address (42 characters, starting with 0x)",
15172
- "type": "string",
15173
- "enum": null,
15174
- "pattern": "^0x[a-fA-F0-9]{40}$",
15175
- "examples": [
15176
- "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15177
- ],
15178
- "fields": []
15179
- }
15180
- ],
15181
- "queryParams": [],
15182
- "headerParams": [
15183
- {
15184
- "name": "Idempotency-Key",
15185
- "in": "header",
15186
- "required": false,
15187
- "description": "Caller-generated key that makes a repeated request resolve to the first attempt instead of starting a second one.",
15188
- "type": "string",
15189
- "enum": null,
15190
- "pattern": null,
15191
- "examples": [
15192
- "3f1c9a26-4c1e-4a53-9c6a-9c9d3e1b7a11"
15193
- ],
15194
- "fields": []
15195
- },
15196
- {
15197
- "name": "Prefer",
15198
- "in": "header",
15199
- "required": false,
15200
- "description": "RFC 7240 preference; separate directives with commas. Absent or `respond-async` answers 202 Accepted at once with the queued transaction's status URL. `wait` waits for settlement up to 99 seconds; `wait=N` waits up to N seconds, clamped to 5 through 99. Every wait also ends before the request deadline. A write that settles in time answers with its settled result; one that has not answers the same 202 as async. `Preference-Applied` echoes the directives honoured. Poll `Location` after 202 instead of resubmitting.",
15201
- "type": "string",
15202
- "enum": null,
15203
- "pattern": null,
15204
- "examples": [],
15205
- "fields": []
15206
- }
15207
- ],
15208
- "requestBodyDescription": null,
15209
- "hasRequestBody": true,
15210
- "bodyIsComplex": true,
15211
- "bodyFields": [
15212
- {
15213
- "name": "token",
15214
- "in": "query",
15215
- "required": true,
15216
- "description": null,
15217
- "type": "string",
15218
- "enum": null,
15219
- "pattern": null,
15220
- "examples": [],
15221
- "fields": []
15222
- },
15223
- {
15224
- "name": "amount",
15225
- "in": "query",
15226
- "required": true,
15227
- "description": "Amount in base units. Queues an approval first when the allowance is short.",
15228
- "type": "string",
15229
- "enum": null,
15230
- "pattern": "^[1-9][0-9]{0,77}$",
15231
- "examples": [],
15232
- "fields": []
15233
- }
15234
- ],
15235
- "examples": [
15236
- {
15237
- "description": "Queues the deposit from the wallet you act with, preceded by an approval for the exact amount when the allowance is short. Answers 200 when settled within the preference window, otherwise 202 with the transaction to poll.",
15238
- "path": {
15239
- "gatewayAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15240
- }
15241
- }
15242
- ]
15243
- },
15244
- "custodyOps/gatewayDepositRead": {
15245
- "name": "custodyOps/gatewayDepositRead",
15246
- "method": "GET",
15247
- "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/deposits/{depositId}",
15248
- "summary": "Read a deposit",
15249
- "description": "Returns one deposit with its stage history. A deposit waiting for the custodian shows the receipts held and the custodian's answer. A deposit that is not indexed answers 404.",
15250
- "help": "Returns one deposit with its stage history. A deposit waiting for the custodian shows the receipts held and the custodian's answer. A deposit that is not indexed answers 404.",
15251
- "tags": [
15252
- "Custody operations"
15253
- ],
15254
- "pathParams": [
15255
- {
15256
- "name": "gatewayAddress",
15257
- "in": "path",
15258
- "required": true,
15259
- "description": "A valid Ethereum address (42 characters, starting with 0x)",
15260
- "type": "string",
15261
- "enum": null,
15262
- "pattern": "^0x[a-fA-F0-9]{40}$",
15263
- "examples": [
15264
- "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15265
- ],
15266
- "fields": []
15267
- },
15268
- {
15269
- "name": "depositId",
15270
- "in": "path",
15271
- "required": true,
15272
- "description": "The 32-byte deposit id the gateway assigned, as lowercase hex.",
15273
- "type": "string",
15274
- "enum": null,
15275
- "pattern": "^0x[0-9a-f]{64}$",
15276
- "examples": [],
15277
- "fields": []
15278
- }
15279
- ],
15280
- "queryParams": [],
15281
- "headerParams": [],
15282
- "requestBodyDescription": null,
15283
- "hasRequestBody": false,
15284
- "bodyIsComplex": false,
15285
- "bodyFields": [],
15286
- "examples": [
15287
- {
15288
- "description": "Returns one deposit with its stage history. A deposit waiting for the custodian shows the receipts held and the custodian's answer. A deposit that is not indexed answers 404.",
15289
- "path": {
15290
- "gatewayAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
15291
- "depositId": "<depositId>"
15292
- }
15293
- }
15294
- ]
15295
- },
15296
- "custodyOps/gatewayDepositTransitionCreate": {
15297
- "name": "custodyOps/gatewayDepositTransitionCreate",
15298
- "method": "POST",
15299
- "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/deposits/{depositId}/transitions",
15300
- "summary": "Move a deposit to its next stage",
15301
- "description": "Queues the transition signed by your own wallet. A role the transition needs and you lack answers 403, a transition the deposit's stage does not allow answers 409 and queues nothing, and one that needs the add-on's checker approval answers 422 with the calls to propose. A screener clear or a keeper retry while a compliance claim of the gateway's client is revoked or expired answers 422 GatewayClientFlagged and queues nothing. Confirming that the custodian accepted the coins is the keeper's alone and is not a transition.",
15302
- "help": "Queues the transition signed by your own wallet. A role the transition needs and you lack answers 403, a transition the deposit's stage does not allow answers 409 and queues nothing, and one that needs the add-on's checker approval answers 422 with the calls to propose. A screener clear or a keeper retry while a compliance claim of the gateway's client is revoked or expired answers 422 GatewayClientFlagged and queues nothing. Confirming that the custodian accepted the coins is the keeper's alone and is not a transition.",
15303
- "tags": [
15304
- "Custody operations"
15305
- ],
15306
- "pathParams": [
15307
- {
15308
- "name": "gatewayAddress",
15309
- "in": "path",
15310
- "required": true,
15311
- "description": "A valid Ethereum address (42 characters, starting with 0x)",
15312
- "type": "string",
15313
- "enum": null,
15314
- "pattern": "^0x[a-fA-F0-9]{40}$",
15315
- "examples": [
15316
- "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15317
- ],
15318
- "fields": []
15319
- },
15320
- {
15321
- "name": "depositId",
15322
- "in": "path",
15323
- "required": true,
15324
- "description": "The 32-byte deposit id the gateway assigned, as lowercase hex.",
15325
- "type": "string",
15326
- "enum": null,
15327
- "pattern": "^0x[0-9a-f]{64}$",
15328
- "examples": [],
15227
+ "fields": []
15228
+ },
15229
+ {
15230
+ "name": "depositId",
15231
+ "in": "path",
15232
+ "required": true,
15233
+ "description": "The 32-byte deposit id the gateway assigned, as lowercase hex.",
15234
+ "type": "string",
15235
+ "enum": null,
15236
+ "pattern": "^0x[0-9a-f]{64}$",
15237
+ "examples": [],
15238
+ "fields": []
15239
+ }
15240
+ ],
15241
+ "queryParams": [],
15242
+ "headerParams": [],
15243
+ "requestBodyDescription": null,
15244
+ "hasRequestBody": false,
15245
+ "bodyIsComplex": false,
15246
+ "bodyFields": [],
15247
+ "examples": [
15248
+ {
15249
+ "description": "Returns one deposit with its stage history. A deposit waiting for the custodian shows the receipts held and the custodian's answer. A deposit that is not indexed answers 404.",
15250
+ "path": {
15251
+ "gatewayAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
15252
+ "depositId": "<depositId>"
15253
+ }
15254
+ }
15255
+ ]
15256
+ },
15257
+ "custodyOps/gatewayDepositTransitionCreate": {
15258
+ "name": "custodyOps/gatewayDepositTransitionCreate",
15259
+ "method": "POST",
15260
+ "url": "/api/v2/addons/custody-gateways/gateways/{gatewayAddress}/deposits/{depositId}/transitions",
15261
+ "summary": "Move a deposit to its next stage",
15262
+ "description": "Queues the transition signed by your own wallet. A role the transition needs and you lack answers 403, a transition the deposit's stage does not allow answers 409 and queues nothing, and one that needs the add-on's checker approval answers 422 with the calls to propose. A screener clear or a keeper retry while a compliance claim of the gateway's client is revoked or expired answers 422 GatewayClientFlagged and queues nothing. Confirming that the custodian accepted the coins is the keeper's alone and is not a transition.",
15263
+ "help": "Queues the transition signed by your own wallet. A role the transition needs and you lack answers 403, a transition the deposit's stage does not allow answers 409 and queues nothing, and one that needs the add-on's checker approval answers 422 with the calls to propose. A screener clear or a keeper retry while a compliance claim of the gateway's client is revoked or expired answers 422 GatewayClientFlagged and queues nothing. Confirming that the custodian accepted the coins is the keeper's alone and is not a transition.",
15264
+ "tags": [
15265
+ "Custody operations"
15266
+ ],
15267
+ "pathParams": [
15268
+ {
15269
+ "name": "gatewayAddress",
15270
+ "in": "path",
15271
+ "required": true,
15272
+ "description": "A valid Ethereum address (42 characters, starting with 0x)",
15273
+ "type": "string",
15274
+ "enum": null,
15275
+ "pattern": "^0x[a-fA-F0-9]{40}$",
15276
+ "examples": [
15277
+ "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
15278
+ ],
15279
+ "fields": []
15280
+ },
15281
+ {
15282
+ "name": "depositId",
15283
+ "in": "path",
15284
+ "required": true,
15285
+ "description": "The 32-byte deposit id the gateway assigned, as lowercase hex.",
15286
+ "type": "string",
15287
+ "enum": null,
15288
+ "pattern": "^0x[0-9a-f]{64}$",
15289
+ "examples": [],
15329
15290
  "fields": []
15330
15291
  }
15331
15292
  ],
@@ -16436,223 +16397,82 @@
16436
16397
  }
16437
16398
  ]
16438
16399
  },
16439
- "custodyOps/investorDepositsList": {
16440
- "name": "custodyOps/investorDepositsList",
16400
+ "custodyOps/whitelistCreate": {
16401
+ "name": "custodyOps/whitelistCreate",
16402
+ "method": "POST",
16403
+ "url": "/api/v2/custody-ops/whitelist",
16404
+ "summary": "Propose a withdrawal destination",
16405
+ "description": "Creates a destination-control challenge bound to your participant and destination.",
16406
+ "help": "Creates a destination-control challenge bound to your participant and destination.",
16407
+ "tags": [
16408
+ "Custody operations"
16409
+ ],
16410
+ "pathParams": [],
16411
+ "queryParams": [],
16412
+ "headerParams": [
16413
+ {
16414
+ "name": "idempotency-key",
16415
+ "in": "header",
16416
+ "required": true,
16417
+ "description": "Key that names this destination proposal. A retry under the same key answers the same entry; a different destination under it is refused.",
16418
+ "type": "string",
16419
+ "enum": null,
16420
+ "pattern": null,
16421
+ "examples": [
16422
+ "0198f1a2-3c4d-7e8f-9a0b-1c2d3e4f5a6b"
16423
+ ],
16424
+ "fields": []
16425
+ },
16426
+ {
16427
+ "name": "Idempotency-Key",
16428
+ "in": "header",
16429
+ "required": false,
16430
+ "description": "Retry key for one mutation. Reuse it only for the same method, path, and body on a route that documents replay safety. If omitted, the platform generates a UUIDv7 key; replay-safe writes echo it in the `Idempotency-Key` response header. A lost response still requires status reconciliation.",
16431
+ "type": "string",
16432
+ "enum": null,
16433
+ "pattern": null,
16434
+ "examples": [],
16435
+ "fields": []
16436
+ }
16437
+ ],
16438
+ "requestBodyDescription": null,
16439
+ "hasRequestBody": true,
16440
+ "bodyIsComplex": false,
16441
+ "bodyFields": [
16442
+ {
16443
+ "name": "chainId",
16444
+ "in": "query",
16445
+ "required": true,
16446
+ "description": "EVM chain identifier.",
16447
+ "type": "integer",
16448
+ "enum": null,
16449
+ "pattern": null,
16450
+ "examples": [
16451
+ "11155111"
16452
+ ],
16453
+ "fields": []
16454
+ },
16455
+ {
16456
+ "name": "destination",
16457
+ "in": "query",
16458
+ "required": true,
16459
+ "description": null,
16460
+ "type": "string",
16461
+ "enum": null,
16462
+ "pattern": null,
16463
+ "examples": [],
16464
+ "fields": []
16465
+ }
16466
+ ],
16467
+ "examples": []
16468
+ },
16469
+ "custodyOps/whitelistList": {
16470
+ "name": "custodyOps/whitelistList",
16441
16471
  "method": "GET",
16442
- "url": "/api/v2/users/me/custody-deposits",
16443
- "summary": "List your deposit states",
16444
- "description": "Returns one page of deposit observations for the acting participant, each held, free, refused, or compensated while held or after it was free. Compensated means the credit was reversed, either because the chain reorganised the deposit's block or because operators approved returning the deposit to its sender. Deposits from another participant or organization are never included.",
16445
- "help": "Returns one page of deposit observations for the acting participant, each held, free, refused, or compensated while held or after it was free. Compensated means the credit was reversed, either because the chain reorganised the deposit's block or because operators approved returning the deposit to its sender. Deposits from another participant or organization are never included.",
16446
- "tags": [
16447
- "Custody operations"
16448
- ],
16449
- "pathParams": [],
16450
- "queryParams": [
16451
- {
16452
- "name": "offset",
16453
- "in": "query",
16454
- "required": false,
16455
- "description": null,
16456
- "type": "string",
16457
- "enum": null,
16458
- "pattern": null,
16459
- "examples": [],
16460
- "fields": []
16461
- },
16462
- {
16463
- "name": "limit",
16464
- "in": "query",
16465
- "required": false,
16466
- "description": null,
16467
- "type": "string",
16468
- "enum": null,
16469
- "pattern": null,
16470
- "examples": [],
16471
- "fields": []
16472
- },
16473
- {
16474
- "name": "state",
16475
- "in": "query",
16476
- "required": false,
16477
- "description": null,
16478
- "type": "string",
16479
- "enum": [
16480
- "held",
16481
- "free",
16482
- "refused",
16483
- "compensated-held",
16484
- "compensated-free"
16485
- ],
16486
- "pattern": null,
16487
- "examples": [
16488
- "held",
16489
- "free",
16490
- "refused"
16491
- ],
16492
- "fields": []
16493
- }
16494
- ],
16495
- "headerParams": [],
16496
- "requestBodyDescription": null,
16497
- "hasRequestBody": false,
16498
- "bodyIsComplex": false,
16499
- "bodyFields": [],
16500
- "examples": [
16501
- {
16502
- "description": "Returns one page of deposit observations for the acting participant, each held, free, refused, or compensated while held or after it was free. Compensated means the credit was reversed, either because the chain reorganised the deposit's block or because operators approved returning the deposit to its sender. Deposits from another participant or organization are never included.",
16503
- "query": {
16504
- "state": "held"
16505
- }
16506
- }
16507
- ]
16508
- },
16509
- "custodyOps/positionsList": {
16510
- "name": "custodyOps/positionsList",
16511
- "method": "GET",
16512
- "url": "/api/v2/custody-ops/positions",
16513
- "summary": "List your custodial balances",
16514
- "description": "Returns one page of the balances the platform holds for the acting participant, with the free and held amount of each asset as a decimal string in the asset's own base units. Each row also carries the token's symbol, name and decimals, read from durable sources that include external tokens the organization has since dismissed; a field is null when no source knows it.",
16515
- "help": "Returns one page of the balances the platform holds for the acting participant, with the free and held amount of each asset as a decimal string in the asset's own base units. Each row also carries the token's symbol, name and decimals, read from durable sources that include external tokens the organization has since dismissed; a field is null when no source knows it.",
16516
- "tags": [
16517
- "Custody operations"
16518
- ],
16519
- "pathParams": [],
16520
- "queryParams": [
16521
- {
16522
- "name": "sort",
16523
- "in": "query",
16524
- "required": false,
16525
- "description": null,
16526
- "type": "string",
16527
- "enum": [
16528
- "assetKey",
16529
- "-assetKey",
16530
- "free",
16531
- "-free",
16532
- "held",
16533
- "-held"
16534
- ],
16535
- "pattern": null,
16536
- "examples": [
16537
- "assetKey",
16538
- "-assetKey",
16539
- "free"
16540
- ],
16541
- "fields": []
16542
- },
16543
- {
16544
- "name": "offset",
16545
- "in": "query",
16546
- "required": false,
16547
- "description": null,
16548
- "type": "number",
16549
- "enum": null,
16550
- "pattern": null,
16551
- "examples": [],
16552
- "fields": []
16553
- },
16554
- {
16555
- "name": "limit",
16556
- "in": "query",
16557
- "required": false,
16558
- "description": null,
16559
- "type": "number",
16560
- "enum": null,
16561
- "pattern": null,
16562
- "examples": [],
16563
- "fields": []
16564
- }
16565
- ],
16566
- "headerParams": [],
16567
- "requestBodyDescription": null,
16568
- "hasRequestBody": false,
16569
- "bodyIsComplex": false,
16570
- "bodyFields": [],
16571
- "examples": [
16572
- {
16573
- "description": "Returns one page of the balances the platform holds for the acting participant, with the free and held amount of each asset as a decimal string in the asset's own base units. Each row also carries the token's symbol, name and decimals, read from durable sources that include external tokens the organization has since dismissed; a field is null when no source knows it.",
16574
- "query": {
16575
- "sort": "assetKey"
16576
- }
16577
- }
16578
- ]
16579
- },
16580
- "custodyOps/whitelistCreate": {
16581
- "name": "custodyOps/whitelistCreate",
16582
- "method": "POST",
16583
- "url": "/api/v2/custody-ops/whitelist",
16584
- "summary": "Propose a withdrawal destination",
16585
- "description": "Creates a destination-control challenge bound to your participant and destination.",
16586
- "help": "Creates a destination-control challenge bound to your participant and destination.",
16587
- "tags": [
16588
- "Custody operations"
16589
- ],
16590
- "pathParams": [],
16591
- "queryParams": [],
16592
- "headerParams": [
16593
- {
16594
- "name": "idempotency-key",
16595
- "in": "header",
16596
- "required": true,
16597
- "description": "Key that names this destination proposal. A retry under the same key answers the same entry; a different destination under it is refused.",
16598
- "type": "string",
16599
- "enum": null,
16600
- "pattern": null,
16601
- "examples": [
16602
- "0198f1a2-3c4d-7e8f-9a0b-1c2d3e4f5a6b"
16603
- ],
16604
- "fields": []
16605
- },
16606
- {
16607
- "name": "Idempotency-Key",
16608
- "in": "header",
16609
- "required": false,
16610
- "description": "Retry key for one mutation. Reuse it only for the same method, path, and body on a route that documents replay safety. If omitted, the platform generates a UUIDv7 key; replay-safe writes echo it in the `Idempotency-Key` response header. A lost response still requires status reconciliation.",
16611
- "type": "string",
16612
- "enum": null,
16613
- "pattern": null,
16614
- "examples": [],
16615
- "fields": []
16616
- }
16617
- ],
16618
- "requestBodyDescription": null,
16619
- "hasRequestBody": true,
16620
- "bodyIsComplex": false,
16621
- "bodyFields": [
16622
- {
16623
- "name": "chainId",
16624
- "in": "query",
16625
- "required": true,
16626
- "description": "EVM chain identifier.",
16627
- "type": "integer",
16628
- "enum": null,
16629
- "pattern": null,
16630
- "examples": [
16631
- "11155111"
16632
- ],
16633
- "fields": []
16634
- },
16635
- {
16636
- "name": "destination",
16637
- "in": "query",
16638
- "required": true,
16639
- "description": null,
16640
- "type": "string",
16641
- "enum": null,
16642
- "pattern": null,
16643
- "examples": [],
16644
- "fields": []
16645
- }
16646
- ],
16647
- "examples": []
16648
- },
16649
- "custodyOps/whitelistList": {
16650
- "name": "custodyOps/whitelistList",
16651
- "method": "GET",
16652
- "url": "/api/v2/custody-ops/whitelist",
16653
- "summary": "List your withdrawal destinations",
16654
- "description": "Returns your own withdrawal destinations newest first, with their proof and operator-review state.",
16655
- "help": "Returns your own withdrawal destinations newest first, with their proof and operator-review state.",
16472
+ "url": "/api/v2/custody-ops/whitelist",
16473
+ "summary": "List your withdrawal destinations",
16474
+ "description": "Returns your own withdrawal destinations newest first, with their proof and operator-review state.",
16475
+ "help": "Returns your own withdrawal destinations newest first, with their proof and operator-review state.",
16656
16476
  "tags": [
16657
16477
  "Custody operations"
16658
16478
  ],
@@ -16842,306 +16662,6 @@
16842
16662
  }
16843
16663
  ]
16844
16664
  },
16845
- "custodyOps/withdrawalCreate": {
16846
- "name": "custodyOps/withdrawalCreate",
16847
- "method": "POST",
16848
- "url": "/api/v2/custody-ops/withdrawals",
16849
- "summary": "Request an ERC-20 withdrawal",
16850
- "description": "Creates a withdrawal request from your selected managed custody wallet to an active destination. The amount is held at once. The withdrawal stays held and can be cancelled until cancellableUntil, two minutes after the request by default; payout starts after that. A request that breaks a withdrawal limit of the policy is refused with the limit code, or created with limitBreach set and held for the policy's approvers.",
16851
- "help": "Creates a withdrawal request from your selected managed custody wallet to an active destination. The amount is held at once. The withdrawal stays held and can be cancelled until cancellableUntil, two minutes after the request by default; payout starts after that. A request that breaks a withdrawal limit of the policy is refused with the limit code, or created with limitBreach set and held for the policy's approvers.",
16852
- "tags": [
16853
- "Custody operations"
16854
- ],
16855
- "pathParams": [],
16856
- "queryParams": [],
16857
- "headerParams": [
16858
- {
16859
- "name": "idempotency-key",
16860
- "in": "header",
16861
- "required": true,
16862
- "description": "Key that names this withdrawal request. A retry under the same key answers the same withdrawal; a different request under it is refused.",
16863
- "type": "string",
16864
- "enum": null,
16865
- "pattern": null,
16866
- "examples": [
16867
- "0198f1a2-3c4d-7e8f-9a0b-1c2d3e4f5a6b"
16868
- ],
16869
- "fields": []
16870
- },
16871
- {
16872
- "name": "Idempotency-Key",
16873
- "in": "header",
16874
- "required": false,
16875
- "description": "Retry key for one mutation. Reuse it only for the same method, path, and body on a route that documents replay safety. If omitted, the platform generates a UUIDv7 key; replay-safe writes echo it in the `Idempotency-Key` response header. A lost response still requires status reconciliation.",
16876
- "type": "string",
16877
- "enum": null,
16878
- "pattern": null,
16879
- "examples": [],
16880
- "fields": []
16881
- }
16882
- ],
16883
- "requestBodyDescription": null,
16884
- "hasRequestBody": true,
16885
- "bodyIsComplex": true,
16886
- "bodyFields": [
16887
- {
16888
- "name": "chainId",
16889
- "in": "query",
16890
- "required": true,
16891
- "description": "EVM chain identifier.",
16892
- "type": "integer",
16893
- "enum": null,
16894
- "pattern": null,
16895
- "examples": [
16896
- "11155111"
16897
- ],
16898
- "fields": []
16899
- },
16900
- {
16901
- "name": "tokenAddress",
16902
- "in": "query",
16903
- "required": true,
16904
- "description": null,
16905
- "type": "string",
16906
- "enum": null,
16907
- "pattern": null,
16908
- "examples": [],
16909
- "fields": []
16910
- },
16911
- {
16912
- "name": "amount",
16913
- "in": "query",
16914
- "required": true,
16915
- "description": null,
16916
- "type": "string",
16917
- "enum": null,
16918
- "pattern": "^-?\\d+$",
16919
- "examples": [],
16920
- "fields": []
16921
- },
16922
- {
16923
- "name": "walletId",
16924
- "in": "query",
16925
- "required": true,
16926
- "description": "The participant's own managed custody wallet to pay from.",
16927
- "type": "string",
16928
- "enum": null,
16929
- "pattern": null,
16930
- "examples": [],
16931
- "fields": []
16932
- },
16933
- {
16934
- "name": "destination",
16935
- "in": "query",
16936
- "required": true,
16937
- "description": null,
16938
- "type": "string",
16939
- "enum": null,
16940
- "pattern": null,
16941
- "examples": [],
16942
- "fields": []
16943
- }
16944
- ],
16945
- "examples": []
16946
- },
16947
- "custodyOps/withdrawalFeeQuote": {
16948
- "name": "custodyOps/withdrawalFeeQuote",
16949
- "method": "GET",
16950
- "url": "/api/v2/custody-ops/withdrawal-fee-quotes",
16951
- "summary": "Quote the fees of a withdrawal",
16952
- "description": "Prices the custody fee and the network fee of a withdrawal before you request it. Nothing is stored or held. The figures are the ones the request would hold, priced again at that moment; a fee in an asset other than the one withdrawn, or a zero fee, is quoted with held false. An asset with no fee schedule answers zero fees and a null scheduleVersion.",
16953
- "help": "Prices the custody fee and the network fee of a withdrawal before you request it. Nothing is stored or held. The figures are the ones the request would hold, priced again at that moment; a fee in an asset other than the one withdrawn, or a zero fee, is quoted with held false. An asset with no fee schedule answers zero fees and a null scheduleVersion.",
16954
- "tags": [
16955
- "Custody operations"
16956
- ],
16957
- "pathParams": [],
16958
- "queryParams": [
16959
- {
16960
- "name": "chainId",
16961
- "in": "query",
16962
- "required": true,
16963
- "description": "EVM chain identifier.",
16964
- "type": "integer",
16965
- "enum": null,
16966
- "pattern": null,
16967
- "examples": [
16968
- "11155111"
16969
- ],
16970
- "fields": []
16971
- },
16972
- {
16973
- "name": "tokenAddress",
16974
- "in": "query",
16975
- "required": true,
16976
- "description": "ERC-20 token contract to withdraw.",
16977
- "type": "string",
16978
- "enum": null,
16979
- "pattern": null,
16980
- "examples": [
16981
- "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"
16982
- ],
16983
- "fields": []
16984
- },
16985
- {
16986
- "name": "amount",
16987
- "in": "query",
16988
- "required": true,
16989
- "description": "Token amount in base units, as a decimal string.",
16990
- "type": "string",
16991
- "enum": null,
16992
- "pattern": "^-?\\d+$",
16993
- "examples": [
16994
- "250000"
16995
- ],
16996
- "fields": []
16997
- }
16998
- ],
16999
- "headerParams": [],
17000
- "requestBodyDescription": null,
17001
- "hasRequestBody": false,
17002
- "bodyIsComplex": false,
17003
- "bodyFields": [],
17004
- "examples": [
17005
- {
17006
- "description": "Prices the custody fee and the network fee of a withdrawal before you request it. Nothing is stored or held. The figures are the ones the request would hold, priced again at that moment; a fee in an asset other than the one withdrawn, or a zero fee, is quoted with held false. An asset with no fee schedule answers zero fees and a null scheduleVersion.",
17007
- "query": {
17008
- "chainId": "11155111",
17009
- "tokenAddress": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
17010
- "amount": "250000"
17011
- }
17012
- }
17013
- ]
17014
- },
17015
- "custodyOps/withdrawalRead": {
17016
- "name": "custodyOps/withdrawalRead",
17017
- "method": "GET",
17018
- "url": "/api/v2/custody-ops/withdrawals/{withdrawalId}",
17019
- "summary": "Read a withdrawal",
17020
- "description": "Returns one of your withdrawals and its current lifecycle state.",
17021
- "help": "Returns one of your withdrawals and its current lifecycle state.",
17022
- "tags": [
17023
- "Custody operations"
17024
- ],
17025
- "pathParams": [
17026
- {
17027
- "name": "withdrawalId",
17028
- "in": "path",
17029
- "required": true,
17030
- "description": null,
17031
- "type": "string",
17032
- "enum": null,
17033
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
17034
- "examples": [],
17035
- "fields": []
17036
- }
17037
- ],
17038
- "queryParams": [],
17039
- "headerParams": [],
17040
- "requestBodyDescription": null,
17041
- "hasRequestBody": false,
17042
- "bodyIsComplex": false,
17043
- "bodyFields": [],
17044
- "examples": [
17045
- {
17046
- "description": "Returns one of your withdrawals and its current lifecycle state.",
17047
- "path": {
17048
- "withdrawalId": "<withdrawalId>"
17049
- }
17050
- }
17051
- ]
17052
- },
17053
- "custodyOps/withdrawalTransitionCreate": {
17054
- "name": "custodyOps/withdrawalTransitionCreate",
17055
- "method": "POST",
17056
- "url": "/api/v2/custody-ops/withdrawals/{withdrawalId}/transitions",
17057
- "summary": "Transition a withdrawal",
17058
- "description": "Cancels a held withdrawal with transition \"cancel\", or lets an authorized custody operator resolve a parked withdrawal with transition \"resolve\" and an outcome and reason.",
17059
- "help": "Cancels a held withdrawal with transition \"cancel\", or lets an authorized custody operator resolve a parked withdrawal with transition \"resolve\" and an outcome and reason.",
17060
- "tags": [
17061
- "Custody operations"
17062
- ],
17063
- "pathParams": [
17064
- {
17065
- "name": "withdrawalId",
17066
- "in": "path",
17067
- "required": true,
17068
- "description": null,
17069
- "type": "string",
17070
- "enum": null,
17071
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
17072
- "examples": [],
17073
- "fields": []
17074
- }
17075
- ],
17076
- "queryParams": [],
17077
- "headerParams": [
17078
- {
17079
- "name": "Idempotency-Key",
17080
- "in": "header",
17081
- "required": false,
17082
- "description": "Retry key for one mutation. Reuse it only for the same method, path, and body on a route that documents replay safety. If omitted, the platform generates a UUIDv7 key; replay-safe writes echo it in the `Idempotency-Key` response header. A lost response still requires status reconciliation.",
17083
- "type": "string",
17084
- "enum": null,
17085
- "pattern": null,
17086
- "examples": [],
17087
- "fields": []
17088
- }
17089
- ],
17090
- "requestBodyDescription": null,
17091
- "hasRequestBody": true,
17092
- "bodyIsComplex": true,
17093
- "bodyFields": [],
17094
- "examples": [
17095
- {
17096
- "description": "Cancels a held withdrawal with transition \"cancel\", or lets an authorized custody operator resolve a parked withdrawal with transition \"resolve\" and an outcome and reason.",
17097
- "path": {
17098
- "withdrawalId": "<withdrawalId>"
17099
- }
17100
- }
17101
- ]
17102
- },
17103
- "custodyOps/withdrawalsList": {
17104
- "name": "custodyOps/withdrawalsList",
17105
- "method": "GET",
17106
- "url": "/api/v2/custody-ops/withdrawals",
17107
- "summary": "List your withdrawals",
17108
- "description": "Returns your own withdrawal requests newest first, with their current lifecycle state.",
17109
- "help": "Returns your own withdrawal requests newest first, with their current lifecycle state.",
17110
- "tags": [
17111
- "Custody operations"
17112
- ],
17113
- "pathParams": [],
17114
- "queryParams": [
17115
- {
17116
- "name": "offset",
17117
- "in": "query",
17118
- "required": false,
17119
- "description": null,
17120
- "type": "number",
17121
- "enum": null,
17122
- "pattern": null,
17123
- "examples": [],
17124
- "fields": []
17125
- },
17126
- {
17127
- "name": "limit",
17128
- "in": "query",
17129
- "required": false,
17130
- "description": null,
17131
- "type": "number",
17132
- "enum": null,
17133
- "pattern": null,
17134
- "examples": [],
17135
- "fields": []
17136
- }
17137
- ],
17138
- "headerParams": [],
17139
- "requestBodyDescription": null,
17140
- "hasRequestBody": false,
17141
- "bodyIsComplex": false,
17142
- "bodyFields": [],
17143
- "examples": []
17144
- },
17145
16665
  "custodyProviderConfigurationsV2.adminCreate": {
17146
16666
  "name": "custodyProviderConfigurationsV2.adminCreate",
17147
16667
  "method": "POST",
@@ -43345,6 +42865,197 @@
43345
42865
  }
43346
42866
  ]
43347
42867
  },
42868
+ "reporting.mirrorReconciliations.mirrorReconciliationRunsFile": {
42869
+ "name": "reporting.mirrorReconciliations.mirrorReconciliationRunsFile",
42870
+ "method": "GET",
42871
+ "url": "/api/v2/reporting/mirror-reconciliations/{tokenAddress}/runs/{runDate}/file",
42872
+ "summary": "Export a mirror token's reconciliation run as CSV",
42873
+ "description": "Returns the investor lines of the run as CSV, one row per line that does not match.",
42874
+ "help": "Returns the investor lines of the run as CSV, one row per line that does not match.",
42875
+ "tags": [
42876
+ "Regulatory reporting"
42877
+ ],
42878
+ "pathParams": [
42879
+ {
42880
+ "name": "tokenAddress",
42881
+ "in": "path",
42882
+ "required": true,
42883
+ "description": "A valid Ethereum address (42 characters, starting with 0x)",
42884
+ "type": "string",
42885
+ "enum": null,
42886
+ "pattern": "^0x[a-fA-F0-9]{40}$",
42887
+ "examples": [
42888
+ "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
42889
+ ],
42890
+ "fields": []
42891
+ },
42892
+ {
42893
+ "name": "runDate",
42894
+ "in": "path",
42895
+ "required": true,
42896
+ "description": null,
42897
+ "type": "string",
42898
+ "enum": null,
42899
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
42900
+ "examples": [],
42901
+ "fields": []
42902
+ }
42903
+ ],
42904
+ "queryParams": [
42905
+ {
42906
+ "name": "version",
42907
+ "in": "query",
42908
+ "required": false,
42909
+ "description": null,
42910
+ "type": "string",
42911
+ "enum": null,
42912
+ "pattern": null,
42913
+ "examples": [],
42914
+ "fields": []
42915
+ }
42916
+ ],
42917
+ "headerParams": [],
42918
+ "requestBodyDescription": null,
42919
+ "hasRequestBody": false,
42920
+ "bodyIsComplex": false,
42921
+ "bodyFields": [],
42922
+ "examples": [
42923
+ {
42924
+ "description": "Returns the investor lines of the run as CSV, one row per line that does not match.",
42925
+ "path": {
42926
+ "tokenAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
42927
+ "runDate": "<runDate>"
42928
+ }
42929
+ }
42930
+ ]
42931
+ },
42932
+ "reporting.mirrorReconciliations.mirrorReconciliationRunsGet": {
42933
+ "name": "reporting.mirrorReconciliations.mirrorReconciliationRunsGet",
42934
+ "method": "GET",
42935
+ "url": "/api/v2/reporting/mirror-reconciliations/{tokenAddress}/runs/{runDate}",
42936
+ "summary": "Read a mirror token's reconciliation run",
42937
+ "description": "Returns the run of a date with its totals and every investor line that does not match. Without a version, the date's latest run.",
42938
+ "help": "Returns the run of a date with its totals and every investor line that does not match. Without a version, the date's latest run.",
42939
+ "tags": [
42940
+ "Regulatory reporting"
42941
+ ],
42942
+ "pathParams": [
42943
+ {
42944
+ "name": "tokenAddress",
42945
+ "in": "path",
42946
+ "required": true,
42947
+ "description": "A valid Ethereum address (42 characters, starting with 0x)",
42948
+ "type": "string",
42949
+ "enum": null,
42950
+ "pattern": "^0x[a-fA-F0-9]{40}$",
42951
+ "examples": [
42952
+ "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
42953
+ ],
42954
+ "fields": []
42955
+ },
42956
+ {
42957
+ "name": "runDate",
42958
+ "in": "path",
42959
+ "required": true,
42960
+ "description": null,
42961
+ "type": "string",
42962
+ "enum": null,
42963
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
42964
+ "examples": [],
42965
+ "fields": []
42966
+ }
42967
+ ],
42968
+ "queryParams": [
42969
+ {
42970
+ "name": "version",
42971
+ "in": "query",
42972
+ "required": false,
42973
+ "description": null,
42974
+ "type": "string",
42975
+ "enum": null,
42976
+ "pattern": null,
42977
+ "examples": [],
42978
+ "fields": []
42979
+ }
42980
+ ],
42981
+ "headerParams": [],
42982
+ "requestBodyDescription": null,
42983
+ "hasRequestBody": false,
42984
+ "bodyIsComplex": false,
42985
+ "bodyFields": [],
42986
+ "examples": [
42987
+ {
42988
+ "description": "Returns the run of a date with its totals and every investor line that does not match. Without a version, the date's latest run.",
42989
+ "path": {
42990
+ "tokenAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
42991
+ "runDate": "<runDate>"
42992
+ }
42993
+ }
42994
+ ]
42995
+ },
42996
+ "reporting.mirrorReconciliations.mirrorReconciliationRunsList": {
42997
+ "name": "reporting.mirrorReconciliations.mirrorReconciliationRunsList",
42998
+ "method": "GET",
42999
+ "url": "/api/v2/reporting/mirror-reconciliations/{tokenAddress}/runs",
43000
+ "summary": "List a mirror token's reconciliation runs",
43001
+ "description": "Lists every daily run with its outcome (clear, break or no-statement) and number of breaks, newest date and version first.",
43002
+ "help": "Lists every daily run with its outcome (clear, break or no-statement) and number of breaks, newest date and version first.",
43003
+ "tags": [
43004
+ "Regulatory reporting"
43005
+ ],
43006
+ "pathParams": [
43007
+ {
43008
+ "name": "tokenAddress",
43009
+ "in": "path",
43010
+ "required": true,
43011
+ "description": "A valid Ethereum address (42 characters, starting with 0x)",
43012
+ "type": "string",
43013
+ "enum": null,
43014
+ "pattern": "^0x[a-fA-F0-9]{40}$",
43015
+ "examples": [
43016
+ "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
43017
+ ],
43018
+ "fields": []
43019
+ }
43020
+ ],
43021
+ "queryParams": [
43022
+ {
43023
+ "name": "offset",
43024
+ "in": "query",
43025
+ "required": false,
43026
+ "description": null,
43027
+ "type": "number",
43028
+ "enum": null,
43029
+ "pattern": null,
43030
+ "examples": [],
43031
+ "fields": []
43032
+ },
43033
+ {
43034
+ "name": "limit",
43035
+ "in": "query",
43036
+ "required": false,
43037
+ "description": null,
43038
+ "type": "number",
43039
+ "enum": null,
43040
+ "pattern": null,
43041
+ "examples": [],
43042
+ "fields": []
43043
+ }
43044
+ ],
43045
+ "headerParams": [],
43046
+ "requestBodyDescription": null,
43047
+ "hasRequestBody": false,
43048
+ "bodyIsComplex": false,
43049
+ "bodyFields": [],
43050
+ "examples": [
43051
+ {
43052
+ "description": "Lists every daily run with its outcome (clear, break or no-statement) and number of breaks, newest date and version first.",
43053
+ "path": {
43054
+ "tokenAddress": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
43055
+ }
43056
+ }
43057
+ ]
43058
+ },
43348
43059
  "reporting.mirrorReconciliations.mirrorReconciliationSettlementFeedsFile": {
43349
43060
  "name": "reporting.mirrorReconciliations.mirrorReconciliationSettlementFeedsFile",
43350
43061
  "method": "GET",