You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: 'The field to sort results on. Possible values: - id: Sort by allocation ID. - updatedAt: Sort by the last updated timestamp. - quantity: Sort by the allocation amount quantity. - currency: Sort by the allocation currency code. Note: A finals sort is always applied on createdAt ascending and id ascending, regardless of the specified sortField. This ensures consistent ordering for items with the same primary sort value.'
2743
2744
in: query
@@ -2928,6 +2929,7 @@ paths:
2928
2929
in: query
2929
2930
schema:
2930
2931
type: string
2932
+
format: integer
2931
2933
- name: connectionIds
2932
2934
description: 'Optional array of connection IDs to filter by. If provided: - Only balances for connections with these specific IDs will be returned. - Useful for monitoring specific trading relationships or connections. - Can be used to focus on particular allocation targets. If omitted, results will include data for all your connections subject to other filters.'
2933
2935
in: query
@@ -3034,6 +3036,7 @@ paths:
3034
3036
in: query
3035
3037
schema:
3036
3038
type: string
3039
+
format: integer
3037
3040
- name: active
3038
3041
in: query
3039
3042
schema:
@@ -4034,6 +4037,7 @@ paths:
4034
4037
in: query
4035
4038
schema:
4036
4039
type: string
4040
+
format: integer
4037
4041
- name: enterpriseId
4038
4042
description: The enterprise identifier of the client. This identifies the client enterprise that owns the allocation.
4039
4043
in: path
@@ -4133,6 +4137,7 @@ paths:
4133
4137
in: query
4134
4138
schema:
4135
4139
type: string
4140
+
format: integer
4136
4141
- name: settlementIds
4137
4142
description: Filter by specific settlement IDs. When provided, only settlements matching these IDs will be returned.
4138
4143
in: query
@@ -4283,6 +4288,7 @@ paths:
4283
4288
in: query
4284
4289
schema:
4285
4290
type: string
4291
+
format: integer
4286
4292
- name: enterpriseId
4287
4293
description: The enterprise identifier of the client. This identifies the client enterprise making the API request.
4288
4294
in: path
@@ -4664,6 +4670,7 @@ paths:
4664
4670
in: query
4665
4671
schema:
4666
4672
type: string
4673
+
format: integer
4667
4674
- name: currencies
4668
4675
description: Optional array of currencies. If provided will only return settlement transfers with those currencies.
4669
4676
in: query
@@ -4821,6 +4828,7 @@ paths:
4821
4828
in: query
4822
4829
schema:
4823
4830
type: string
4831
+
format: integer
4824
4832
- name: ids
4825
4833
description: Filter by specific partner IDs. When provided, only partners with these IDs will be returned.
4826
4834
in: query
@@ -5119,6 +5127,7 @@ paths:
5119
5127
in: query
5120
5128
schema:
5121
5129
type: string
5130
+
format: integer
5122
5131
- name: sortField
5123
5132
description: 'The field to sort results on. Possible values: - id: Sort by allocation ID. - updatedAt: Sort by the last updated timestamp. - quantity: Sort by the allocation amount quantity. Note: A final sort is always applied on createdAt ascending and id ascending, regardless of the specified sortField. This ensures consistent ordering for items with the same primary sort value.'
5124
5133
in: query
@@ -5415,6 +5424,7 @@ paths:
5415
5424
in: query
5416
5425
schema:
5417
5426
type: string
5427
+
format: integer
5418
5428
- name: partnerIds
5419
5429
description: 'Optional array of partner IDs to filter by. If provided: - Only balances for partners with these IDs will be returned. - Only connections to these partners will be included. - Useful when a partner has multiple partner entities and wants to filter results. If omitted, results will include data for all partners the requester has access to.'
5420
5430
in: query
@@ -5537,6 +5547,7 @@ paths:
5537
5547
in: query
5538
5548
schema:
5539
5549
type: string
5550
+
format: integer
5540
5551
- name: active
5541
5552
in: query
5542
5553
schema:
@@ -5910,6 +5921,7 @@ paths:
5910
5921
in: query
5911
5922
schema:
5912
5923
type: string
5924
+
format: integer
5913
5925
- name: settlementExternalIds
5914
5926
description: Optional array of settlement externalIds. If provided will only return disputes with a disputedSettlementId of a settlement with an externalId matching one of the provided settlementExternalIds.
5915
5927
in: query
@@ -6037,6 +6049,7 @@ paths:
6037
6049
in: query
6038
6050
schema:
6039
6051
type: string
6052
+
format: integer
6040
6053
- name: settlementIds
6041
6054
description: Filter by specific settlement IDs. When provided, only settlements matching these IDs will be returned.
6042
6055
in: query
@@ -6436,6 +6449,7 @@ paths:
6436
6449
in: query
6437
6450
schema:
6438
6451
type: string
6452
+
format: integer
6439
6453
- name: enterpriseId
6440
6454
description: The enterprise identifier of the partner. This identifies the partner enterprise making the API request.
6441
6455
in: path
@@ -63166,12 +63180,6 @@ components:
63166
63180
items:
63167
63181
type: string
63168
63182
minLength: 1
63169
-
PolicyResult:
63170
-
title: PolicyResult
63171
-
type: string
63172
-
enum:
63173
-
- approved
63174
-
- rejected
63175
63183
PolicyRule:
63176
63184
type: object
63177
63185
properties:
@@ -73447,6 +73455,20 @@ components:
73447
73455
retriable:
73448
73456
type: boolean
73449
73457
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
73458
+
evaluationId:
73459
+
type: string
73460
+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
73461
+
minLength: 1
73462
+
pendingApprovalId:
73463
+
type: string
73464
+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
73465
+
minLength: 1
73466
+
policyResult:
73467
+
type: string
73468
+
enum:
73469
+
- approved
73470
+
- rejected
73471
+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
73450
73472
reason:
73451
73473
nullable: true
73452
73474
type: string
@@ -73540,6 +73562,20 @@ components:
73540
73562
retriable:
73541
73563
type: boolean
73542
73564
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
73565
+
evaluationId:
73566
+
type: string
73567
+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
73568
+
minLength: 1
73569
+
pendingApprovalId:
73570
+
type: string
73571
+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
73572
+
minLength: 1
73573
+
policyResult:
73574
+
type: string
73575
+
enum:
73576
+
- approved
73577
+
- rejected
73578
+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
73729
+
evaluationId:
73730
+
type: string
73731
+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
73732
+
minLength: 1
73733
+
pendingApprovalId:
73734
+
type: string
73735
+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
73736
+
minLength: 1
73737
+
policyResult:
73738
+
type: string
73739
+
enum:
73740
+
- approved
73741
+
- rejected
73742
+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
73695
73743
status:
73696
73744
type: string
73697
73745
enum:
@@ -74067,17 +74115,19 @@ components:
74067
74115
description: A nonce value used in the connection cryptographic operations. This provides additional security for connection operations.
74068
74116
minLength: 1
74069
74117
evaluationId:
74070
-
nullable: true
74071
74118
type: string
74119
+
description: The unique identifier of the policy evaluation for this connection.
74072
74120
minLength: 1
74073
74121
pendingApprovalId:
74074
-
nullable: true
74075
74122
type: string
74123
+
description: The unique identifier of the pending approval for this connection.
74076
74124
minLength: 1
74077
74125
policyResult:
74078
-
nullable: true
74079
-
allOf:
74080
-
- $ref: '#/components/schemas/PolicyResult'
74126
+
type: string
74127
+
enum:
74128
+
- approved
74129
+
- rejected
74130
+
description: 'The result of the policy evaluation for this connection. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
74081
74131
partnersConnectionId:
74082
74132
nullable: true
74083
74133
type: string
@@ -74102,9 +74152,6 @@ components:
74102
74152
- active
74103
74153
- proof
74104
74154
- nonce
74105
-
- evaluationId
74106
-
- pendingApprovalId
74107
-
- policyResult
74108
74155
- partnersConnectionId
74109
74156
- partnersClientId
74110
74157
- initialized
@@ -74265,17 +74312,19 @@ components:
74265
74312
description: A nonce value used in the connection cryptographic operations. This provides additional security for connection operations.
74266
74313
minLength: 1
74267
74314
evaluationId:
74268
-
nullable: true
74269
74315
type: string
74316
+
description: The unique identifier of the policy evaluation for this connection.
74270
74317
minLength: 1
74271
74318
pendingApprovalId:
74272
-
nullable: true
74273
74319
type: string
74320
+
description: The unique identifier of the pending approval for this connection.
74274
74321
minLength: 1
74275
74322
policyResult:
74276
-
nullable: true
74277
-
allOf:
74278
-
- $ref: '#/components/schemas/PolicyResult'
74323
+
type: string
74324
+
enum:
74325
+
- approved
74326
+
- rejected
74327
+
description: 'The result of the policy evaluation for this connection. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
75620
+
evaluationId:
75621
+
type: string
75622
+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
75623
+
minLength: 1
75624
+
pendingApprovalId:
75625
+
type: string
75626
+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
75627
+
minLength: 1
75628
+
policyResult:
75629
+
type: string
75630
+
enum:
75631
+
- approved
75632
+
- rejected
75633
+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
75576
75634
status:
75577
75635
type: string
75578
75636
enum:
@@ -75666,6 +75724,20 @@ components:
75666
75724
enum:
75667
75725
- false
75668
75726
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
75727
+
evaluationId:
75728
+
type: string
75729
+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
75730
+
minLength: 1
75731
+
pendingApprovalId:
75732
+
type: string
75733
+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
75734
+
minLength: 1
75735
+
policyResult:
75736
+
type: string
75737
+
enum:
75738
+
- approved
75739
+
- rejected
75740
+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
75669
75741
reason:
75670
75742
type: string
75671
75743
description: The reason that the allocation/deallocation is not cleared. Provides a descriptive explanation for why the allocation is in the reserved state. Will not be defined if the allocation is cleared.
@@ -75744,6 +75816,20 @@ components:
75744
75816
enum:
75745
75817
- true
75746
75818
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
75819
+
evaluationId:
75820
+
type: string
75821
+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
75822
+
minLength: 1
75823
+
pendingApprovalId:
75824
+
type: string
75825
+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
75826
+
minLength: 1
75827
+
policyResult:
75828
+
type: string
75829
+
enum:
75830
+
- approved
75831
+
- rejected
75832
+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
75747
75833
reason:
75748
75834
type: string
75749
75835
description: The reason that the allocation/deallocation is not cleared. Provides a descriptive explanation for why the allocation is in the reserved state. Will not be defined if the allocation is cleared.
0 commit comments