Return the whole currency display info when needed

This commit is contained in:
Jeremy Klein 2024-09-24 21:38:36 -07:00
parent 93c8dc9094
commit 418de94e60

49
47.md
View File

@ -506,8 +506,18 @@ Response:
{
"result_type": "fetch_quote",
"result": {
"sending_currency_code": "string",
"receiving_currency_code": "string",
"sending_currency": {
"code": "string",
"name": "string",
"symbol": "string",
"decimals": "number",
},
"receiving_currency": {
"code": "string",
"name": "string",
"symbol": "string",
"decimals": "number",
},
"payment_hash": "string", // used to execute the quote
"expires_at": "number",
"multiplier": "number", // receiving unit per sending unit
@ -573,8 +583,18 @@ Response:
"result": {
"preimage": "string",
"quote": {
"sending_currency_code": "string",
"receiving_currency_code": "string",
"sending_currency": {
"code": "string",
"name": "string",
"symbol": "string",
"decimals": "number",
},
"receiving_currency": {
"code": "string",
"name": "string",
"symbol": "string",
"decimals": "number",
},
"payment_hash": "string",
"multiplier": "number", // receiving unit per sending unit
"fees": "number", // fees in the sending currency
@ -604,7 +624,12 @@ Response:
"result_type": "get_balance",
"result": {
"balance": "number", // user's balance in the smallest unit of the currency
"currency_code": "string"
"currency": {
"code": "string",
"name": "string",
"symbol": "string",
"decimals": "number",
}|undefined,
}
}
```
@ -619,11 +644,21 @@ The invoice/payment objects returned by `lookup_invoice` and `list_transactions`
// Optional field:
"fx": {
"receiving_currency_code": "string",
"receiving_currency": {
"code": "string",
"name": "string",
"symbol": "string",
"decimals": "number",
},
"total_receiving_amount": "number",
"multiplier": "number", // receiving unit per sending unit (SATs if incoming)
// Remaining fields only available for outgoing payments:
"sending_currency_code": "string",
"sending_currency": {
"code": "string",
"name": "string",
"symbol": "string",
"decimals": "number",
},
"fees": "number", // fees in the sending currency
"total_sending_amount": "number",
},