From 3764a1cbe2ba5e15c5f3d0ab6126012318a2df3c Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Wed, 8 Mar 2017 03:03:24 +0100 Subject: properly document order id --- api/api-merchant.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'api/api-merchant.rst') diff --git a/api/api-merchant.rst b/api/api-merchant.rst index 41f1c365..f1042685 100644 --- a/api/api-merchant.rst +++ b/api/api-merchant.rst @@ -478,6 +478,14 @@ The `proposal data` must have the following structure: // NOTE: still not implemented summary: string; + // Unique, free-form identifier for the proposal. + // Must be unique within a merchant instance. + // For merchants that do not store proposals in their DB + // before the customer paid for them, the order_id can be used + // by the frontend to restore a proposal from the information + // encoded in it (such as a short product identifier and timestamp). + order_id: string; + // Total price for the transaction. // The exchange will subtract deposit fees from that amount // before transfering it to the merchant. -- cgit v1.2.3