From e9adc67186d380de8bb7fba59045c1753da9b3b9 Mon Sep 17 00:00:00 2001 From: Gleb Date: Mon, 4 Mar 2024 20:34:41 -0800 Subject: [PATCH] ANCHOR-603: Add fee_details documentation --- .../rpc-methods/do_stellar_payment.json | 31 +++++++- .../assets/rpc-methods/do_stellar_refund.json | 32 +++++++- .../rpc-methods/notify_amounts_updated.json | 70 +++++++++++++++++- .../notify_customer_info_updated.json | 32 +++++++- .../notify_interactive_flow_completed.json | 70 +++++++++++++++++- .../notify_offchain_funds_available.json | 32 +++++++- .../notify_offchain_funds_pending.json | 32 +++++++- .../notify_offchain_funds_received.json | 67 ++++++++++++++++- .../notify_offchain_funds_sent.json | 32 +++++++- .../notify_onchain_funds_received.json | 73 ++++++++++++++++++- .../notify_onchain_funds_sent.json | 32 +++++++- .../rpc-methods/notify_refund_pending.json | 32 +++++++- .../rpc-methods/notify_refund_sent.json | 32 +++++++- .../rpc-methods/notify_transaction_error.json | 32 +++++++- .../notify_transaction_expired.json | 32 +++++++- .../notify_transaction_recovery.json | 32 +++++++- .../assets/rpc-methods/notify_trust_set.json | 32 +++++++- .../request_customer_info_update.json | 32 +++++++- .../rpc-methods/request_offchain_funds.json | 68 ++++++++++++++++- .../rpc-methods/request_onchain_funds.json | 68 ++++++++++++++++- static/assets/rpc-methods/request_trust.json | 32 +++++++- 21 files changed, 865 insertions(+), 30 deletions(-) diff --git a/static/assets/rpc-methods/do_stellar_payment.json b/static/assets/rpc-methods/do_stellar_payment.json index a1f24e2a8..2ae17515b 100644 --- a/static/assets/rpc-methods/do_stellar_payment.json +++ b/static/assets/rpc-methods/do_stellar_payment.json @@ -122,7 +122,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -132,6 +132,35 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/do_stellar_refund.json b/static/assets/rpc-methods/do_stellar_refund.json index 9b9c18345..bfb3ca08d 100644 --- a/static/assets/rpc-methods/do_stellar_refund.json +++ b/static/assets/rpc-methods/do_stellar_refund.json @@ -175,7 +175,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -185,6 +185,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_amounts_updated.json b/static/assets/rpc-methods/notify_amounts_updated.json index c2e1f0d1b..449961277 100644 --- a/static/assets/rpc-methods/notify_amounts_updated.json +++ b/static/assets/rpc-methods/notify_amounts_updated.json @@ -45,8 +45,8 @@ }, { "name": "amount_fee", - "description": "Amount of fee charged by anchor", - "required": true, + "description": "DEPRECATED in favor of fee_detailss. Amount of fee charged by anchor", + "required": false, "schema": { "type": "object", "properties": { @@ -57,6 +57,40 @@ }, "required": ["amount"] } + }, + { + "name": "fee_details", + "description": "Description of fees charged by the anchor", + "required": true, + "schema": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + }, + "required": ["total", "asset"] + } } ], "result": { @@ -148,7 +182,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -158,6 +192,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_customer_info_updated.json b/static/assets/rpc-methods/notify_customer_info_updated.json index 4f5278e22..385802f99 100644 --- a/static/assets/rpc-methods/notify_customer_info_updated.json +++ b/static/assets/rpc-methods/notify_customer_info_updated.json @@ -115,7 +115,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -125,6 +125,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_interactive_flow_completed.json b/static/assets/rpc-methods/notify_interactive_flow_completed.json index 449a9cb60..c4474dd7d 100644 --- a/static/assets/rpc-methods/notify_interactive_flow_completed.json +++ b/static/assets/rpc-methods/notify_interactive_flow_completed.json @@ -71,8 +71,8 @@ }, { "name": "amount_fee", - "description": "The amount of fee expected to be charged by anchor", - "required": true, + "description": "DEPRECATED in favor of fee_details. The amount of fee expected to be charged by anchor", + "required": false, "schema": { "type": "object", "properties": { @@ -91,6 +91,40 @@ ] } }, + { + "name": "fee_details", + "description": "Description of fees charged by the anchor", + "required": true, + "schema": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + }, + "required": ["total", "asset"] + } + }, { "name": "amount_expected", "description": "The amount expected in the payment", @@ -199,7 +233,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -209,6 +243,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_offchain_funds_available.json b/static/assets/rpc-methods/notify_offchain_funds_available.json index 1b6274620..f6ddca0ee 100644 --- a/static/assets/rpc-methods/notify_offchain_funds_available.json +++ b/static/assets/rpc-methods/notify_offchain_funds_available.json @@ -130,7 +130,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -140,6 +140,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_offchain_funds_pending.json b/static/assets/rpc-methods/notify_offchain_funds_pending.json index 3b151499d..11ddef302 100644 --- a/static/assets/rpc-methods/notify_offchain_funds_pending.json +++ b/static/assets/rpc-methods/notify_offchain_funds_pending.json @@ -133,7 +133,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -143,6 +143,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_offchain_funds_received.json b/static/assets/rpc-methods/notify_offchain_funds_received.json index f5b5bd6fc..20961fc0e 100644 --- a/static/assets/rpc-methods/notify_offchain_funds_received.json +++ b/static/assets/rpc-methods/notify_offchain_funds_received.json @@ -76,7 +76,7 @@ }, { "name": "amount_fee", - "description": "Amount of fee charged by anchor", + "description": "DEPRECATED in favour of fee_details. Amount of fee charged by anchor", "required": false, "schema": { "type": "object", @@ -88,6 +88,40 @@ }, "required": ["amount"] } + }, + { + "name": "fee_details", + "description": "Description of fees charged by the anchor", + "required": false, + "schema": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + }, + "required": ["total", "asset"] + } } ], "result": { @@ -179,7 +213,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The amount of fee expected to be charged by anchor", "properties": { "asset": { "type": "string" @@ -189,6 +223,35 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_offchain_funds_sent.json b/static/assets/rpc-methods/notify_offchain_funds_sent.json index ee53bb90e..2dcace7bc 100644 --- a/static/assets/rpc-methods/notify_offchain_funds_sent.json +++ b/static/assets/rpc-methods/notify_offchain_funds_sent.json @@ -141,7 +141,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -151,6 +151,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_onchain_funds_received.json b/static/assets/rpc-methods/notify_onchain_funds_received.json index 000d1fe9f..37cab18ef 100644 --- a/static/assets/rpc-methods/notify_onchain_funds_received.json +++ b/static/assets/rpc-methods/notify_onchain_funds_received.json @@ -56,7 +56,7 @@ }, { "name": "amount_out", - "description": "Amount expected to be sent by anchor to user. If set, both `amount_in` and `amount_fee` must be specified", + "description": "Amount expected to be sent by anchor to user. If set, both `amount_in` and `fee_details` must be specified", "required": false, "schema": { "type": "object", @@ -71,7 +71,7 @@ }, { "name": "amount_fee", - "description": "Amount of fee charged by anchor. If set, both `amount_in` and `amount_out` must be specified", + "description": "DEPRECATED in favor of fee_details. Amount of fee charged by anchor. If set, both `amount_in` and `amount_out` must be specified", "required": false, "schema": { "type": "object", @@ -83,6 +83,43 @@ }, "required": ["amount"] } + }, + { + "name": "fee_details", + "description": "Description of fees charged by the anchor", + "required": false, + "schema": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + }, + "required": [ + "total", + "asset" + ] + } } ], "result": { @@ -174,7 +211,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -184,6 +221,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_onchain_funds_sent.json b/static/assets/rpc-methods/notify_onchain_funds_sent.json index 689c130d3..ad2c85d9f 100644 --- a/static/assets/rpc-methods/notify_onchain_funds_sent.json +++ b/static/assets/rpc-methods/notify_onchain_funds_sent.json @@ -130,7 +130,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -140,6 +140,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_refund_pending.json b/static/assets/rpc-methods/notify_refund_pending.json index d0f91f11f..282379ec7 100644 --- a/static/assets/rpc-methods/notify_refund_pending.json +++ b/static/assets/rpc-methods/notify_refund_pending.json @@ -177,7 +177,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -187,6 +187,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_refund_sent.json b/static/assets/rpc-methods/notify_refund_sent.json index b21fc277b..2ef0e472f 100644 --- a/static/assets/rpc-methods/notify_refund_sent.json +++ b/static/assets/rpc-methods/notify_refund_sent.json @@ -179,7 +179,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -189,6 +189,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_transaction_error.json b/static/assets/rpc-methods/notify_transaction_error.json index 28834153b..c2bfff2bb 100644 --- a/static/assets/rpc-methods/notify_transaction_error.json +++ b/static/assets/rpc-methods/notify_transaction_error.json @@ -124,7 +124,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -134,6 +134,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_transaction_expired.json b/static/assets/rpc-methods/notify_transaction_expired.json index f5e4e4c2d..46af461e4 100644 --- a/static/assets/rpc-methods/notify_transaction_expired.json +++ b/static/assets/rpc-methods/notify_transaction_expired.json @@ -125,7 +125,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -135,6 +135,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_transaction_recovery.json b/static/assets/rpc-methods/notify_transaction_recovery.json index 2e51ec9ac..894a5e56b 100644 --- a/static/assets/rpc-methods/notify_transaction_recovery.json +++ b/static/assets/rpc-methods/notify_transaction_recovery.json @@ -125,7 +125,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -135,6 +135,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/notify_trust_set.json b/static/assets/rpc-methods/notify_trust_set.json index b8b12e3e5..0ef40daad 100644 --- a/static/assets/rpc-methods/notify_trust_set.json +++ b/static/assets/rpc-methods/notify_trust_set.json @@ -130,7 +130,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -140,6 +140,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/request_customer_info_update.json b/static/assets/rpc-methods/request_customer_info_update.json index 1c0684970..f84d0dd64 100644 --- a/static/assets/rpc-methods/request_customer_info_update.json +++ b/static/assets/rpc-methods/request_customer_info_update.json @@ -134,7 +134,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -144,6 +144,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/request_offchain_funds.json b/static/assets/rpc-methods/request_offchain_funds.json index b8c580a09..c47172d04 100644 --- a/static/assets/rpc-methods/request_offchain_funds.json +++ b/static/assets/rpc-methods/request_offchain_funds.json @@ -74,7 +74,7 @@ }, { "name": "amount_fee", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The amount of fee expected to be charged by anchor", "required": false, "schema": { "type": "object", @@ -94,6 +94,40 @@ ] } }, + { + "name": "fee_details", + "description": "Description of fees charged by the anchor", + "required": false, + "schema": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + }, + "required": ["total", "asset"] + } + }, { "name": "amount_expected", "description": "The amount expected in the payment", @@ -205,7 +239,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -215,6 +249,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/request_onchain_funds.json b/static/assets/rpc-methods/request_onchain_funds.json index b8a7f2c81..96d25e3cf 100644 --- a/static/assets/rpc-methods/request_onchain_funds.json +++ b/static/assets/rpc-methods/request_onchain_funds.json @@ -74,7 +74,7 @@ }, { "name": "amount_fee", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The amount of fee expected to be charged by anchor", "required": false, "schema": { "type": "object", @@ -94,6 +94,40 @@ ] } }, + { + "name": "fee_details", + "description": "Description of fees charged by the anchor", + "required": false, + "schema": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + }, + "required": ["total", "asset"] + } + }, { "name": "amount_expected", "description": "The amount expected in the payment", @@ -229,7 +263,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -239,6 +273,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response" diff --git a/static/assets/rpc-methods/request_trust.json b/static/assets/rpc-methods/request_trust.json index 22548d748..61ef60a4a 100644 --- a/static/assets/rpc-methods/request_trust.json +++ b/static/assets/rpc-methods/request_trust.json @@ -118,7 +118,7 @@ }, "amount_fee": { "type": "object", - "description": "The amount of fee expected to be charged by anchor", + "description": "DEPRECATED in favour of fee_details. The total amount charged in fees for processing all refund payments, in units of amount_in_asset", "properties": { "asset": { "type": "string" @@ -128,6 +128,36 @@ } } }, + "fee_details": { + "type": "object", + "description": "Description of fee charged by the anchor.", + "properties": { + "total": { + "type": "number" + }, + "asset": { + "type": "string" + }, + "details": { + "type": "array", + "description": "Details about fee charged", + "items": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + }, + "quote_id": { "type": "string", "description": "The id returned from a SEP-38 POST /quote response"