summaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-07-21 17:43:07 -0300
committerSebastian <sebasjm@gmail.com>2021-07-21 17:43:07 -0300
commitc3d35951d2f895c31efa1d1ebd9ca81569b842f8 (patch)
treebd185b09d079104d5821075e874cd1aaea3bc04e /core/api-merchant.rst
parent25c840abcd5acee4d9e93e853954568e2e2ae796 (diff)
downloaddocs-c3d35951d2f895c31efa1d1ebd9ca81569b842f8.tar.gz
docs-c3d35951d2f895c31efa1d1ebd9ca81569b842f8.tar.bz2
docs-c3d35951d2f895c31efa1d1ebd9ca81569b842f8.zip
adding missing instance parameter into the public urls
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst20
1 files changed, 10 insertions, 10 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index a6cb94d..7994c56 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -165,7 +165,7 @@ where order IDs are predictable and malicious actors may try to
claim orders (say in a case where stocks are limited).
-.. http:post:: /orders/$ORDER_ID/claim
+.. http:post:: [/instances/$INSTANCE]/orders/$ORDER_ID/claim
Wallet claims ownership (via nonce) over an order. By claiming
an order, the wallet obtains the full contract terms, and thereby
@@ -212,7 +212,7 @@ claim orders (say in a case where stocks are limited).
Making the payment
------------------
-.. http:post:: /orders/$ORDER_ID/pay
+.. http:post:: [/instances/$INSTANCE]/orders/$ORDER_ID/pay
Pay for an order by giving a deposit permission for coins. Typically used by
the customer's wallet. Note that this request does not include the
@@ -318,7 +318,7 @@ Making the payment
Querying payment status
-----------------------
-.. http:get:: /orders/$ORDER_ID
+.. http:get:: [/instances/$INSTANCE]/orders/$ORDER_ID
Query the payment status of an order. This endpoint is for the wallet.
When the wallet goes to this URL and it is unpaid,
@@ -428,7 +428,7 @@ if the user is using a different client, demonstrating payment will allow
the user to regain access to the digital good without having to pay for it
again.
-.. http:post:: /orders/$ORDER_ID/paid
+.. http:post:: [/instances/$INSTANCE]/orders/$ORDER_ID/paid
Prove that the client previously paid for an order by providing
the merchant's signature from the `payment response <PaymentResponse>`.
@@ -492,7 +492,7 @@ are for incomplete payments for an order and never for established contracts.
.. _order-abort:
-.. http:post:: /orders/$ORDER_ID/abort
+.. http:post:: [/instances/$INSTANCE]/orders/$ORDER_ID/abort
Abort paying for an order and obtain a refund for coins that
were already deposited as part of a failed payment.
@@ -637,7 +637,7 @@ for example because the merchant determined that it could not actually fulfill
the contract. Refunds must be approved by the merchant's business logic.
-.. http:post:: /orders/$ORDER_ID/refund
+.. http:post:: [/instances/$INSTANCE]/orders/$ORDER_ID/refund
Obtain refunds for an order. After talking to the exchange, the refunds will
no longer be pending if processed successfully.
@@ -753,7 +753,7 @@ Picking up tips
Tips are a way for wallets to obtain e-cash from
a website.
-.. http:get:: /tips/$TIP_ID
+.. http:get:: [/instances/$INSTANCE]/tips/$TIP_ID
Handle request from wallet to provide details about a tip.
@@ -791,7 +791,7 @@ a website.
}
-.. http:post:: /tips/$TIP_ID/pickup
+.. http:post:: [/instances/$INSTANCE]/tips/$TIP_ID/pickup
Handle request from wallet to pick up a tip.
@@ -861,7 +861,7 @@ instance setup before it can be used to manage inventory or process payments.
Setting up instances
--------------------
-.. http:post:: /private/instances
+.. http:post:: [/instances/$INSTANCE]/private/instances
This request will be used to create a new merchant instance in the backend.
It is only available for the implicit ``default`` instance.
@@ -2789,7 +2789,7 @@ Checking tip status
}
-.. http:get:: [/instances/$INSTANCES]/private/tips
+.. http:get:: [/instances/$INSTANCE]/private/tips
Return the list of all tips.