Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Introduce OrderInstructions Message #335

Closed
mistermoe opened this issue Jul 1, 2024 · 0 comments · Fixed by #355
Closed

Introduce OrderInstructions Message #335

mistermoe opened this issue Jul 1, 2024 · 0 comments · Fixed by #355

Comments

@mistermoe
Copy link
Member

Context

Currently, a Quote contains both payin and payout instructions which Alice can use to facilitate a payin or receive a payout. This introduces non-deterministic outcomes because Alice can actually facilitate a pay in prior to sending an Order message.

Proposal

We should consider moving payment instructions from the Quote message to a new message kind, OrderInstructions, which is sent by the PFI after Alice submits an Order message.

Message Contents

Data

field data type required description
payin PaymentInstruction Y the amount of payin currency that the PFI will receive
payout PaymentInstruction Y the amount of payout currency that Alice will receive

PaymentInstruction

field data type required description
link String N Link to allow Alice to pay PFI, or be paid by the PFI
instruction String N Instruction on how Alice can pay PFI, or how Alice can be paid by the PFI

Example

{
  "metadata": {...},
  "data": {
    "payin": {
      "link": "some_payment_link",
      "instruction": "plain_text"
    },
    "payout": {
      "link": "some_payment_link",
      "instruction": "plain_text"
    }
  }
}
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants