From decf7499652d366d34ad75181db91c494ffef418 Mon Sep 17 00:00:00 2001 From: Gleb Date: Thu, 23 Mar 2023 14:06:24 -0700 Subject: [PATCH 1/2] Add optional statuses back --- .../anchor-platform/sep24-user-guide.mdx | 49 +++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/docs/anchoring-assets/anchor-platform/sep24-user-guide.mdx b/docs/anchoring-assets/anchor-platform/sep24-user-guide.mdx index d6532c57c..2e5f0f3b4 100644 --- a/docs/anchoring-assets/anchor-platform/sep24-user-guide.mdx +++ b/docs/anchoring-assets/anchor-platform/sep24-user-guide.mdx @@ -552,6 +552,30 @@ To execute this update, simply run ./call-path.sh kyc-in-process.json ``` +##### KYC Being Collected/Verified + +:::tip + +This step is optional. Most business don't use it: you can skip it and go to the [next one](#ready-to-receive-funds) + +::: + +Update for this action is simply changing transaction status. It's a good idea to modify message too, reflecting details of the process: + + + +```json +{ + "transaction": { + "id": "", + "status": "pending_anchor", + "message": "KYC is being verified" + } +} +``` + + + ##### Ready to Receive Funds After KYC is collected, you should be ready to receive the off-chain deposit. While you're waiting for the user to deliver funds, you'll want to provide an updated transaction status as well as basic transaction information. @@ -595,6 +619,31 @@ Asset field is optional. When not set, it defaults to the asset user requested. ::: +##### Waiting For User Funds + +:::tip + +This step is optional. Most business don't use it: you can skip it and go to the [next one](#sending-stellar-transaction) + +::: + +After update in the previous chapter has been made, user will be notified that your service is ready to receive funds. In real world, transfer confirmation may take time. In such cases, transaction should be set to a new status, after funds have been received, but not confirmed yet. + + + +```json +{ + "transaction": { + "id": "", + "status": "pending_external", + "external_transaction_id": "", + "message": "Transfer is being verified" + } +} +``` + + + ##### Sending Stellar Transaction The next step would be sending Stellar transaction. First, let's change status to reflect the latest transaction state: From d92c03f03f143acfac312b96f7578bcef387d0b4 Mon Sep 17 00:00:00 2001 From: Gleb Date: Thu, 23 Mar 2023 15:52:03 -0700 Subject: [PATCH 2/2] Fix PR comments --- .../anchor-platform/sep24-user-guide.mdx | 34 ++++++------------- 1 file changed, 10 insertions(+), 24 deletions(-) diff --git a/docs/anchoring-assets/anchor-platform/sep24-user-guide.mdx b/docs/anchoring-assets/anchor-platform/sep24-user-guide.mdx index 2e5f0f3b4..58a887c80 100644 --- a/docs/anchoring-assets/anchor-platform/sep24-user-guide.mdx +++ b/docs/anchoring-assets/anchor-platform/sep24-user-guide.mdx @@ -529,6 +529,14 @@ When KYC process is long (for example, ID verification), it's advised to first s ##### Processing KYC Information +:::tip + +This step is optional. Most business don't use it: you can skip it and go to the [next one](#ready-to-receive-funds) + +Using this status is encouraged when KYC verification may need to be performed asynchronously. + +::: + Update for this action is simply changing transaction status. It's a good idea to modify message too, reflecting details of the process: @@ -552,30 +560,6 @@ To execute this update, simply run ./call-path.sh kyc-in-process.json ``` -##### KYC Being Collected/Verified - -:::tip - -This step is optional. Most business don't use it: you can skip it and go to the [next one](#ready-to-receive-funds) - -::: - -Update for this action is simply changing transaction status. It's a good idea to modify message too, reflecting details of the process: - - - -```json -{ - "transaction": { - "id": "", - "status": "pending_anchor", - "message": "KYC is being verified" - } -} -``` - - - ##### Ready to Receive Funds After KYC is collected, you should be ready to receive the off-chain deposit. While you're waiting for the user to deliver funds, you'll want to provide an updated transaction status as well as basic transaction information. @@ -625,6 +609,8 @@ Asset field is optional. When not set, it defaults to the asset user requested. This step is optional. Most business don't use it: you can skip it and go to the [next one](#sending-stellar-transaction) +You should only use this status if the off-chain payment method being used notifies you of a pending inbound payment. + ::: After update in the previous chapter has been made, user will be notified that your service is ready to receive funds. In real world, transfer confirmation may take time. In such cases, transaction should be set to a new status, after funds have been received, but not confirmed yet.