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

refactor: add preferAuthorize intent to the README #256

Merged
merged 1 commit into from
Dec 2, 2024
Merged

refactor: add preferAuthorize intent to the README #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/embed-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The options for this integration are as follows.
| `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 |
| `gr4vyId` | `null` | **Often required** Gr4vy ID automatically sets the `apiHost` to `api.<gr4vyId>.gr4vy.app` and `iframeHost` to `embed.<gr4vyId>.gr4vy.app`. |
| `iframeHost` | `null` | **Sometimes required** - The host (both hostname and port) of the server that hosts the Gr4vy payment form. Can be omitted when using the `gr4vyId` option. |
| `intent` | `authorize` | `authorize`, `capture` - Defines the intent of this API call. This determines the desired initial state of the transaction. |
| `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. |
Expand Down
2 changes: 1 addition & 1 deletion packages/embed/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The options for this integration are as follows.
| `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 |
| `gr4vyId` | `null` | **Often required** Gr4vy ID automatically sets the `apiHost` to `api.<gr4vyId>.gr4vy.app` and `iframeHost` to `embed.<gr4vyId>.gr4vy.app` for production and `api.sandbox.<gr4vyId>.gr4vy.app` and `iframeHost` to `embed.sandbox.<gr4vyId>.gr4vy.app` for the sandbox environment. |
| `iframeHost` | `null` | **Sometimes required** - The host (both hostname and port) of the server that hosts the Gr4vy payment form. Can be omitted when using the `gr4vyId` option. |
| `intent` | `authorize` | `authorize`, `capture` - Defines the intent of this API call. This determines the desired initial state of the transaction. |
| `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. |
Expand Down
Loading