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.

Sign up for GitHub

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

chore: add the preselect store option to readme #276

Merged
merged 2 commits into from
Feb 12, 2025
Merged

chore: add the preselect store option to readme #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c50ff0c
chore: add the preselect store option to readme
brunodesde1987 Jan 30, 2025
c1650ff
Merge branch 'main' into ta-9594-add-preselect-to-readme
brunodesde1987 Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/embed-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The options for this integration are as follows.
| `apiHost` | `null` | **Sometimes required** - The host (both hostname and port) of the Gr4vy API server to use. Can be omitted when using the `gr4vyId` option. |
| `buyerExternalIdentifier` | `null` | An optional external ID for a Gr4vy buyer. The transaction will automatically be associated to a buyer with that external ID. If no buyer with this external ID exists then it will be ignored. This option is ignored if the `buyerId` is provided. |
| `buyerId` | `null` | An optional ID for a Gr4vy buyer. The transaction will automatically be associated to a buyer with that ID. If no buyer with this ID exists then it will be ignored. |
| `buyer` | `null` | An optional object to represent the buyer (personal details, billing details, and shipping information). |
| `buyer` | `null` | An optional object to represent the buyer (personal details, billing details, and shipping information). |
| `country` | `null` | **Required** A valid `ISO 3166` country code. |
| `currency` | `null` | **Required** A valid, active, 3-character `ISO 4217` currency code to authorize or capture the `amount` for. |
| `externalIdentifier` | `null` | An optional external identifier that can be supplied. This will automatically be associated to any resource created by Gr4vy and can subsequently be used to find a resource by that ID |
Expand All @@ -69,7 +69,7 @@ The options for this integration are as follows.
| `intent` | `authorize` | `authorize`, `preferAuthorize`, `capture` - Defines the intent of this API call. This determines the desired initial state of the transaction. When used, `preferAuthorize` automatically switches to `capture` if the selected payment method doesn't support delayed capture. |
| `locale` | `en` | An optional locale, this consists of a `ISO 639 Language Code` followed by an optional `ISO 3166 Country Code`, e.g. `en`, `en-gb` or `pt-br`. |
| `onEvent` | `null` | An optional event handler to bind to the form. This is called for various events, more on that below. |
| `store` | `ask` | `'ask'`, `true`, `false` - Explicitly store the payment method or ask the buyer, this is used when a buyerId or buyerExternalIdentifier is provided. |
| `store` | `ask` | `'ask'`, `'preselect'`, `true`, `false` - Explicitly store the payment method, ask the buyer or preselect it by default. Requires `buyerId` or `buyerExternalIdentifier`. |
| `theme` | `null` | Theme customisation options (See Theming) |
| `token` | `null` | **Required** - The server-side generated JWT token used to authenticate any of the API calls. |
| `onComplete` | `null` | Callback with a transaction object. (Form submission must be handled manually) |
Expand Down
Loading
Loading