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: (optional) Provide a unique `stellar_address:memo` pair that will be used to correlate a Stellar payment 1-to-1 with a Platform resource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction.
18
-
- name: Fees
19
-
description: Requests containing data that can be used to calculate transaction fees.
20
18
- name: Rates
21
19
description: Requests containing data that can be used to provide exchange rates between on & off-chain assets.
22
20
- name: Customers
@@ -85,104 +83,6 @@ paths:
85
83
application/json:
86
84
schema:
87
85
$ref: '#/components/schemas/Error'
88
-
/fee:
89
-
get:
90
-
description: |
91
-
The Platform will make this request to the anchor every time a transaction is initiated by a client application
92
-
without a `quote_id`.
93
-
94
-
The Anchor must ensure that the sending and receiving customers specified in the request meet the KYC requirements
95
-
necessary to partake in the transaction described in the request.
96
-
97
-
The anchor must return the fee it will charge for the transaction.
98
-
99
-
In the future, this endpoint may be used to provide estimated fees to client applications prior to initiating transactions.
100
-
When this change is made, the request schema will be adapted to support the use case.
101
-
tags:
102
-
- Fees
103
-
x-seps:
104
-
- SEP-31
105
-
summary: Retrieve Fees
106
-
operationId: getFee
107
-
parameters:
108
-
- in: query
109
-
name: send_asset
110
-
description: |
111
-
The asset the client application will send to the anchor in exchange for `receive_asset` in
The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount`
128
-
or `receive_amount` will always be included in the request. If the client application specified a `quote_id` in
129
-
its transaction creation request, both amounts specified in the referenced quote will be passed.
130
-
schema:
131
-
type: string
132
-
- in: query
133
-
name: receive_amount
134
-
description: |
135
-
The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or
136
-
`receive_amount` will always be included in the request. If the client application specified a `quote_id` in its
137
-
transaction creation request, both amounts specified in the referenced quote will be passed.
138
-
schema:
139
-
type: string
140
-
- in: query
141
-
name: client_id
142
-
description: |
143
-
An identifier for the client application making the request. This ID can be used to offer different fees to different clients.
144
-
A client ID it the Stellar account of a sending anchor: In SEP-31, the `client_id` should match the account of a known SEP-31 sending anchor match the one used to authenticate via SEP-10.
145
-
schema:
146
-
type: string
147
-
required: true
148
-
- in: query
149
-
name: sender_id
150
-
description: |
151
-
The SEP-12 customer ID of the sending user.
152
-
schema:
153
-
type: string
154
-
required: true
155
-
- in: query
156
-
name: receiver_id
157
-
description: |
158
-
The SEP-12 customer ID of the receiving user.
159
-
schema:
160
-
type: string
161
-
required: true
162
-
responses:
163
-
'200':
164
-
description: Success.
165
-
content:
166
-
application/json:
167
-
schema:
168
-
$ref: '#/components/schemas/FeeResponse'
169
-
'422':
170
-
description: |
171
-
Unprocessable Entity. This status should be returned when the anchor understood the request but cannot
172
-
return a success response. An example for when this response code would be appropriate is if the sender
173
-
and/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases,
174
-
the Platform will respond to the client application's request with a `400 Bad Request` and include the
175
-
error message provided by the anchor in the response body.
176
-
content:
177
-
application/json:
178
-
schema:
179
-
$ref: '#/components/schemas/Error'
180
-
'500':
181
-
description: Error. The Platform will respond to the client application with the same response code and body.
182
-
content:
183
-
application/json:
184
-
schema:
185
-
$ref: '#/components/schemas/Error'
186
86
/rate:
187
87
get:
188
88
description: |
@@ -542,21 +442,6 @@ components:
542
442
type: string
543
443
required:
544
444
- error
545
-
Amount:
546
-
type: object
547
-
required:
548
-
- amount
549
-
- asset
550
-
properties:
551
-
amount:
552
-
type: string
553
-
asset:
554
-
type: string
555
-
FeeResponse:
556
-
type: object
557
-
properties:
558
-
fee:
559
-
$ref: '#/components/schemas/Amount'
560
445
RateFeeDetailResponse:
561
446
type: object
562
447
properties:
@@ -956,6 +841,16 @@ components:
956
841
- no_market
957
842
- too_small
958
843
- too_large
844
+
Amount:
845
+
type: object
846
+
required:
847
+
- amount
848
+
- asset
849
+
properties:
850
+
amount:
851
+
type: string
852
+
asset:
853
+
type: string
959
854
FeeDescription:
960
855
type: object
961
856
required:
@@ -1073,6 +968,26 @@ components:
1073
968
description: The memo type of the transaction in the Stellar network. Should be present if memo is not null.
1074
969
enum:
1075
970
- text id hash
971
+
StellarId:
972
+
type: object
973
+
description: |
974
+
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.
975
+
976
+
For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.
977
+
978
+
For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.
979
+
980
+
For a SEP-6 or SEP-24 Anchor, the `account` and `memo` fields should be used.
981
+
properties:
982
+
id:
983
+
type: string
984
+
description: The `id` of the customer registered through SEP-12.
985
+
account:
986
+
type: string
987
+
description: Either the Stellar account or Muxed account address of the on-chain entity.
988
+
memo:
989
+
type: string
990
+
description: The memo value identifying a customer with a shared account, where the shared account is `account`.
1076
991
TransactionSEP24:
1077
992
type: object
1078
993
required:
@@ -1097,6 +1012,9 @@ components:
1097
1012
- withdrawal
1098
1013
status:
1099
1014
$ref: '#/components/schemas/StatusSEP24'
1015
+
type:
1016
+
type: string
1017
+
description: This field is always empty for SEP-24 transactions.
1100
1018
amount_expected:
1101
1019
$ref: '#/components/schemas/Amount'
1102
1020
amount_in:
@@ -1119,6 +1037,9 @@ components:
1119
1037
transfer_received_at:
1120
1038
type: string
1121
1039
format: date-time
1040
+
user_action_required_by:
1041
+
type: string
1042
+
format: date-time
1122
1043
message:
1123
1044
type: string
1124
1045
refunds:
@@ -1138,14 +1059,25 @@ components:
1138
1059
memo_type:
1139
1060
$ref: '#/components/schemas/MemoType'
1140
1061
refund_memo:
1141
-
description: if provided, this memo should be used for refund transactions
1062
+
description: If provided, this memo should be used for refund transactions.
1142
1063
type: string
1143
1064
refund_memo_type:
1144
1065
$ref: '#/components/schemas/MemoType'
1145
1066
client_domain:
1146
1067
type: string
1147
1068
client_name:
1148
1069
type: string
1070
+
customers:
1071
+
type: object
1072
+
description: |
1073
+
The user that initiated the transaction is both the sender and receiver.
1074
+
properties:
1075
+
sender:
1076
+
$ref: '#/components/schemas/StellarId'
1077
+
receiver:
1078
+
$ref: '#/components/schemas/StellarId'
1079
+
creator:
1080
+
$ref: '#/components/schemas/StellarId'
1149
1081
StatusSEP31:
1150
1082
type: string
1151
1083
description: Possible status value for SEP-31 transactions
@@ -1161,26 +1093,6 @@ components:
1161
1093
- pending_receiver
1162
1094
- pending_transaction_info_update
1163
1095
- pending_customer_info_update
1164
-
StellarId:
1165
-
type: object
1166
-
description: |
1167
-
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.
1168
-
1169
-
For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.
1170
-
1171
-
For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used.
1172
-
1173
-
For a SEP-6 Anchor, the `account` and `memo` fields should be used.
1174
-
properties:
1175
-
id:
1176
-
type: string
1177
-
description: The `id` of the customer registered through SEP-12.
1178
-
account:
1179
-
type: string
1180
-
description: Either the Stellar account or Muxed account address of the on-chain entity.
1181
-
memo:
1182
-
type: string
1183
-
description: The memo value identifying a customer with a shared account, where the shared account is `account`.
1184
1096
TransactionSEP31:
1185
1097
type: object
1186
1098
required:
@@ -1202,6 +1114,9 @@ components:
1202
1114
- receive
1203
1115
status:
1204
1116
$ref: '#/components/schemas/StatusSEP31'
1117
+
type:
1118
+
type: string
1119
+
description: This field is always empty for SEP-31 transactions.
1205
1120
amount_expected:
1206
1121
$ref: '#/components/schemas/Amount'
1207
1122
amount_in:
@@ -1224,6 +1139,9 @@ components:
1224
1139
transfer_received_at:
1225
1140
type: string
1226
1141
format: date-time
1142
+
user_action_required_by:
1143
+
type: string
1144
+
format: date-time
1227
1145
message:
1228
1146
type: string
1229
1147
refunds:
@@ -1232,8 +1150,21 @@ components:
1232
1150
type: array
1233
1151
items:
1234
1152
$ref: '#/components/schemas/StellarTransaction'
1153
+
source_account:
1154
+
type: string
1155
+
destination_account:
1156
+
type: string
1235
1157
external_transaction_id:
1236
1158
type: string
1159
+
memo:
1160
+
type: string
1161
+
memo_type:
1162
+
$ref: '#/components/schemas/MemoType'
1163
+
refund_memo:
1164
+
description: if provided, this memo should be used for refund transactions.
1165
+
type: string
1166
+
refund_memo_type:
1167
+
$ref: '#/components/schemas/MemoType'
1237
1168
client_domain:
1238
1169
type: string
1239
1170
client_name:
@@ -1292,14 +1223,12 @@ components:
1292
1223
enum:
1293
1224
- transaction_created
1294
1225
- transaction_status_changed
1295
-
- transaction_error
1296
1226
- quote_created
1297
1227
- customer_updated
1298
1228
description: |
1299
1229
The transaction event type. Can be one of the following:
1300
1230
- `transaction_created` - a transaction was created through the SEP endpoints. The payload is in the `transaction` field.
1301
1231
- `transaction_status_changed` - the status of a transaction has changed. The payload is in the `transaction` field.
1302
-
- `transaction_error` - error processing the transaction. The payload is in the `transaction` field.
1303
1232
- `quote_created` - a quote was created via the SEP38 API. The payload is in the `quote` field.
0 commit comments