Skip to content

Update readme #92

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

Merged
flor-master merged 1 commit into from
Jan 12, 2026
Merged

Update readme #92

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
22 changes: 19 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export default App;
| vaultId | A string value beginning with the prefix `tnt`. | [Parameters.vaultId](https://www.verygoodsecurity.com/docs/api/collect/#api-vgscollectcreate) |
| environment | Vault environment: `sanbdox` \| `live` or region specific. | [Parameters.environment](https://www.verygoodsecurity.com/docs/api/collect/#api-vgscollectcreate) |
| action | Endpoint for the HTTP request. | [Parameters.path](https://www.verygoodsecurity.com/docs/api/collect/#api-formsubmit) |
| submitParamethers? | HTTP request configuration. | [Parameters.options](https://www.verygoodsecurity.com/docs/api/collect/#api-formsubmit) |
| submitParameters? | HTTP request configuration. | [Parameters.options](https://www.verygoodsecurity.com/docs/api/collect/#api-formsubmit) |
| onUpdateCallback? | Returns the form state in the callback. | [Parameters.stateCallback](https://www.verygoodsecurity.com/docs/api/collect/#api-vgscollectcreate) |
| onSubmitCallback? | Returns status and response data in the callback. | [Parameters.responseCallback](https://www.verygoodsecurity.com/docs/api/collect/#api-formsubmit) |
| cname? | String represents CNAME the request will be submitted to. | [.useCNAME()](https://www.verygoodsecurity.com/docs/api/collect/#api-formusecname) |
Expand Down Expand Up @@ -226,6 +226,8 @@ const VGSCollectSecureForm = () => {

You can create a predefined Collect.js form to integrate with the [VGS Card Management Platform](https://docs.verygoodsecurity.com/card-management/api)

Minimum CollectJS version: 3.2.2

```javascript
import { VGSCollectForm } from '@vgs/collect-js-react';

Expand All @@ -239,9 +241,23 @@ const myApp = () => {
<VGSCollectForm
vaultId='<vault_id>'
environment='<environment>'
submitParamethers={{
submitParameters={{
createCard: {
auth: <vgs_auth_token>
auth: <vgs_auth_token>,
data: { // optional parameters
cardholder: {
address: {
address1: '123 Main St',
address2: 'Suite 456',
address3: 'Line 3',
address4: 'Line 4',
city: 'LA',
region: 'CA',
postal_code: '12345',
country: 'USA'
}
}
}
}
}}
onUpdateCallback={onUpdateCallback}
Expand Down