diff options
| author | Jonathan Buchanan <jonathan.russ.buchanan@gmail.com> | 2020-07-18 01:04:05 -0400 |
|---|---|---|
| committer | Jonathan Buchanan <jonathan.russ.buchanan@gmail.com> | 2020-07-18 01:04:05 -0400 |
| commit | c95e975013a303380b41debe21c759b87f405c18 (patch) | |
| tree | 0d62d9ef5ee5108bb050f1c3236a532560ca6cf9 /core | |
| parent | 8a4460bfaaa22b0df490d621c35504690109874f (diff) | |
| download | docs-c95e975013a303380b41debe21c759b87f405c18.tar.gz docs-c95e975013a303380b41debe21c759b87f405c18.tar.bz2 docs-c95e975013a303380b41debe21c759b87f405c18.zip | |
revise forget spec
Diffstat (limited to 'core')
| -rw-r--r-- | core/api-merchant.rst | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 9be0b2d6..8e86c61f 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -1054,7 +1054,18 @@ Payment processing **Request:** The request must be a `forget request <ForgetRequest>`. The fields specified - must have been marked as forgettable when the contract was created. + must have been marked as forgettable when the contract was created. Fields in + the request that are not in the `contract terms <ContractTerms>` are ignored. + + A valid + JSON path is defined as a string beginning with ``$.`` that follows the dot + notation: ``$.wire_fee``, for example. The ``$`` represents the `contract terms <ContractTerms>` + object, and an identifier following a ``.`` represents the field of that + identifier belonging to the object preceding the dot. Arrays can be indexed + by an non-negative integer within brackets: ``$.products[1]``. An asterisk ``*`` + can be used to index an array as a wildcard, which expands the path into a + list of paths containing one path for + each valid array index: ``$.products[*].description``. **Response:** |