Skip to content

Commit

Permalink
Fold PaymentInstruction into QuoteDetail #201
Browse files Browse the repository at this point in the history
  • Loading branch information
Diane Huxley committed Jan 13, 2024
1 parent 3f2f78d commit 77b7279
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions specs/protocol/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -418,21 +418,14 @@ a `Close` can be sent by Alice _or_ the PFI as a reply to an RFQ or a Quote. It
| `expiresAt ` | datetime | Y | When this quote expires. Expressed as ISO8601 |
| `payin` | [`QuoteDetails`](#quotedetails) | Y | the amount of _payin_ currency that the PFI will receive |
| `payout` | [`QuoteDetails`](#quotedetails) | Y | the amount of _payout_ currency that Alice will receive |
| `paymentInstructions` | [`PaymentInstructions`](#paymentinstructions) | N | Object that describes how to pay the PFI, and how to get paid by the PFI (e.g. BTC address, payment link) |


#### `QuoteDetails`
| field | data type | required | description |
| ---------------- | --------- | -------- | ------------------------------------------------------------------------------- |
| `currencyCode` | string | Y | ISO 3166 currency code string |
| `amountSubunits` | string | Y | The amount of currency including fees expressed in the smallest respective unit |
| `feeSubunits` | string | N | The amount paid in fees expressed in the smallest respective unit |

#### `PaymentInstructions`
| field | data type | required | description |
| -------- | ------------------------------------------- | -------- | --------------------------------------------------------- |
| `payin` | [`PaymentInstruction`](#paymentinstruction) | N | Link or Instruction describing how to pay the PFI. |
| `payout` | [`PaymentInstruction`](#paymentinstruction) | N | Link or Instruction describing how to get paid by the PFI |
| field | data type | required | description |
|----------------------|--------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `currencyCode` | string | Y | ISO 3166 currency code string |
| `amountSubunits` | string | Y | The amount of currency paid out from or paid in to Alice in the smallest respective unit |
| `feeSubunits` | string | N | The amount paid in fees expressed in the smallest respective unit. This field is strictly informative, i.e. it does not affect the total payin/payout amount stated in the `amountSubunits` field. |
| `paymentInstruction` | `PaymentInstruction`](#paymentinstruction) | N | Link or Instruction describing how to pay the PFI or how to get paid by the PFI. |

#### `PaymentInstruction`
| field | data type | required | description |
Expand Down

0 comments on commit 77b7279

Please sign in to comment.