# Qualpay Documentation

> Documentation for Qualpay

## Guides: Payments
- [Get Started](https://developer.qualpay.com/docs/quick-start.md): Quickly integrate with Qualpay.
- [Choose a Method](https://developer.qualpay.com/docs/overview.md)
- [Create a Sandbox Account](https://developer.qualpay.com/docs/create-sandbox-account.md): Create and log in to a Qualpay sandbox account.
- [Test and Go Live](https://developer.qualpay.com/docs/test-and-go-live.md): Meet testing requirements and convert to a Qualpay production account.
- [Best Practices](https://developer.qualpay.com/docs/best-practices.md)
  - [Account Verification](https://developer.qualpay.com/docs/account-verification.md): Verify account holders when establishing recurring payments
  - [Declined Transactions](https://developer.qualpay.com/docs/declined-transactions.md): Manage retries for declined transactions to save on interchange fees
  - [Account Updater](https://developer.qualpay.com/docs/account-updater-1.md): Use account updater to reduce declined transactions
  - [Enrichment](https://developer.qualpay.com/docs/enrichment.md): Add enrichment data to transactions to improve authorization rates

## Guides: Hosted Checkout
- [About Hosted Checkout](https://developer.qualpay.com/docs/about-hosted-checkout.md): Offer a full checkout page, hosted by Qualpay and customized to display your logo.
- [Quick Start](https://developer.qualpay.com/docs/quick-start-hosted-payments.md): Get started with Hosted Checkout.
- [Permanent Link Method](https://developer.qualpay.com/docs/permanent-links-for-hosted-payments.md): Set up Hosted Checkout with the permanent link method.
- [Dynamic Link Method](https://developer.qualpay.com/docs/dynamic-links-for-hosted-payments.md): Set up Hosted Checkout with the dynamic link method.
  - [Customer Vault](https://developer.qualpay.com/docs/customer-vault.md): Add a hosted page for Customer Vault entries with Hosted Checkout's dynamic link method.
  - [Modal Windows](https://developer.qualpay.com/docs/modal-windows.md): Use modal windows with Hosted Checkout's dynamic link method.
  - [Additional Features](https://developer.qualpay.com/docs/additional-features.md): Access optional features for Hosted Checkout's dynamic link method.
- [Google Pay™ via Hosted Checkout](https://developer.qualpay.com/docs/adding-google-pay-to-hosted-payments.md): Enable Google Pay™ on Qualpay’s hosted Checkout page.

## Guides: Embedded Fields
- [About Embedded Fields](https://developer.qualpay.com/docs/about-embedded-fields.md): Embed payment fields in your site or application. Collect and process payment information on Qualpay servers.
- [Embedded Quick Start](https://developer.qualpay.com/docs/quick-start-embedded-fields.md): Get started with embedded fields.

## Guides: API
- [About Our APIs](https://developer.qualpay.com/docs/about-our-api.md)
- [API Quick Start](https://developer.qualpay.com/docs/api-quick-start.md): Perform a basic sale transaction with our Payment Gateway API.
- [Payment Gateway](https://developer.qualpay.com/docs/payment-gateway.md): Set up transactions with our Payment Gateway API.
  - [Sale (Auth + Capture)](https://developer.qualpay.com/docs/sale.md): Perform a Sale transaction with our Payment Gateway API.
  - [Tokenize](https://developer.qualpay.com/docs/tokenize.md): Use Payment Gateway API to store information for future transactions.
  - [Void](https://developer.qualpay.com/docs/void.md): Void a transaction with our Payment Gateway API.
  - [Refund](https://developer.qualpay.com/docs/refund.md): Refund a transaction with our Payment Gateway API.
- [Checkout](https://developer.qualpay.com/docs/checkout-api.md): Create Dynamic Checkout links and look up transactions.
  - [Create a Checkout Link](https://developer.qualpay.com/docs/checkout-api-create-a-checkout-link.md): Use our API to generate a dynamic Checkout link to a hosted page.
  - [Look Up Checkout Payment](https://developer.qualpay.com/docs/checkout-api-look-up-checkout-payment.md): Use our API to get information about a Checkout payment.
- [Recurring Billing](https://developer.qualpay.com/docs/recurring-billing-api.md): Set up plans and subscriptions.
  - [Add a Recurring Plan](https://developer.qualpay.com/docs/add-a-recurring-plan.md): Create a new plan with Recurring Billing.
  - [Add a Subscription](https://developer.qualpay.com/docs/recurring-billing-add-a-subscription.md): Add a subscription with Recurring Billing.
  - [Cancel a Subscription](https://developer.qualpay.com/docs/recurring-billing-cancel-a-subscription.md): Cancel a subscription with Recurring Billing.
- [Customer Vault](https://developer.qualpay.com/docs/customer-vault-with-api.md): Let Qualpay securely store customer billing details.
  - [Add a Customer](https://developer.qualpay.com/docs/customer-vault-add-a-customer.md): Use our API to create a Customer Vault profile.
  - [Add a Payment Method](https://developer.qualpay.com/docs/customer-vault-add-a-payment-method.md): Use our API to add a payment method to a saved customer profile.
  - [Get All Customers](https://developer.qualpay.com/docs/customer-vault-get-all-customers.md): Use our API to get all saved customer profiles.
  - [Delete a Payment Method](https://developer.qualpay.com/docs/customer-vault-delete-a-payment-method.md): Use our API to delete a saved payment method from a Customer Vault profile.
- [Payee Vault](https://developer.qualpay.com/docs/payee-vault.md): Let Qualpay securely store payee details.
  - [Add a Payee](https://developer.qualpay.com/docs/payee-vault-add-a-payee.md): Use our API to create and save a payee profile.
  - [Update a Payee Account](https://developer.qualpay.com/docs/payee-vault-update-a-payee-account.md): Use our API to update payment information.
  - [Get All Payees](https://developer.qualpay.com/docs/payee-vault-get-all-payees.md): Use our API to get all saved payee profile data.
  - [Delete a Payee](https://developer.qualpay.com/docs/payee-vault-delete-a-payee.md): Use our API to delete a profile from the Payee Vault.
- [Invoicing](https://developer.qualpay.com/docs/invoicing-api.md): Send customized invoices and receive notification of invoice activity.
  - [Create an Invoice](https://developer.qualpay.com/docs/invoicing-create-an-invoice.md): Draft an invoice with our API.
  - [Send an Invoice](https://developer.qualpay.com/docs/invoicing-send-an-invoice.md): Use our Invoice API to send a saved invoice.
  - [Add Payment to an Invoice](https://developer.qualpay.com/docs/invoicing-add-payment-to-an-invoice.md): Use our API to add a payment to an invoice.
  - [Remove an Invoice Payment](https://developer.qualpay.com/docs/remove-an-invoice-payment.md): Use our API to remove an invoice payment.
- [Reporting](https://developer.qualpay.com/docs/reporting-2.md): Access a range of reports on demand.
  - [Transaction Report](https://developer.qualpay.com/docs/reporting-transaction-report.md): Use our API to browse a paginated list of transaction requests.
  - [Batch Report](https://developer.qualpay.com/docs/reporting-batch-report.md): Use our API to browse a list of merchant batches.
  - [Statement Settlement Data](https://developer.qualpay.com/docs/reporting-statement-settlement-data.md): Use our API to browse a list of statement settlement data.
- [Account Updater](https://developer.qualpay.com/docs/account-updater.md): Keep customer card information up-to-date.
  - [Submit Account Updater Request](https://developer.qualpay.com/docs/submit-account-updater-request.md)
  - [Get Summary of an Account Updater Request](https://developer.qualpay.com/docs/account-updater-get-summary-of-an-account-updater-request.md)
  - [Cancel Account Updater Request](https://developer.qualpay.com/docs/account-updater-cancel-account-updater-request.md)
- [Dispute Management](https://developer.qualpay.com/docs/disputes.md): Receive and manage payment card disputes with our API.
  - [Create Dispute Data](https://developer.qualpay.com/docs/dispute-management-create-dispute-data.md): Use our API to create test dispute data.
  - [Submit Dispute Response](https://developer.qualpay.com/docs/dispute-management-submit-dispute-response.md)
  - [Accept Dispute](https://developer.qualpay.com/docs/dispute-management-accept-dispute.md): Use our API to accept a dispute.
- [Webhooks](https://developer.qualpay.com/docs/webhooks.md): Get notifications through our Webhooks API resource.
  - [Disable a Webhook](https://developer.qualpay.com/docs/webhooks-disable-a-webhook.md): Use our API to disable a webhook.
- [Create Application](https://developer.qualpay.com/docs/application-boarding-create-application.md): Use our API to create a merchant application.
- [Google Pay™ via API](https://developer.qualpay.com/docs/google-paytm.md): Use Google Pay™ with our Payment Gateway API.

## Guides: Additional Features
- [Account Updater in Qualpay Manager](https://developer.qualpay.com/docs/copy-of-account-updater-in-qualpay-manager.md): Use the Qualpay Manager portal to enroll in Account Updater.
- [Payment Method Storage](https://developer.qualpay.com/docs/vault.md): Let Qualpay store payment information for you.
- [Webhooks in Qualpay Manager](https://developer.qualpay.com/docs/webhooks-in-qualpay-manager.md)
- [Dispute Management](https://developer.qualpay.com/docs/dispute-management.md): Manage dispute cases through the Qualpay API and portal.
- [Plugins](https://developer.qualpay.com/docs/plugins.md)
  - [WooCommerce](https://developer.qualpay.com/docs/woocommerce.md)
  - [Gravity Forms](https://developer.qualpay.com/docs/gravity-forms.md)
- [Aggregated Payments](https://developer.qualpay.com/docs/aggregated-payments.md): Use API or embedded fields to support aggregated purchases.
- [Receipts in Qualpay Manager](https://developer.qualpay.com/docs/customize-receipts.md)

## Guides: REFERENCE
- [ACH Conventions](https://developer.qualpay.com/docs/ach-conventions.md)
- [Dispute Conventions](https://developer.qualpay.com/docs/dispute-conventions.md)
- [Embedded Fields Conventions](https://developer.qualpay.com/docs/embedded-fields-conventions.md)
- [Webhook Conventions](https://developer.qualpay.com/docs/webhook-conventions.md)
- [Glossary](https://developer.qualpay.com/docs/glossary.md)

## API Reference: Getting Started
- [Authentication](https://developer.qualpay.com/reference/authentication.md)

## API Reference: APIs
- Payment Gateway
  - [Get Card Type Information for Visa, Mastercard, and Discover](https://developer.qualpay.com/reference/get-card-type-information.md): Gets Card type information for Visa, Mastercard, or Discover cards. This is useful if you prohibit or allow certain activity based on card type. For example, you may not want to allow a subscription…
  - [Authorize Transaction](https://developer.qualpay.com/reference/authorization.md): Authorizes a credit card for capture at a later time. An authorized transaction will continue to be open until it expires or a capture message is received. Authorizations are automatically voided if…
  - [Request a Balance](https://developer.qualpay.com/reference/request-balance.md): Requests a balance for the specified 'For Benefit Of' merchant account.  FBO relationship will be validated.<br> <br>Note: This operation is only available to merchant accounts, and it requires…
  - [Close Batch](https://developer.qualpay.com/reference/batch-close.md): Immediately closes the open batch of transactions. Use this request to control the timing of the batch close. By default, the once-daily automatic batch close is at 9 p.m. PST (U.S.), and this can be…
  - [Capture an Authorized Transaction](https://developer.qualpay.com/reference/capture.md): Captures an authorized transaction for any amount up to the amount originally authorized. An authorized transaction can only be captured once. <br><br>Note: Vendor accounts need special permissions…
  - [Issue Credit to Cardholder](https://developer.qualpay.com/reference/credit.md): Issues an <<glossary:unlinked credit>>. Credit requests require the cardholder data in the request. <br><br>Note: In the production environment, this feature is only available to merchant accounts,…
  - [Send Transaction Receipt Email](https://developer.qualpay.com/reference/send-receipt.md): Sends a transaction receipt to multiple email addresses. Receipts can be sent only for successful transactions. <br><br>Note: Vendor accounts need special permissions to use this operation; contact…
  - [Expire Token](https://developer.qualpay.com/reference/expire.md): Expires the token (`card_id`), rendering it no longer valid for use in future transactions. The token is not deleted until 30 days after expiration. <br><br>Note: This operation requires special…
  - [Force Transaction Approval](https://developer.qualpay.com/reference/force.md): Forces a declined transaction into the system. Used when an online authorization request received a 'declined' reason code and you have received an authorization from a voice or automated response…
  - [Initiate a Payment to a Payee](https://developer.qualpay.com/reference/initiate-payment.md): Initiates a payment to the specified payee saved in Payee Vault.  Payee relationship will be validated.<br> <br>Note: This operation is only available to merchant accounts, and it requires special…
  - [Recharge Previously Settled Transaction](https://developer.qualpay.com/reference/recharge.md): Creates a new sale transaction using cardholder data from a previous successful transaction.<br><br> Note: This operation is only available to merchant accounts. In the production environment, it…
  - [Refund Previously Captured Transaction](https://developer.qualpay.com/reference/refund.md): Returns money to the cardholder from a previously captured payment card transaction. You may request multiple refunds per captured transaction as long as the sum of all refunds does not exceed the…
  - [Sale (Auth + Capture)](https://developer.qualpay.com/reference/sale.md): Requests authorization and, if approved, immediately captures the transaction to be included in the next batch close. This transaction type is used in card-present environments and in…
  - [Tokenize](https://developer.qualpay.com/reference/tokenize.md): Once stored, a unique `card_id` is returned for use in future transactions. Optionally, tokenization can be requested in an Authorize, Verify, Force, Credit, or Sale request by sending the `tokenize`…
  - [Verify](https://developer.qualpay.com/reference/verify.md): A Verify request returns success if the cardholder information was verified by the issuer. If AVS or CVV data is included in the message, the AVS or CVV result code will appear in the response. This…
  - [Void a Previously Authorized Transaction](https://developer.qualpay.com/reference/void.md): You can void an authorized transaction at any time until we automatically void it at 28 days. You can void captured transactions until the batch is closed. If your batch closes and you did not void…
- Checkout
  - [Look Up Checkout Payment](https://developer.qualpay.com/reference/getdetails.md): Gets information about a transaction that used a specified Checkout link. Use the `checkout_id` value  returned for a 'Create a Checkout Link' request to query the status of a payment made through…
  - [Create a Checkout Link](https://developer.qualpay.com/reference/addcheckout.md): Generates a link to a hosted page that either allows the user to make payments or add and edit payment methods saved in Customer Vault. The type of page generated (payment or Vault) is based on the…
  - [Cancel a Checkout Link](https://developer.qualpay.com/reference/cancelcheckout.md): Expires the checkout link of a dynamic checkout. Expired checkout links are no longer accessible to customers to make payments. If your customer attempts to use the checkout link after the checkout…
- Embedded Fields
  - [Get Transient Key](https://developer.qualpay.com/reference/getembeddedtransientkey.md): Gets a transient key for use with embedded fields. The transient key is a one-time key used to invoke embedded fields. This key is valid for up to 12 hours. The key will be automatically invalidated…
- Recurring Billing
  - [Get Transactions by Subscription ID](https://developer.qualpay.com/reference/getsubscriptiontransactions.md): Gets all transactions for a specified subscription. Optional query parameters help filter and restrict the result.
  - [Get the Custom Fields for a Subscription](https://developer.qualpay.com/reference/subscriptionlabelsbrowse.md): Gets all of the custom fields assigned to a subscription. Optional parameters will help filter and restrict the result.
  - [Add a Custom Field to a Subscription](https://developer.qualpay.com/reference/subscriptionlabelsadd.md): Adds a new custom field to a subscription.
  - [Edit Custom Field](https://developer.qualpay.com/reference/subscriptionlabelsedit.md): Edits a custom field assigned to a subscription.
  - [Remove a Custom Field](https://developer.qualpay.com/reference/subscriptionlabelsdelete.md): Removes a custom field assigned to a subscription.
  - [Get Subscription by Subscription ID](https://developer.qualpay.com/reference/getsubscription.md): Gets the details of the specified subscription.
  - [Update a Subscription](https://developer.qualpay.com/reference/updatesubscription.md): Updates an existing subscription. The start date can only be updated for subscriptions that have not yet started.
  - [Get All Recurring Plans](https://developer.qualpay.com/reference/browseplans.md): Gets a paginated list of all recurring plans. Optional query parameters determine the size and sort order of the returned array.
  - [Add a Recurring Plan](https://developer.qualpay.com/reference/addplan.md): Creates a new recurring plan. Generates a unique `plan_id`, which you can use to interact with or delete the plan.
  - [Pause a Subscription](https://developer.qualpay.com/reference/pausesubscription.md): Pauses an active subscription. Recurring payments are skipped when a subscription is paused.
  - [Archive a Recurring Plan](https://developer.qualpay.com/reference/archiveplan.md): Archives an active plan. All subscriptions to the plan remain active. You cannot update an archived plan or add new subscribers to it. You can always access an archived plan’s information in the…
  - [Get All Subscription Transactions](https://developer.qualpay.com/reference/getallsubscriptiontransactions.md): Gets all subscription transactions. Optional query parameters determine the size and sort order of the returned array.
  - [Get All Subscriptions](https://developer.qualpay.com/reference/browsesubscriptions.md): Gets an array of subscription objects. Optional query parameters determine the size and sort order of the returned array.
  - [Add a Subscription](https://developer.qualpay.com/reference/addsubscription.md): Creates a new subscription with a specific start date, subscribing a customer to a recurring plan or a one-off off-plan. Returns a unique `subscription_id`, which you can use to interact with this…
  - [Delete a Recurring Plan](https://developer.qualpay.com/reference/deleteplan.md): Deletes a plan. You can delete any plan, whether it is active or not. All subscriptions related to the plan are canceled. You cannot update a canceled plan or add new subscribers to it. You can…
  - [Find Recurring Plan by Plan Code](https://developer.qualpay.com/reference/getplan.md): Returns a list of recurring plans for a specified `plan_code`. The search results include active, archived, and deleted plans. Optional query parameters determine the size and sort order of the…
  - [Update a Recurring Plan](https://developer.qualpay.com/reference/updateplan.md): Updates an active recurring plan. Only the fields sent in the request body are updated. <br><br>If there are subscribers to the specified plan:<ul> <li>The plan is archived and a copy of the plan…
  - [Cancel a Subscription](https://developer.qualpay.com/reference/cancelsubscription.md): Cancels an active, suspended, or paused subscription. A canceled subscription cannot be resumed.
  - [Resume a Subscription](https://developer.qualpay.com/reference/resumesubscription.md): Resumes a subscription that you have paused or that the system has suspended. When a suspended subscription is resumed, the subscription engine initiates all the missed subscription transactions.…
- Invoicing
  - [Update an Outstanding Invoice](https://developer.qualpay.com/reference/updateoutstandinginvoice.md): Updates an outstanding invoice. Only the fields sent in the request body are updated. If updating JSON object fields, send the complete JSON in the request body. You can only update `from_contact`…
  - [Get All Invoices](https://developer.qualpay.com/reference/browseinvoices.md): Gets and filters all invoices associated with your account. Optional query parameters determine the size and sort order of the returned array.<br><br> If you are working with multiple merchant…
  - [Create an Invoice](https://developer.qualpay.com/reference/createinvoice.md): Creates a draft invoice that you can send later using the 'Send an Invoice' request. Returns an `invoice_id` value, which you can use to interact with the invoice. <br><br> Note: This operation…
  - [Send an Invoice](https://developer.qualpay.com/reference/sendinvoice.md): Sends a saved invoice to a customer. This changes the invoice’s status to outstanding. After sending, you can only update the invoice’s `from_contact` and `billing_contact`.<br><br> Note: This…
  - [Cancel an Invoice](https://developer.qualpay.com/reference/cancelinvoice.md): Cancels an invoice. A canceled invoice cannot be edited. If an invoice has been canceled and your customer selects 'Pay Now' in the sent invoice, an error message will appear.<br><br>Note: This…
  - [Get Invoice Payments by ID](https://developer.qualpay.com/reference/browseinvoicepaymentsbyid.md): Gets and filters all payments made on an invoice. Optional query parameters determine the size and sort order of the returned array.<br><br> Note: This operation requires special permissions for…
  - [Add Payment to an Invoice](https://developer.qualpay.com/reference/addinvoicepayment.md): Adds a payment to a `SAVED` or `OUTSTANDING` invoice.<br><br> Note: This operation requires special permissions for vendor account use. Contact Qualpay Support to enable it.
  - [Update an Invoice Payment](https://developer.qualpay.com/reference/updateinvoicepayment.md): Updates a payment on a `SAVED` or `OUTSTANDING` invoice. You cannot update credit card payments made through the invoice’s 'Pay Now' button.<br><br> Note: This operation requires special permissions…
  - [Remove an Invoice Payment](https://developer.qualpay.com/reference/removeinvoicepayment.md): Removes a payment from a `SAVED` or `OUTSTANDING` invoice. Payments made by credit card cannot be removed.<br><br>Note: This operation requires special permissions for vendor account use; contact…
  - [Update a Draft Invoice](https://developer.qualpay.com/reference/updatedraftinvoice.md): Updates a draft invoice. Only the fields sent in the request body are updated. If updating JSON object fields, you should send the complete JSON in the request body. <br><br> Note: This operation…
  - [Get Undelivered Invoices](https://developer.qualpay.com/reference/browsebouncedinvoices.md): Gets and filters all undelivered invoices for one merchant account. Optional query parameters determine the size and sort order of the returned array.
  - [Resend an Invoice](https://developer.qualpay.com/reference/resendinvoice.md): Resends an outstanding or paid invoice to a customer.<br><br> Note: This operation requires special permissions for vendor account use. Contact Qualpay Support to enable it.
  - [Copy an Invoice](https://developer.qualpay.com/reference/copyinvoice.md): Makes a copy of an invoice. The invoice date will be set to today's date, and the due date will be adjusted based on the invoice date and the payment terms. <br><br> To make a copy of the invoice…
  - [Get Invoice Payments](https://developer.qualpay.com/reference/browseinvoicepayments.md): Gets and filters all invoice payments for one merchant account. Optional query parameters determine the size and sort order of the returned array.
  - [Get by Invoice ID](https://developer.qualpay.com/reference/getinvoice.md): Gets information on a specified invoice.<br><br> Note: This operation requires special permissions for vendor account use. Contact Qualpay Support to enable it.
- Customer Vault
  - [Set Primary Shipping Address](https://developer.qualpay.com/reference/setprimaryshippingaddress.md): Sets a specified shipping address as the primary shipping address for a profile in Customer Vault.
  - [Get Shipping Addresses](https://developer.qualpay.com/reference/getshippingaddresses.md): Gets all shipping addresses for a specified profile in Customer Vault. The response includes an array of shipping addresses.
  - [Update a Shipping Address](https://developer.qualpay.com/reference/updateshippingaddress.md): Updates a specified shipping address for a profile in Customer Vault.
  - [Add a Shipping Address](https://developer.qualpay.com/reference/addshippingaddress.md): Adds a shipping address to a profile in Customer Vault. The response includes a unique `shipping_id`, which can be used to manage the `shipping_address`.
  - [Set Primary Payment Method](https://developer.qualpay.com/reference/setprimarybillingcard.md): Sets a specified payment method as the primary payment method for a profile in Customer Vault. The system uses the primary payment method for subscription payments.
  - [Delete a Payment Method](https://developer.qualpay.com/reference/deletebillingcard.md): Deletes a specified payment method from a profile in Customer Vault. A payment method with active subscriptions cannot be deleted.
  - [Get All Customers](https://developer.qualpay.com/reference/browsecustomers.md): Gets and filters all customer profiles saved in one merchant account’s Customer Vault. Optional query parameters determine the size and sort order of the returned array.
  - [Add a Customer](https://developer.qualpay.com/reference/addcustomer.md): Adds a customer to the Customer Vault and generates or saves a `customer_id`, which is required to create invoice and subscription payments. Payment methods, billing addresses and shipping addresses…
  - [Get Payment Methods](https://developer.qualpay.com/reference/getbillingcards.md): Gets a list of all payment methods associated with a `customer_id`. The response contains an array of billing cards.
  - [Update a Payment Method](https://developer.qualpay.com/reference/updatebillingcard.md): Updates a specified payment method for a profile in Customer Vault. Include the complete billing record in the request.
  - [Add a Payment Method](https://developer.qualpay.com/reference/addbillingcard.md): Tokenizes and adds a payment method to a customer profile in Customer Vault. This returns the tokenized card number (or card ID) in the `card_id` field. You can use this card ID in lieu of the card…
  - [Get by Customer ID](https://developer.qualpay.com/reference/getcustomer.md): Gets a specified profile in Customer Vault.
  - [Update a Customer](https://developer.qualpay.com/reference/updatecustomer.md): Updates a Customer Vault profile. You can send the entire resource or just the fields that need updating. When updating array fields (`billing_cards` or `shipping_addresses`), include the entire…
  - [Delete a Customer](https://developer.qualpay.com/reference/deletecustomer.md): Deletes a customer profile from Customer Vault. Deleting a customer profile will delete all the subscriptions associated with the profile. This operation cannot be reversed.
  - [Delete a Shipping Address](https://developer.qualpay.com/reference/deleteshippingaddress.md): Deletes a specified shipping address from a profile in Customer Vault.
  - [Get by Card ID](https://developer.qualpay.com/reference/getcustomerbycardid.md): Returns all customer records from the customer vault that are associated with a specified card ID. The card ID is returned by QualPay when the card is added to the customer record.
- Payee Vault
  - [Get All Payees](https://developer.qualpay.com/reference/browsepayees.md): Gets and filters all profiles in the Payee Vault of one merchant account. Optional query parameters determine the size and sort order of the returned array. <br><br>Note: The Payee Vault API resource…
  - [Add a Payee](https://developer.qualpay.com/reference/addpayee.md): Creates a payee profile in the Payee Vault. Returns a `payee_id`, which you can use to manage the profile. <br><br>Note: The Payee Vault API resource is intended for a very specific use case and…
  - [Get by Payee ID](https://developer.qualpay.com/reference/getpayee.md): Gets a specified profile in Payee Vault. <br><br>Note: The Payee Vault API resource is intended for a very specific use case and requires special permissions. Contact Qualpay Support to enable it.
  - [Update a Payee](https://developer.qualpay.com/reference/updatepayee.md): Updates a specified profile in Payee Vault. You can send all fields or just the fields that need updating. Use the ‘Update a Payee Account’ request to update payment account details. <br><br>Note:…
  - [Delete a Payee](https://developer.qualpay.com/reference/deletepayee.md): Deletes a payee profile from Payee Vault. This operation cannot be reversed. <br><br>Note: The Payee Vault API resource is intended for a very specific use case and requires special permissions.…
  - [Update a Payee Account](https://developer.qualpay.com/reference/updatepayeeaccount.md): Updates the payment account details of a profile in Payee Vault. <br><br>Note: The Payee Vault API resource is intended for a very specific use case and requires special permissions. Contact Qualpay…
- Application Boarding
  - [Browse Applications](https://developer.qualpay.com/reference/browseapps.md): Gets an array of applications. Optional query parameters determine the size and sort order of the returned array.
  - [Browse Sales Reps](https://developer.qualpay.com/reference/browsesalesreps.md): Gets an array of sales representatives to whom you can assign an application during its creation. Optional query parameters determine the size and sort order of the returned array.
  - [Create Application](https://developer.qualpay.com/reference/addapp.md): Creates a new merchant application. This returns the new application's ID (`app_id`) and the available pricing options.
  - [Save Data](https://developer.qualpay.com/reference/savedata.md): Saves one or more data fields to a new merchant application.
  - [Get Application](https://developer.qualpay.com/reference/getapp.md): Retrieves an application's details and available pricing.
  - [Email Application](https://developer.qualpay.com/reference/emailapp.md): Emails an application to a new or existing owner. This request requires one of the following: <ul> <li>An `owner` object that includes a valid `email`, `first_name`, and `last_name`.</li> <li>An…
  - [Upload Document](https://developer.qualpay.com/reference/uploadfile.md): Uploads a document relevant to this application to the provided bucket.
  - [Validate Application](https://developer.qualpay.com/reference/validateapp.md): Validates all data fields in an application, including dependencies the fields may have between each other. An application cannot be submitted until it passes validation.
- Disputes v0.5
  - [Get Submitted Dispute Response](https://developer.qualpay.com/reference/getdisputeresponse.md): Gets a dispute response you previously submitted.<br><br> Note: The Dispute Management API resource is not enabled by default. Contact Qualpay Support for permissions.
  - [Submit Dispute Response](https://developer.qualpay.com/reference/submitdisputesresponse.md): Submits a dispute response with supporting documentation. Response options are dynamic and are based on the response reason code.<br><br> Note: The Dispute Management API resource is not enabled by…
  - [Reset Dispute Data](https://developer.qualpay.com/reference/resetdispute.md): Resets a test or pre-review dispute case to the status `New`. In the production environment, you can reset a dispute any time before it is in `Q - Doc Under Review.` Resetting a dispute lets you…
  - [Create Dispute Data](https://developer.qualpay.com/reference/createdispute.md): Creates sandbox dispute data to test your integration. Returns a control number (`rec_id`) for the dispute, which you can use to interact with the API.<br><br> Note: The Dispute Management API…
  - [Get Credited Transaction Detail](https://developer.qualpay.com/reference/getcreditedtran.md): Returns credited transactions from the last 90 days that are related to a dispute case.<br><br> Note: The Dispute Management API resource is not enabled by default; contact Qualpay Support for…
  - [Accept Dispute](https://developer.qualpay.com/reference/acceptdispute.md): Accepts a first-time chargeback or a pre-arbitration 'Withdraw from Arbitration.'<br><br> Note: The Dispute Management API resource is not enabled by default; contact Qualpay Support for permissions.
  - [Get Non-Disputed Transaction](https://developer.qualpay.com/reference/getnondisputedtran.md): Returns debits that occurred in the last 90 days and are related to a dispute case. <br><br> Note: The Dispute Management API resource is not enabled by default; contact Qualpay Support for…
  - [Get Remedy Undisputed Transactions](https://developer.qualpay.com/reference/getremedyundisputedtran.md): Requests the undisputed transactions associated with a Visa dispute that qualify for use in a Remedy response.<br> <br>Note: The Dispute Management API resource is not enabled by default. Contact…
- Disputes v1.0
  - [Get Dispute](https://developer.qualpay.com/reference/getdispute.md): Request a single dispute by its ID.
  - [Get Disputes](https://developer.qualpay.com/reference/getdisputes.md): Gets dispute details associated with one vendor or node. By default, this returns anything with a status change date of the previous day or same day as the request. Use filters to specify a different…
  - [Submit Dispute Response Action](https://developer.qualpay.com/reference/submitdisputeaction.md): Submit dispute responses with supporting documentation. Response options are based on the 'response_options' provided when fetching a dispute with the 'response_options' URL parameter.
  - [List Dispute Files](https://developer.qualpay.com/reference/getdisputefiles.md): Lists all the existing files uploaded as supporting documentation for a dispute.
  - [Upload a Dispute File](https://developer.qualpay.com/reference/uploaddisputefile.md): Adds a new dispute file to any existing files as supporting documentation for a dispute.
  - [Remove Dispute File](https://developer.qualpay.com/reference/deletedisputefile.md): Removes one of the files previously uploaded as supporting documentation for a dispute.
- Reporting
  - [Deposit Report](https://developer.qualpay.com/reference/browsedeposits.md): Gets and filters a paginated list of bank deposits and withdrawals. Optional query parameters determine the size and sort order of the returned array.
  - [Disputes Report](https://developer.qualpay.com/reference/browsedisputes.md): Gets and filters a paginated list of disputes. Optional query parameters determine the size and sort order of the returned array.
  - [Settled Transaction Report](https://developer.qualpay.com/reference/browsetrans.md): Gets and filters a paginated list of settled transactions. Optional query parameters determine the size and sort order of the returned array.
  - [Get Transaction by PG ID](https://developer.qualpay.com/reference/gettransactionbypgid.md): Gets information on a Payment Gateway transaction specified by its Payment Gateway ID.
  - [Transaction Report](https://developer.qualpay.com/reference/gettransactionrequests.md): Gets and filters a paginated list of all transaction requests. Optional query parameters determine the size and sort order of the returned array.
  - [Statement Summary Data](https://developer.qualpay.com/reference/browsestatementsummarydata.md): Browses a paginated list of Statement Summary Data
  - [Statement Settlement Data](https://developer.qualpay.com/reference/browsestatementsettlementdata.md): Gets and filters a paginated list of the settlement data for each statement we settled with the merchant. Optional query parameters determine the size and sort order of the returned array.
  - [Statement Fee Data](https://developer.qualpay.com/reference/browsestatementfeedata.md): Gets and filters a paginated list of fees deducted in each statement sent to the merchant. Optional query parameters determine the size and sort order of the returned array.
  - [Statement Dispute Adjustments Data](https://developer.qualpay.com/reference/browsestatementdisputeadjustmentdata.md): Gets and filters a paginated list of dispute adjustments that appear in statements sent to the merchant. Optional query parameters determine the size and sort order of the returned array.
  - [Statement Reserve Data](https://developer.qualpay.com/reference/browsestatementreservedata.md): Gets and filters a paginated list of data on the merchant account reserves that appear in statements sent to the merchant. Optional query parameters determine the size and sort order of the returned…
  - [Statement Plan Type Data](https://developer.qualpay.com/reference/browsestatementplandata.md): Gets and filters a paginated list of data on each payment instrument type that appears in statements sent to the merchant. Optional query parameters determine the size and sort order of the returned…
  - [Batch Report](https://developer.qualpay.com/reference/browsebatches.md): Gets and filters a list of merchant batches. These are whole batches that have been settled from the merchant's <<glossary:POS>> device, software, or gateway.
- Webhooks
  - [Get Events](https://developer.qualpay.com/reference/getevents.md): Gets all events for a webhook. Refer to <a href="/docs/webhook-conventions#webhook-events" target="_blank">Webhook Events</a> for a list of possible events.
  - [Browse Webhooks](https://developer.qualpay.com/reference/browsewebhook.md): Gets and filters an array of all webhooks associated with your account. Optional query parameters determine the size and sort order of the returned array.
  - [Add a Webhook](https://developer.qualpay.com/reference/addwebhook.md): Configures a new webhook. Returns a `webhook_id` value to use in future requests and a secret to secure the webhook. Refer to <a href="/docs/webhooks#4-secure-your-webhook" target="_blank">Secure…
  - [Enable a Webhook](https://developer.qualpay.com/reference/enablewebhook.md): Enables a webhook, making it active. Events are triggered and requests are posted only for active webhooks.
  - [Get Webhook](https://developer.qualpay.com/reference/getwebhook.md): Gets data on a specified webhook.
  - [Update Webhook](https://developer.qualpay.com/reference/editwebhook.md): Updates a webhook’s configurations. You can send just the fields that need updating. When you include an `events` array in this request, all of the webhook’s events will be replaced with the events…
  - [Disable a Webhook](https://developer.qualpay.com/reference/disablewebhook.md): Disables a webhook, holding all existing requests from triggering until the webhook is enabled again. If the webhook is enabled before a request expires, the system will attempt to post the request…
  - [Add an Event](https://developer.qualpay.com/reference/addevent.md): Adds an event to a webhook. Refer to <a href="/docs/webhook-conventions#webhook-events" target="_blank">Webhook Events</a> for a list of available events.
  - [Delete Event](https://developer.qualpay.com/reference/removeevent.md): Removes an event from a webhook. Refer to <a href="/docs/webhook-conventions#webhook-events" target="_blank">Webhook Events</a> for a list of available events.
- Account Updater
  - [Get Summary of an Account Updater Request](https://developer.qualpay.com/reference/getaussummary.md): Gets summary information on one specified Account Updater request. <br><br>Note: This operation is intended for merchant account use, and it requires special permissions. Contact Qualpay Support to…
  - [Put on Account Updater Harvest Hold](https://developer.qualpay.com/reference/putonaushold.md): Puts one card ID or all payment cards belonging to a customer ID on an Account Updater harvest hold. Held cards are not included in your Account Updater harvest. <br><br>Note: This operation is…
  - [Cancel Account Updater Request](https://developer.qualpay.com/reference/cancelausrequest.md): Cancels a submitted Account Updater request whose status is `INPROGRESS`. <br><br>Note: This operation is intended for merchant account use, and it requires special permissions. Contact Qualpay…
  - [Release from Account Updater Harvest Hold](https://developer.qualpay.com/reference/releasefromaushold.md): Releases one card ID or all payment methods belonging to a customer ID from an Account Updater harvest hold. <br><br>Note: This operation is intended for merchant account use, and it requires special…
  - [Get Detailed List of All Account Updater Results](https://developer.qualpay.com/reference/browseausrequestsdetail.md): Gets and filters data on all payment cards that were sent to the Account Updater engine and the responses received. Optional query parameters determine the size and sort order of the returned array.…
  - [Get Account Updater Results (Full Card Number Requests)](https://developer.qualpay.com/reference/getausresponse.md): Gets the results of a specified Account Updater request, including full card numbers and expiration dates. <br><br>Note: This operation is intended for merchant account use, and it requires special…
  - [Get Summary of All Account Updater Results](https://developer.qualpay.com/reference/browseausrequestssummary.md): Gets and filters the summarized result information for all Account Updater requests. Optional query parameters determine the size and sort order of the returned array. <br><br>Note: This operation is…
  - [Submit Account Updater Request](https://developer.qualpay.com/reference/addausjsonrequest.md): Uses full card numbers and expiration dates to create and submit an Account Updater request. Returns a `request_id` value, which you can use to interact with the request. <br><br>You can use card…
  - [Create an Account Updater Request Using Card IDs](https://developer.qualpay.com/reference/createausrequest.md): Uses the IDs of saved payment cards to create and submit an Account Updater request. Returns a unique `request_id` that you can use to check the status of the request. <br><br>Note: This operation is…
  - [Get Detailed List of an Account Updater Request](https://developer.qualpay.com/reference/getausdetail.md): Retrieves and filters information on all cards sent in one specified Account Updater request, including responses for each. Optional query parameters determine the size and sort order of the returned…
- Integrator
  - [Generate Security Key](https://developer.qualpay.com/reference/rotateapikey.md): Creates a new API security key for a specified merchant account. <br><br>Note: This API resource is intended for a very specific use case for a third-party integration. To use this resource, please…
  - [Merchant Settings](https://developer.qualpay.com/reference/getmerchantsettings.md): Gets the payment card types and currencies supported by a specified merchant account.<br><br> Note: This API resource is intended for a very specific use case for a third-party integration. To use…
  - [Generate Test Account](https://developer.qualpay.com/reference/createtestaccount.md): Creates a new test merchant account. <br><br>Note: This API resource is intended for a very specific use case for a third-party integration. To use this resource, please contact Qualpay Customer…
- Transaction
  - [Refund Third Party Gateway Transaction](https://developer.qualpay.com/reference/refundnonpg.md): Refund a purchase transaction originated by a third-party gateway payment system.
- Token
  - [Remove a block from a token](https://developer.qualpay.com/reference/unblocktoken.md): Resets a blocked token in order to retry the payment.
  - [Generate a pending token](https://developer.qualpay.com/reference/generatependingtoken.md): Generates a pending token.
  - [Gets the status of a token.](https://developer.qualpay.com/reference/tokenstatus.md): Token status request