Skip to content

Commit 9120e58

Browse files
chore: add the preselect store option to readme (#276)
1 parent f56ab3c commit 9120e58

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

packages/embed-react/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The options for this integration are as follows.
6060
| `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. |
6161
| `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. |
6262
| `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. |
63-
| `buyer` | `null` | An optional object to represent the buyer (personal details, billing details, and shipping information). |
63+
| `buyer` | `null` | An optional object to represent the buyer (personal details, billing details, and shipping information). |
6464
| `country` | `null` | **Required** A valid `ISO 3166` country code. |
6565
| `currency` | `null` | **Required** A valid, active, 3-character `ISO 4217` currency code to authorize or capture the `amount` for. |
6666
| `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 |
@@ -69,7 +69,7 @@ The options for this integration are as follows.
6969
| `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. |
7070
| `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`. |
7171
| `onEvent` | `null` | An optional event handler to bind to the form. This is called for various events, more on that below. |
72-
| `store` | `ask` | `'ask'`, `true`, `false` - Explicitly store the payment method or ask the buyer, this is used when a buyerId or buyerExternalIdentifier is provided. |
72+
| `store` | `ask` | `'ask'`, `'preselect'`, `true`, `false` - Explicitly store the payment method, ask the buyer or preselect it by default. Requires `buyerId` or `buyerExternalIdentifier`. |
7373
| `theme` | `null` | Theme customisation options (See Theming) |
7474
| `token` | `null` | **Required** - The server-side generated JWT token used to authenticate any of the API calls. |
7575
| `onComplete` | `null` | Callback with a transaction object. (Form submission must be handled manually) |

0 commit comments

Comments
 (0)