Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for V3 #248

Merged
merged 2 commits into from
Sep 30, 2024
Merged

Add documentation for V3 #248

merged 2 commits into from
Sep 30, 2024

Conversation

tir38
Copy link
Collaborator

@tir38 tir38 commented Sep 19, 2024

This is documentation for V3 and V3 for Cash App Pay.

Copy link
Collaborator

@BrianGardnerAtl BrianGardnerAtl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. The setup instructions were clear. Not sure if we'd want to more strongly recommend folks go with a V3 implementation so there's no server communication required

@tir38
Copy link
Collaborator Author

tir38 commented Sep 24, 2024

Looks good to me. The setup instructions were clear. Not sure if we'd want to more strongly recommend folks go with a V3 implementation so there's no server communication required

Confusingly the V in V3 is not "version". V3 is not an upgrade over the other "variations". All three are different ways to use Afterpay SDK.

@tir38 tir38 force-pushed the jatwood/update-v3-documentation branch 2 times, most recently from d6c75f7 to 3ae7392 Compare September 27, 2024 19:35
{: .alert }
> Checkout V3 is currently available in the following region(s): US, UK, Australia and Canada
>
Checkout V3 generates a one-time payment card for every Afterpay order and provides the card number to insert into your credit card checkout. This allows for a front-end-only integration. Unlike V1 and V2, with V3 your server does not directly interact with Afterpay APIs. The one-time payment card is Visa for the US, UK, and Canada. In Australia the one-time payment card is Mastercard.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is added to the alert section, I think we can leave it as plain text

@@ -1,11 +1,11 @@
---
layout: default
title: Cash App Pay
title: Checkout V2 with Cash App Pay
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On iOS this is just Cash App Pay

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to distinguish v2 and v3 each with cash app pay

layout: default
title: Checkout V3 with Cash App Pay
parent: Getting Started
nav_order: 7
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On iOS this is before Cash App Pay

}
```

## Step 4: Receive one-time use card details and pass back to your server for processing
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think you need to pass these back to your server, you can drop these into any checkout form

it.cardDetails
it.tokens
it.cardValidUntil
```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the SDK supports updateMerchantReferenceV3 we should add an entry

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add this to my TODO

nav_order: 5
---

# Checkout V3
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

iOS has a Sequence Diagram, you can probably use the same one

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it on purpose. I think is not accurate and a bit confusing.

}
```

## Step 11: Receive one-time use card details and pass back to your server for processing
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to send details back to server

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they need to do something with those card details right?

``` kotlin
cashAppPay.unregisterFromStateUpdates()
```

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can include the sequence diagram here

@tir38 tir38 force-pushed the jatwood/update-v3-documentation branch from 3ae7392 to adc206f Compare September 30, 2024 16:10
@tir38 tir38 force-pushed the jatwood/update-v3-documentation branch from adc206f to 94baa97 Compare September 30, 2024 16:48
@tir38 tir38 merged commit 9677581 into master Sep 30, 2024
3 checks passed
@tir38 tir38 deleted the jatwood/update-v3-documentation branch September 30, 2024 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants