diff --git a/docs/api/main.md b/docs/api/main.md index 0a8a2e4..7037535 100644 --- a/docs/api/main.md +++ b/docs/api/main.md @@ -106,12 +106,10 @@ This key should be stored securely and not shared with anyone. It should be used ## POST GraphQL Query -Queries are then executed by sending POST HTTP requests to the endpoint: - -***POST `https://api.PARTNER_NAME.STAGE.com/graphql`*** +Queries are then executed by sending POST HTTP requests to the endpoint. You can find the API endpoint in the Pay Theory Portal under the Settings tab. ```commandline -curl --location --request POST 'https://api.PARTNER_NAME.STAGE.com/graphql' +curl --location --request POST '{GraphQL API URL}' --header 'Authorization: MERCHANT_UID;SECRET_KEY' --header 'Content-Type: application/graphql' --data '{"query":"{transactions(limit: 3) { items { transaction_id }}}"}' diff --git a/docs/api/payment_links.md b/docs/api/payment_links.md index 6b4f159..4466337 100644 --- a/docs/api/payment_links.md +++ b/docs/api/payment_links.md @@ -2,6 +2,7 @@ sidebar_position: 14 sidebar_label: 'Payment Links' title: "Payment Links" +description: "Payment Links are a used to create a checkout page without having to write any code. You can create a payment link and send it to your customers to pay for your products or services." --- # Payment Links @@ -34,28 +35,28 @@ Payment links are a used to create a checkout page without having to write any c require_phone: Boolean } ``` -|Key | type | description | -|-------------------|-----------------------------------------------------------|---------------------------------------| -|accepted_payment_methods| [AcceptedPaymentMethodsEnum](#acceptedpaymentmethodsenum) |The payment methods that will be available to a payor when making a payment.| -|account_code | String |Account Code that will be passed in to every transaction made with this payment link.| -|amount | Int |The amount of the payment that the payor will be asked to pay or if `amount_is_variable` is set to the amount that will be the default amount.| -|amount_is_variable | Boolean |If set to `true` the payor will be able to enter the amount they want to pay.| -|call_to_action | [CallToActionType](#calltoactiontype) |The call to action that will be displayed on the button at the time of checkout.| -|created_date | AWSDateTime |The date and time the payment link was created.| -|currency | String |The type of currency for the payment.| -|custom_success_message| String |The message that will be displayed to the payor after a successful payment.| -|fee_mode | FeeMode |The fee mode of the payments that will be made with the payment link.| -|is_active | Boolean |If set to `true` the payment link will be active and available to payors. If set to `false` the payment link will not be available to payors.| -|link_id | String |The unique id of the payment link.| -|link_name | String |The name you give to the payment link for internal tracking purposes.| -|link_url | String |The url of the payment link.| -|max_amount | Int |The maximum amount the payor can pay if `amount_is_variable` is set to `true`.| -|merchant_uid | String |The Pay Theory unique identifier assigned to the merchant that the transaction belongs to.| -|min_amount | Int |The minimum amount the payor can pay if `amount_is_variable` is set to `true`.| -|payment_name | String |The name of the payment that will be displayed to the customer. This will be passed in as the `reference` at the time of the transaction.| -|payment_description| String |The description of the payment that will be displayed to the customer.| -|redirect_url | String |The url that the payor will be redirected to after a successful payment.| -|require_phone | Boolean |If set to `true` the payor will be required to enter their phone number before making the payment.| +| Key | type | description | +|--------------------------|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| accepted_payment_methods | [AcceptedPaymentMethodsEnum](#acceptedpaymentmethodsenum) | The payment methods that will be available to a payor when making a payment. | +| account_code | String | Account Code that will be passed in to every transaction made with this payment link. | +| amount | Int | The amount of the payment that the payor will be asked to pay or if `amount_is_variable` is set to the amount that will be the default amount. | +| amount_is_variable | Boolean | If set to `true` the payor will be able to enter the amount they want to pay. | +| call_to_action | [CallToActionType](#calltoactiontype) | The call to action that will be displayed on the button at the time of checkout. | +| created_date | AWSDateTime | The date and time the payment link was created. | +| currency | String | The type of currency for the payment. | +| custom_success_message | String | The message that will be displayed to the payor after a successful payment. | +| fee_mode | FeeMode | The fee mode of the payments that will be made with the payment link. | +| is_active | Boolean | If set to `true` the payment link will be active and available to payors. If set to `false` the payment link will not be available to payors. | +| link_id | String | The unique id of the payment link. | +| link_name | String | The name you give to the payment link for internal tracking purposes. | +| link_url | String | The url of the payment link. | +| max_amount | Int | The maximum amount the payor can pay if `amount_is_variable` is set to `true`. | +| merchant_uid | String | The Pay Theory unique identifier assigned to the merchant that the transaction belongs to. | +| min_amount | Int | The minimum amount the payor can pay if `amount_is_variable` is set to `true`. | +| payment_name | String | The name of the payment that will be displayed to the customer. This will be passed in as the `reference` at the time of the transaction. | +| payment_description | String | The description of the payment that will be displayed to the customer. | +| redirect_url | String | The url that the payor will be redirected to after a successful payment. | +| require_phone | Boolean | If set to `true` the payor will be required to enter their phone number before making the payment. | *** ### AcceptedPaymentMethodsEnum @@ -138,10 +139,10 @@ The call to action that will be displayed on the button at the time of checkout. } } ``` -|Key |type | description | -|-------------------|-------------|---------------------------------------| -|items |[PaymentLink] |The list of payment links that are returned from the query.| -|total_row_count |Int |The total number of payment links that match the query. Used to help with pagination.| +| Key | type | description | +|-----------------|---------------|---------------------------------------------------------------------------------------| +| items | [PaymentLink] | The list of payment links that are returned from the query. | +| total_row_count | Int | The total number of payment links that match the query. Used to help with pagination. | *** ## Create a Payment Link @@ -191,29 +192,31 @@ mutation { ``` **Parameters** -|Key |type | description | -|-------------------|-------------|---------------------------------------| -|input |PaymentLinkInput|This object contains all the details needed to create a payment link.| + +| Key | type | description | +|-------|------------------|-----------------------------------------------------------------------| +| input | PaymentLinkInput | This object contains all the details needed to create a payment link. | **PaymentLinkInput** -|Key | type | description | -|-------------------|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -|accepted_payment_methods| [AcceptedPaymentMethodsEnum](#acceptedpaymentmethodsenum) | The payment methods that will be available to a payor when making a payment. | -|account_code | String | Account Code that will be passed in to every transaction made with this payment link. | -|amount | Int! | The amount of the payment that the payor will be asked to pay or if `amount_is_variable` is set to the amount that will be the default amount. | -|amount_is_variable | Boolean | If set to `true` the payor will be able to enter the amount they want to pay. | -|call_to_action | [CallToActionType](#calltoactiontype) | The call to action that will be displayed on the button at the time of checkout. | -|currency | String | The currency of the payment. | -|custom_success_message| String | The message that will be displayed to the payor after they have successfully paid. | -|fee_mode | FeeMode | The fee mode of the payments that will be made with the payment link. | -|link_name | String! | The name you give to the payment link for internal tracking purposes. | -|max_amount | Int | The maximum amount the payor can pay if `amount_is_variable` is set to `true`. | -|merchant_uid | String! | The merchant uid of the merchant that will be creating the payment link. | -|min_amount | Int | The minimum amount the payor can pay if `amount_is_variable` is set to `true`. | -|payment_description| String | The description of the payment that will be displayed to the customer. | -|payment_name | String! | The name of the payment that will be displayed to the customer. This will be passed in as the `reference` at the time of the transaction. | -|redirect_url | String | The url that the payor will be redirected to after they have successfully paid. | -|require_phone | Boolean | If set to `true` the payor will be required to enter their phone number before making the payment. | + +| Key | type | description | +|--------------------------|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| accepted_payment_methods | [AcceptedPaymentMethodsEnum](#acceptedpaymentmethodsenum) | The payment methods that will be available to a payor when making a payment. | +| account_code | String | Account Code that will be passed in to every transaction made with this payment link. | +| amount | Int! | The amount of the payment that the payor will be asked to pay or if `amount_is_variable` is set to the amount that will be the default amount. | +| amount_is_variable | Boolean | If set to `true` the payor will be able to enter the amount they want to pay. | +| call_to_action | [CallToActionType](#calltoactiontype) | The call to action that will be displayed on the button at the time of checkout. | +| currency | String | The currency of the payment. | +| custom_success_message | String | The message that will be displayed to the payor after they have successfully paid. | +| fee_mode | FeeMode | The fee mode of the payments that will be made with the payment link. | +| link_name | String! | The name you give to the payment link for internal tracking purposes. | +| max_amount | Int | The maximum amount the payor can pay if `amount_is_variable` is set to `true`. | +| merchant_uid | String! | The merchant uid of the merchant that will be creating the payment link. | +| min_amount | Int | The minimum amount the payor can pay if `amount_is_variable` is set to `true`. | +| payment_description | String | The description of the payment that will be displayed to the customer. | +| payment_name | String! | The name of the payment that will be displayed to the customer. This will be passed in as the `reference` at the time of the transaction. | +| redirect_url | String | The url that the payor will be redirected to after they have successfully paid. | +| require_phone | Boolean | If set to `true` the payor will be required to enter their phone number before making the payment. | diff --git a/docs/main/getting_started/quickstart.mdx b/docs/main/getting_started/quickstart.mdx index 9b71f48..db6109a 100644 --- a/docs/main/getting_started/quickstart.mdx +++ b/docs/main/getting_started/quickstart.mdx @@ -30,8 +30,10 @@ You will need access to your Pay Theory Sandbox. If you do not have a sandbox ac ## 1. Importing the SDK In order to import your SDK, you will need to copy and paste your Import URL into the header of your code editor. +The SDK URL can be found in the Pay Theory portal under the settings tab as the SDK Import URL. + ``` - + ``` *** diff --git a/docs/main/online_payments/ach_payments.mdx b/docs/main/online_payments/ach_payments.mdx index 283a7f6..74964f9 100644 --- a/docs/main/online_payments/ach_payments.mdx +++ b/docs/main/online_payments/ach_payments.mdx @@ -31,8 +31,11 @@ You will need access to your Pay Theory Sandbox. If you do not have a sandbox ac ## 1. Importing the SDK In order to import your SDK, you will need to copy and paste your Import URL into the header of your code editor. +The SDK URL can be found in the Pay Theory portal under the settings tab as the SDK Import URL. + + ``` - + ``` *** diff --git a/docs/main/online_payments/payment_button.mdx b/docs/main/online_payments/payment_button.mdx index 48a4c68..e57f445 100644 --- a/docs/main/online_payments/payment_button.mdx +++ b/docs/main/online_payments/payment_button.mdx @@ -15,16 +15,18 @@ This guide will walk you through the steps to create a payment button that will ## 1. Import the SDK You need to use the Pay Theory Web SDK. This is available by adding the below script into your web header. This button will open a hosted checkout page that will allow the user to select a payment method and complete the payment. -```jsx title="javascript" - +The SDK URL can be found in the Pay Theory portal under the settings tab as the SDK Import URL. + +``` + ``` *** ## 2. Add Pay Theory element to your Html This div is used to mount an iframe that will include a checkout button. You need to add the Pay Theory elements to your HTML. You can place these elements anywhere in your HTML and the SDK will place the button in the correct place. -```jsx title="javascript" -
+```html +
``` *** diff --git a/docs/main/recurring_payments/overview.mdx b/docs/main/recurring_payments/overview.mdx index 65ccced..579f3b5 100644 --- a/docs/main/recurring_payments/overview.mdx +++ b/docs/main/recurring_payments/overview.mdx @@ -16,7 +16,7 @@ Recurring payments are payments that get triggered on a specified interval. The :::danger Before you start You will need to be able to tokenize a payment in order to set up a recurring payment. -Tokenizing Quickstart +Tokenizing Quickstart ::: ## Payment plans diff --git a/docs/sdk/javascript/main.md b/docs/sdk/javascript/main.md index a1ba149..a64f509 100644 --- a/docs/sdk/javascript/main.md +++ b/docs/sdk/javascript/main.md @@ -14,8 +14,10 @@ Here is some steps to get you started with a basic implementation. To use the Pay Theory Web SDK, you need to add this script to your web header: +The SDK URL can be found in the Pay Theory portal under the settings tab as the SDK Import URL. + ```html - + ``` The SDK will be available on the window object as `paytheory`. diff --git a/home/Overview/CARD_PRESENT.md b/home/Overview/CARD_PRESENT.md deleted file mode 100644 index 32e55eb..0000000 --- a/home/Overview/CARD_PRESENT.md +++ /dev/null @@ -1,101 +0,0 @@ -# Card Present Quick Start - -This guide will walk you through the steps to activate a card present device to accept in person card payments with a device. - -If you are looking to accept card present payments with a device please reach out to [support@paytheory.com](mailto:support@paytheory.com) to get started. - -## Step 1: Find the Device ID - -You will need to know the device ID of the device you want to activate. You can find the device ID by querying the GraphQL API. - -```graphql -{ - devices(query: { query_list: [ - { - key: "merchant_uid", - value: "YOUR_MERCHANT_UID", - operator: EQUAL, - conjunctive_operator: AND_NEXT - }, - { - key: "device_description", - value: "DEVICE_DESCRIPTION", - operator: EQUAL - } - ] - }) { - items { - device_description - device_id - device_name - is_active - merchant_uid - } - } -} -``` - -## Step 2: Set Up Pay Theory Web SDK - -Once you have the device ID you need to set up the Pay Theory Web SDK. - -```javascript -let payTheory = window.paytheory - -payTheory.create("YOUR_API_KEY") - .then(ptObject => { - ptObject.mount() - - ptObject.cardPresentObserver(message => { - // Handle card present messages - }) - }) -``` - -You will need to call the `cardPresentObserver` function to handle messages from the card present iframe. - -## Step 3: Activate the Device - -Once you have received a `READY` message from the card present iframe you can activate the device to accept a payment. - -```javascript -//Amount passed in is in cents -const AMOUNT = 1000 - -// optionally provide details about the payor -const PAYOR_INFO = { - "first_name": "Some", - "last_name": "Body", - "email": "somebody@gmail.com", - "phone": "3335554444", - "personal_address": { - "city": "Somewhere", - "country": "USA", - "region": "OH", - "line1": "123 Street St", - "line2": "Apartment 17", - "postal_code": "12345" - } -} - -// Parameters that you will pass into the transact function. More details below. -const CARD_PRESENT_PARAMS = { - amount: AMOUNT, - deviceId: "pt_dev_XXXXXXXXX", // The device ID you received from the GraphQL query in Step 1 - payorInfo: PAYOR_INFO, // optional -} - -// Function is available on the ptObject returned from the create function in Step 2 -ptObject.activateCardPresentDevice(CARD_PRESENT_PARAMS) -``` - -## Step 4: Handle responses In the cardPresentObserver - -You should receive two responses after calling the `activateCardPresentDevice` function. - -The first response will be a `ACTIVATED` message. This will let you know that the device is ready to accept a payment. - -The second response will be a `COMPLETE` message. This will let you know that the device has completed the payment session, but it could be either a `SUCCEEDED` or `FAILURE` message. You will need to check the `status` field to see if the payment was successful. - - - diff --git a/home/Overview/CHECKOUT_BUTTON.md b/home/Overview/CHECKOUT_BUTTON.md deleted file mode 100644 index ba957ec..0000000 --- a/home/Overview/CHECKOUT_BUTTON.md +++ /dev/null @@ -1,100 +0,0 @@ -# Checkout Button Quick Start - -This guide will walk you through the steps to create a payment button to enable a PayTheory Hosted Checkout experience for your Payors. - -## Step 1: Import the SDK - -You need to use the Pay Theory Web SDK. This is available by adding this script to your web header: - -```html - -``` - -## Step 2: Add Pay Theory Element to your HTML - -You need to add the Pay Theory elements to your HTML. You can place this elements anywhere in your HTML and the SDK will place the button in the correct place. - -```html -
-``` - -## Step 3: Prepare the Checkout Details - -You need to put together the details of the checkout. This includes the amount, payment name, and any other details you want to pass to the checkout. - -```javascript -//Amount passed in is in cents -const AMOUNT = 1000 - -const PAYMENT_METADATA = { - "student-name": "Jane Doe" -}; - -// Parameters that you will pass in to configure the checkout page that opens when the button is clicked. -const CHECKOUT_DETAILS = { - amount: AMOUNT, - paymentName: "School Technology Fees", - paymentDescription: "Technology Fee for the 2019-2020 school year", - requirePhone: true, - callToAction: paytheory.DONATE, - acceptedPaymentMethods: paytheory.CARD_ONLY, - payorId: "pt_pay_XXXXXXXXX", - metadata: PAYMENT_METADATA, - feeMode: paytheory.MERCHANT_FEE, - accountCode: "code-123456789", - paymentParameters: "expires-in-30-days", - invoiceId: "pt_inv_XXXXXXXXX", - recurringId: "pt_rec_XXXXXXXXX", -} -``` - -Further details on the checkout details can be found in the [button](../web/functions#button) function details. - -## Step 4: Style the Button - -You can select styles for the button to match your website. - -```javascript -// Object that will style the payment button -const STYLE_OBJECT = { - color: paytheory.WHITE, - callToAction: paytheory.DONATE, - pill: true, - height: "48px" -} -``` - -Further details on the style object can be found in the [button](../web/functions#button) function details. - -## Step 5: Create functions to handle actions from the button - -You can create functions to handle the actions from the button. These include `onReady`, `onClick`, `onSuccess`, `onError`, and `onCancel`. - -```javascript -// Function that will be called when a payment is successful -const ON_SUCCESS = (response) => { - console.log("Payment Successful") - console.log(response) -} -``` - - -## Step 6: Create the Button - -You can create the button using the `button` function. Pass in the checkout details, style object, and functions to handle the actions. - -```javascript -// Create the button -paytheory.button({ - apiKey: "PT_API_KEY", - checkoutDetails: CHECKOUT_DETAILS, - style: STYLE_OBJECT, - onReady: ON_READY, - onClick: ON_CLICK, - onSuccess: ON_SUCCESS, - onError: ON_ERROR, - onCancel: ON_CANCEL -}) -``` - -The button session will only enable a single payment. If you want to enable multiple payments, you will need to clear the button from the DOM and create a new button. diff --git a/home/Overview/EMAIL_RECEIPTS.md b/home/Overview/EMAIL_RECEIPTS.md deleted file mode 100644 index 722682f..0000000 --- a/home/Overview/EMAIL_RECEIPTS.md +++ /dev/null @@ -1,46 +0,0 @@ -# Email Receipts - -Email receipts are available to be sent at the time of a payment and refund. - -## Payment Receipt - -There are two requirements for sending an email receipt with a payment. - -* Pass an `email` into the payor info or a `payorId` with an email tied to it. -* Pass `sendReceipt` into the transact arguments. - -You can optionally include a receipt description. -* Pass `receiptDescription` into the transactArguments. Defaults to "Payment from {Merchant Name}". - -```javascript -const AMOUNT = 1000 - -// email is required for a receipt to send -const PAYOR_INFO = { - "first_name": "Some", - "last_name": "Body", - "email": "somebody@paytheory.com" -} - - -myPayTheory.transact({ - amount: AMOUNT, - payorInfo: PAYOR_INFO, - sendReceipt: true, - receiptDescription: "School Technology Fees" -}) -``` - -As long as `email` and `sendReceipt` are included when calling the transact function it will send an email receipt. - -## Refund Receipts - -For sending an email with a refund you will be prompted to enter an email in the portal at the time of the refund. - -The prompt will auto-populate the email from the customer info. It can be changed before sending the receipt. - -![Refund Receipt Email](https://books-ui-assets.s3.amazonaws.com/refund-receipt.png) - -If you select `NO` it will process the refund with no receipt. - -If you include an email and select `SEND` it will send a receipt to the email address. diff --git a/home/Overview/MAIN.md b/home/Overview/MAIN.md deleted file mode 100644 index 646f5b9..0000000 --- a/home/Overview/MAIN.md +++ /dev/null @@ -1,94 +0,0 @@ -## Our Platform - -Pay Theory provides three environments for your integration: - -- **PayTheory.com** - - live integration for accepting payments -- **PayTheoryStudy.com** - - sandbox integration for testing _new versions of your software_ against Pay Theory -- **PayTheoryLab.com** - - acceptance integration for testing _new versions of Pay Theory_ against your software - -We understand how important the stability of your platform is. - -Our platform is designed from the ground up to support yours by providing a flexible infrastructure for deployment of both your changes and ours. - -Your instance of our platform lives in your own personal cloud space with its own collection of tables and security policies. - -You determine when changes from PayTheoryLab.com are deployed to PayTheory.com and PayTheoryStudy.com. - -## Features - -### Pay Theory Payments - -Provide safe and secure access to payments with hosted inputs for: - -- Credit card -- Debit card -- ACH -- Cash - -For basic [HTML Examples](https://PARTNER_NAME.html.example.STAGE.com/index.html) check here. _make sure you have an API key ready first_ - - -### Pay Theory Sockets - -Sockets provide a secure, consistent experience regardless of internet speed - -- No public facing payment API endpoints -- End to end encryption of messages using [NaCl](https://nacl.cr.yp.to/) (external link) -- Gated payment process -- Fine-grained rate limiting -- Improved API performance on slow connections - - -### Pay Theory Detective - -Actively detects bots & malicious actors - -- Anonymized fingerprinting -- Behavioral analysis -- Device / Website attestation -- Machine learning (coming soon) - -## Platforms - -- Pay Theory provides SDKs for the following platforms - - [Web / JavaScript](/web) - - iOS - - Android (coming soon) - - WooCommerce (coming soon) - - -## Partner Application Environment - -- Partner applications run as isolated instances -- Pay Theory maps upstream processor data feeds providing: - - Payment summaries - - Settlement summaries - - Chargeback / Dispute management - -### Merchant Portal -- Merchants can manage SDK in the [merchant portal](https://PARTNER_NAME.merchant.dashboard.STAGE.com) -- Account details are on the [settings page](https://PARTNER_NAME.merchant.dashboard.STAGE.com/settings) -- Access to Payments, Settlements, and Chargeback details -- Issue refunds on payments - -### System Portal -_Not available in start sandbox accounts_ -- Systems are merchants who also have other merchants they manage -- Systems manage their merchants in the [system portal](https://PARTNER_NAME.system.dashboard.STAGE.com) - - Assign merchant user accounts - - View merchant transactions - - Manage merchant credentials - - Issue refunds on payments for all system merchants - -### Partner Portal -_Not available in start sandbox accounts_ -- Partners manage merchants in the [partner portal](https://PARTNER_NAME.partner.dashboard.STAGE.com) - - Assign merchant user accounts - - View merchant transactions - - Manage merchant credentials - - Mobile application registration (coming soon) - - Website registration (coming soon) - - Onboard new merchants to live accounts (coming soon) \ No newline at end of file diff --git a/home/Overview/PAYMENT_PARAMETERS.md b/home/Overview/PAYMENT_PARAMETERS.md deleted file mode 100644 index ed5fe84..0000000 --- a/home/Overview/PAYMENT_PARAMETERS.md +++ /dev/null @@ -1,67 +0,0 @@ -# Payment Parameters - -Payment Parameters can be used to set parameters for a specific payment. - -These profiles are able to be set in the Partner Portal. - -![Payment Parameters List](https://books-ui-assets.s3.amazonaws.com/payment-parameters-list.png) - -They can be used to make a sure a specific payment meets certain requirements before it is processed. - -![Payment Parameters List](https://books-ui-assets.s3.amazonaws.com/payment-parameters-details.png) - -Upon initialization of a transaction it will use these payment parameters to create a payment intent. The payment intent will immediately be charged in the case of a card or ACH payment. In the case of a cash payment the barcode will represent the payment intent, and it will not be charged until the barcode is redeemed at a participating retailer. - -## Payment Parameters Properties - -These are the properties you will be able to configure for a set of payment parameters. - -**Payment Parameters Name**: The name of the payment parameters. -* Alphanumeric characters and dashes only. -* Must be unique for these parameters. - -**Days Until Expiry**: Days until the payment intent expires and is no longer valid. - -**Payment Activation Date**: Date that a payment using these parameters will begin being valid. - -**Payment Expiration Date**: Date that a payment using these parameters will stop being valid. - -**Minimum Amount Limit**: Amount the payment must be greater than to be a valid payment. -* This will default to $1 if left blank. - -**Maximum Amount Limit**: Amount the payment must be less than to be a valid payment. -* This will default to $5000 if left blank. - -**Enabled**: Payments using these parameters will only be valid if the parameters are enabled. -* This allows you to disable a group of payment intents by disabling a set of payment parameters. - -## Card, ACH and Cash details - -### Card and ACH Payments - -* Payment Parameters will be checked at the time of the transaction. If the payment parameters are invalid it will fail and return an error message. - -* Payment Parameters will be most beneficial in ensuring that a transaction falls within a certain date and price range for Card and ACH payments. -### Cash Payments - -* Payment Parameters will be checked both at the time of barcode creation and at the time of the transaction. - -* Payment Parameters will be most beneficial in ensuring that a transaction falls within a certain date and price range just like Card and ACH payments. - -* They will also be beneficial in disabling barcodes that a merchant no longer wants to collect on. - -## Example Use Case - -### Expiring Payment - -Payments received after a certain date need to be invalid and not be charged. -* Stale links should not be able to process ACH or Card payments or create Cash barcodes. -* Previously generated barcodes should not be able to be used to make payments at retailers. - -Create a new set of parameters and set these attributes: - -**Payment Parameters Name**: pay-before-end-of-year - -**Payment Expiration Date**: 12/31/2022 - -The minimum amount limit will be set to the $1 and the maximum amount limit will be set to $5000 which is our standard default. diff --git a/home/Overview/_category_.json b/home/Overview/_category_.json deleted file mode 100644 index 4b4c85b..0000000 --- a/home/Overview/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Overview", - "position": 2, - "link": { - "type": "generated-index", - "description": "Here are PT Reference guides." - } -}