Skip to content

Update docs #128

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update docs #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
586873a
Remove Authorize and Sandbox as they are no longer valid
mikemotteram Mar 15, 2023
ff8695a
Update Json labels to be correct case
mikemotteram Mar 17, 2023
a49649d
Update Schedules to start from 1 as they are zero indexed
mikemotteram Mar 24, 2023
e82f445
Update Kount field descriptions
mikemotteram Mar 29, 2023
d271626
Update Kount field descriptions
mikemotteram Apr 13, 2023
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
142 changes: 85 additions & 57 deletions docs/connectors/connector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,14 @@ Here are the configuration options for each of the connectors for the Payment Pr

#### Payment Providers

- [Authorize.net](#authorizenet)
[//]: # (- [Authorize.net](#authorizenet))
- [Braintree](#braintree)
- [PayPal Express Checkout](#paypal---express-checkout)
- [PayPal Website Payments Pro](#paypal---website-payments-pro)
- [Paysafe](#paysafe)
- [Qualpay](#qualpay)
- [Sandbox](#sandbox)

[//]: # (- [Sandbox](#sandbox))
- [Stripe](#stripe)
- [Vindicia](#vindicia)
- [Checkout](#checkout)
Expand All @@ -78,24 +79,38 @@ Here are the configuration options for each of the connectors for the Payment Pr

---

### Authorize.net
[//]: # ()
[//]: # (### Authorize.net)

Library: `authorize`
Configuration:
[//]: # ()
[//]: # (Library: `authorize` )

```json
{
"APILoginID": "xxxxxxxxxxxx",
"TransactionKey": "xxxxxxxxxxxx",
"Environment": "xxxxxxxxxxxx"
}
```
[//]: # (Configuration:)

[//]: # ()
[//]: # (```json )

[//]: # ({)

[//]: # ( "APILoginID": "xxxxxxxxxxxx",)

[//]: # ( "TransactionKey": "xxxxxxxxxxxx",)

[//]: # ( "Environment": "xxxxxxxxxxxx")

[//]: # (} )

[//]: # (``` )
[//]: # ()
[//]: # (| FieldName | Definition | )

[//]: # (|---------------:|:--------------------------------------------------------------------------------------------------------|)

[//]: # (| APILoginID | The Api Login ID from your Authorize.net account found in Account -> API Credentials & Keys |)

| FieldName | Definition |
|---------------:|:--------------------------------------------------------------------------------------------------------|
| APILoginID | The Api Login ID from your Authorize.net account found in Account -> API Credentials & Keys |
| TransactionKey | The Transaction Key obtained from your Authorize.net account found in Account -> API Credentials & Keys |
| Environment | Must be either "sandbox" or "production" |
[//]: # (| TransactionKey | The Transaction Key obtained from your Authorize.net account found in Account -> API Credentials & Keys |)

[//]: # (| Environment | Must be either "sandbox" or "production" |)

### Braintree

Expand Down Expand Up @@ -206,7 +221,8 @@ Configuration:
"Currency": "USD",
"UseVault": "false",
"SingleUseTokenUsername": "xxxxxxxxxxxx",
"SingleUseTokenPassword": "xxxxxxxxxxxx"
"SingleUseTokenPassword": "xxxxxxxxxxxx",
"merchantURL":"xxxxxxxxxxxx"
}
```

Expand All @@ -215,17 +231,18 @@ Configuration:
-----------------------:|:---
Acquirer | The Acquirer bank setup for this merchant account (optional, if you are not using a defined acquirer this can
be left blank)
AccountID | The AccountID for this merchant account
APIUsername | The API Username from your merchant account in your account settings API page
APIPassword | The API Password from your merchant account in your account settings API page
AccountID | The AccountID for this merchant account (10 digit numeric ID)
APIUsername | The API Public Key Username from your merchant account in your account settings API keys page
APIPassword | The API Public Key Password from your merchant account in your account settings API keys page
Environment | Must be "MOCK", "TEST" or "LIVE"
Country | Optional string field for country. Must be in two character country format (e.g. ["US", "DE", "FR"])
Currency | The currency setup for this merchant account, in standard three character format (e.g. ["GBP", "USD", "EUR"])
UseVault | Boolean field can be set to "true" or "false"
SingleUseTokenUsername | The Single Use Token Username in your account settings API page. If this is entered the
UseVault | Boolean field can be set to "true" or "false" - Vault is Paysafe's customer Vault for tokenizing Payment Methods. Payment methods are already Tokenized in Chargehive so this should be set to 'false'
SingleUseTokenUsername | The Single Use Token (Public Key) Username in your account settings API Keys page. If this is entered the
Password must be entered as well
SingleUseTokenPassword | The Single Use Token Password in your account settings API page. If this is entered the
SingleUseTokenPassword | The Single Use Token (Public Key) Password in your account settings API Keys page. If this is entered the
Username must be entered as well
Merchant URL | The url your Order Form is hosted on

### QualPay

Expand All @@ -234,35 +251,46 @@ Configuration:

```json
{
"APIKey": "xxxxxxxxxxxx",
"MerchantID": "int64",
"Environment": "test"
"apiKey": "xxxxxxxxxxxx",
"merchantID": "int64",
"environment": "test"
}
```

| FieldName | Definition |
|------------:|:---------------------------------------------------------------------|
| APIKey | Your Qualpay API Key from your Qualpay account administration |
| MerchantID | This is your Qualpay Merchant ID. It must be a 64 character integer. |
| Environment | Must be "test" or "live" |
| FieldName | Definition |
|------------:|:-----------------------------------------------------------------------------------------------|
| APIKey | Your Qualpay API Key from your Qualpay account Administration -> Security -> API Security Keys |
| MerchantID | This is your Qualpay Merchant ID. It must be a 64 character integer. It can be found in account Administration -> Security -> API Security Keys |
| Environment | Must be "test" or "live" |

### SandBox
[//]: # (### SandBox)

Library: `sandbox`
Configuration:
[//]: # ()
[//]: # (Library: `sandbox` )

```json
{
"Mode": "dynamic",
"TransactionIDPrefix": "xxxxxxxxxxxx"
}
```
[//]: # (Configuration:)

FieldName | Definition
[//]: # ()
[//]: # (```json )

--------------------:|:---
Mode | Must be "dynamic", "offline", "delayed", "random-timeout" or "chaos"
TransactionIDPrefix | Prepends transactions with this prefix
[//]: # ({)

[//]: # ( "Mode": "dynamic",)

[//]: # ( "TransactionIDPrefix": "xxxxxxxxxxxx")

[//]: # (} )

[//]: # (``` )
[//]: # ()
[//]: # ( FieldName | Definition )

[//]: # ()
[//]: # (--------------------:|:--- )

[//]: # (Mode | Must be "dynamic", "offline", "delayed", "random-timeout" or "chaos" )

[//]: # (TransactionIDPrefix | Prepends transactions with this prefix)

### Stripe

Expand Down Expand Up @@ -324,12 +352,12 @@ Configuration:
FieldName | Definition

-----------------------:|:---
publicKey | The Public Key of this account. This can be found in settings page of Hub
secretKey | The Secret Key of this account. This can be found in settings page of Hub
publicKey | The Public Key of this account. This can be found in Developers -> Keys -> API Keys
secretKey | The Secret Key of this account. This can be found in Developers -> Keys -> API Keys
currency | The currency to process with this account
environment | Must be "sandbox" or "production"
signatureKey | Obtained from Checkout dashboard Notification configuration
authorizationHeaderKey | Obtained from Checkout dashboard Notification configuration
signatureKey | This can be found in Developers -> Keys -> Access Keys (Key Value)
authorizationHeaderKey | This can be found in Developers -> Keys -> Access Keys (Key ID)
platform | must be `default` or `previous`

---
Expand All @@ -339,7 +367,7 @@ platform | must be `default` or `previous`
Library: `worldpay`
Configuration:

```json
```json
{
"Username": "xxxxxxxxxxxx",
"Password": "xxxxxxxxxxxx",
Expand Down Expand Up @@ -396,7 +424,7 @@ Configuration:

---------------:|:---
MerchantID | The Merchant ID on your Cybersource Account
TransactionKey | The Transaction Key generated in Cybersource on Payment Configuration -> Key Management
TransactionKey | Generate a new REST API Key in Cybersource account Payment Configuration -> Key Management. The Secret Key is the Transaction Key needed here.
Environment | Must be either "test" or "live"

### Kount
Expand All @@ -419,12 +447,12 @@ Configuration:
FieldName | Definition

----------------------:|:---
siteID | The site ID on your Kount Account
merchantID | The Merchant Id of your Kount Account
configKey | The configuration key defined within your Kount account
apiKey | The API key defined in your Kount account
dataCollectorURL | The Kount data collection URL and will be test or a production URL depending on the environment
riskInquiryServiceURL | The Kount risk inquiry URL and will be test or a production URL depending on the environment
siteID | The site ID for your Kount Account - this will be given to you by Kount
merchantID | The Merchant Id for your Kount Account - this will be given to you by Kount
configKey | The configuration key for your Kount account - this will be given to you by Kount
apiKey | The API key for your Kount account -> Admin -> API Keys, create a new Key.
dataCollectorURL | The Kount data collection URL and will be test or a production URL depending on the environment. Kount will provide this.
riskInquiryServiceURL | The Kount risk inquiry URL and will be test or a production URL depending on the environment. Kount will provide this.
environment | Must be either "test" or "production"

### MaxMind
Expand Down
2 changes: 1 addition & 1 deletion docs/policy/fraud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Fraud Policy
The fraud policy defines
The fraud policy allows a Fraud service to be used for charges to get back a recommendtaion of the likelihood of Fraud within each transaction.

## Format
As with all configs, the standard wrapper is used.
Expand Down
14 changes: 1 addition & 13 deletions docs/scheduler/sequential.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Sequential Scheduler

The sequential scheduler allows for a sequence or schedule of connectors to be used when attempting to complete a charge.
They are mapped by attempt number.
They are mapped by attempt number and are zero indexed, so the first attempt should have an index of 1.

## Format
As with all configs, the standard wrapper is used.
Expand Down Expand Up @@ -105,18 +105,6 @@ Value| Definition
},
"spec": {
"schedules": {
"0": {
"attemptConfig": {
"poolType": "cascade",
"methodSelector": "primary",
"connectorLimit": 0,
"methodLimit": 0,
"cascadeDelay": null,
"overridePoolConnectorIDs": [
"sandbox-connector"
]
}
},
"1": {
"attemptConfig": {
"poolType": "cascade",
Expand Down