From 1a00b47493ce26c064ecccd3ceb3406e6ed558c8 Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Fri, 23 Jul 2021 13:22:05 +0200 Subject: fulfillment URL docs --- core/api-merchant.rst | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 3bbd07d9..ef84fcd9 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -1637,13 +1637,13 @@ Creating orders // Short summary of the order. summary: string; - // URL that will show that the order was successful after - // it has been paid for. Optional. When POSTing to the - // merchant, the placeholder "${ORDER_ID}" will be - // replaced with the actual order ID (useful if the - // order ID is generated server-side and needs to be - // in the URL). + // See documentation of fulfillment_url in ContractTerms. + // Either fulfillment_url or fulfillment_message must be specified. fulfillment_url?: string; + + // See documentation of fulfillment_message in ContractTerms. + // Either fulfillment_url or fulfillment_message must be specified. + fulfillment_message?: string; } The following `MinimalInventoryProduct` can be provided if the parts of the @@ -2867,10 +2867,13 @@ The contract terms must have the following structure: // before transferring it to the merchant. amount: Amount; - // The URL for this purchase. Every time it is visited, the merchant - // will send back to the customer the same proposal. - // The URL should be bookmarkable. - // Either fulfillment_url or fulfillment_message must be specified. + // URL that will show that the order was successful after + // it has been paid for. Optional. When POSTing to the + // merchant, the placeholder "${ORDER_ID}" will be + // replaced with the actual order ID (useful if the + // order ID is generated server-side and needs to be + // in the URL). + // Note that this placeholder can only be used once. fulfillment_url?: string; // Message shown to the customer after paying for the order. -- cgit v1.2.3