Skip to content

Commit

Permalink
Update docs/guides/Integration-Guides/payments-integration-guide/paym…
Browse files Browse the repository at this point in the history 
…ents-integration-payment-provider-framework.md

Co-authored-by: Júlia Rabello <[email protected]>
  • Loading branch information
@ricardoaerobr @julia-rabello
ricardoaerobr and julia-rabello authored Oct 30, 2023
1 parent 554bcef commit 442f12d
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions ...s/payments-integration-guide/payments-integration-payment-provider-framework.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,19 +177,19 @@ You can also omit the `handler` and `headers` parameters, by doing it you will n

Along with manifest fields (`paymentMethods` and `customFields`) there are the following configurable options.

| Parameter name | Required | Default | Description |
| ------------------------------ | -------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Yes | | Name of connector. |
| `serviceUrl` | Yes | Auto-generated for IO connectors. | A valid URL (can include relative paths). |
| `implementsOAuth` | No | `false` | Decides if the provider implements or not the configuration flow supporting OAuth authentication. |
| `implementsSplit` | No | `false` | Decides if the provider implements or not the split flow. |
| `usesProviderHeadersName` | No | `true` | Decides if the provider will receive appKey and appToken headers as `"x-provider-api-appKey"` and `"x-provider-api-appToken"` respectively. |
| `useAntifraud` | No | `false` | Decides if the provider can or cannot be used along antifraud providers. |
| `usesBankInvoiceEnglishName` | No | `false` | Decides if the Bank Invoice payment method will use the English name, if `true`, or the Brazilian name (Boleto Bancário), if `false`. |
| `usesSecureProxy` | No | `true` | If `true`, the provider can process payment without being PCI-Certified, the connector will receive a `secureProxyUrl` on `createPayment flow`, and the card encrypted data. If `false`, the provider must be a PCI-Certified entity, and you should send the AOC containing the provided `serviceUrl`. |
| `requiresDocument` | No | `false` | If `true`, the customer must include the cardholder document on Checkout. A new field will appear on the Checkout form. If `false`, the customer does not need to include a cardholder document. |
| `acceptSplitPartialRefund` | No | `false` | If `true`, a partial refund will be sent when a payment split occurs. If `false`, the connector couldn't process a partial refund when a payment split occurs. |
| `usesAutoSettleOptions` | No | `false` | If `true`, the client will be able to choose the behavior of the auto settlement in the VTEX admin configurations of the provider. The options available are the following: Use behavior recommended by the payment processor, Automatic capture immediately after payment authorization, Automatic capture immediately after anti-fraud analysis, Deactivated: Not automatically captured. If `false`, the connector won't have this dropdown configuration field for auto settlement. More information can be found in the [Custom Auto Capture Feature article](https://developers.vtex.com/docs/guides/custom-auto-capture-feature). |
| Parameter name | Required | Default | Description |
| - | - | - | - |
| `name` | Yes | | Name of connector. |
| `serviceUrl` | Yes | Auto-generated for IO connectors. | A valid URL (can include relative paths). |
| `implementsOAuth` | No | `false` | Defines if the provider implements or not the configuration flow supporting OAuth authentication. |
| `implementsSplit` | No | `false` | Defines if the provider implements or not the split flow. |
| `usesProviderHeadersName` | No | `true` | Defines if the provider will receive appKey and appToken headers as `"x-provider-api-appKey"` and `"x-provider-api-appToken"` respectively. |
| `useAntifraud` | No | `false` | Defines if the provider can or cannot be used along antifraud providers. |
| `usesBankInvoiceEnglishName` | No | `false` | Defines if the Bank Invoice payment method will use the English name, if `true`, or the Brazilian name (Boleto Bancário), if `false`. |
| `usesSecureProxy` | No | `true` | If `true`, the provider can process payment without being PCI-Certified, the connector will receive a `secureProxyUrl` on `createPayment flow`, and the card encrypted data. If `false`, the provider must be a PCI-Certified entity, and you should send the AOC containing the provided `serviceUrl`. |
| `requiresDocument` | No | `false` | If `true`, the customer must include the cardholder document on Checkout. A new field will appear on the Checkout form. If `false`, the customer does not need to include a cardholder document. |
| `acceptSplitPartialRefund` | No | `false` | If `true`, a partial refund will be sent when a payment split occurs. If `false`, the connector couldn't process a partial refund when a payment split occurs. |
| `usesAutoSettleOptions` | No | `false` | If `true`, the client will be able to choose the behavior of the auto settlement in the VTEX admin configurations of the provider. The options available are the following: Use behavior recommended by the payment processor, Automatic capture immediately after payment authorization, Automatic capture immediately after anti-fraud analysis, Deactivated: Not automatically captured. If `false`, the connector won't have this dropdown configuration field for auto settlement. More information can be found in the [Custom Auto Capture Feature article](https://developers.vtex.com/docs/guides/custom-auto-capture-feature). |

### Request a retry from Payment Gateway

Expand Down

0 comments on commit 442f12d

Please sign in to comment.