diff --git a/content/tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.md b/content/tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.md index 71fbff981b..bc09fd46a1 100644 --- a/content/tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.md +++ b/content/tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.md @@ -6,14 +6,17 @@ labels: - Escrow - Smart Contracts --- -# Look up Escrows +# Look up escrows -All pending escrows are stored in the ledger as [Escrow objects](escrow.html). You can look them up by the sender's address or the destination address. +All pending escrows are stored in the ledger as [Escrow objects](escrow.html). - Note to Dennis: Is anyone going to be looking up escrows created before 2017? Seems like an extremely niche case to be taking up page space. Remove this maybe? <--> -**Note:** You can only look up pending escrow objects by destination address if those escrows were created after the [fix1523 amendment][] was enabled on 2017-11-14. +You can look up escrow objects by the [sender's address](#look-up-escrows-by-sender-address) or the [destination address](#look-up-escrows-by-destination-address) using the [account_objects method][]. -Use the [account_objects][] method, where the sender or destination address is the `account` value. +## Look up escrows by sender address + +You can use the [account_objects method][] to look up escrow objects by sender address. + +Let's say that you want to look up all pending escrow objects with a sender address of `rfztBskAVszuS3s5Kq7zDS74QtHrw893fm`. You can do this using the following example request, where the sender address is the `account` value. Request: @@ -27,7 +30,47 @@ _Websocket_ -The response includes all pending escrow objects with `rfztBskAVszuS3s5Kq7zDS74QtHrw893fm`, where the sender address is the `Account` value, or the destination address is the `Destination` value. + +The response resembles the following example. Note that the response includes all pending escrow objects with `rfztBskAVszuS3s5Kq7zDS74QtHrw893fm` as the sender or destination address, where the sender address is the `Account` value and the destination address is the `Destination` value. + +In this example, the second and fourth escrow objects meet our lookup criteria because their `Account` (sender address) values are set to `rfztBskAVszuS3s5Kq7zDS74QtHrw893fm`. + +Response: + + + +_Websocket_ + +```json +{% include '_code-samples/escrow/websocket/account_objects-response.json' %} +``` + + + +## Look up escrows by destination address + +You can use the [account_objects method][] to look up escrow objects by destination address. + +**Note:** You can only look up pending escrow objects by destination address if those escrows were created after the [fix1523 amendment][] was enabled on 2017-11-14. + +Let's say that you want to look up all pending escrow objects with a destination address of `rfztBskAVszuS3s5Kq7zDS74QtHrw893fm`. You can do this using the following example request, where the destination address is the `account` value. + +Request: + + + +_Websocket_ + +```json +{% include '_code-samples/escrow/websocket/account_objects-request.json' %} +``` + + + + +The response resembles the following example. Note that the response includes all pending escrow objects with `rfztBskAVszuS3s5Kq7zDS74QtHrw893fm` as the destination or sender address, where the destination address is the `Destination` value and the sender address is the `Account` value. + +In this example, the first and third escrow objects meet our lookup criteria because their `Destination` (destination address) values are set to `rfztBskAVszuS3s5Kq7zDS74QtHrw893fm`. Response: