# Payroc developer documentation > Payroc developer documentation: Solutions, Guides, Knowledge, API reference and Workflows for the Payroc API. The API covers Attachments, Boarding, Payroc Cloud, Card payments, Bank transfer payments, Repeat payments, Payment links, Tokenization, Payment features, Hosted Fields, Apple Pay sessions, Funding, Reporting and Notifications. The OpenAPI specification is at https://docs.payroc.com/openapi.json (JSON) and https://docs.payroc.com/openapi.yaml (YAML). Requests authenticate with an HTTP bearer token (JWT); see https://docs.payroc.com/api/authentication.md. Servers: Production https://api.payroc.com/v1; UAT https://api.uat.payroc.com/v1. UAT (https://api.uat.payroc.com/v1) is the test environment. ## Solutions - [One payments platform. Two ways to build on it.](https://docs.payroc.com/solutions.md): Compare Payroc Essentials for low-code integration with Full Stack for full API access and advanced customization. - [Essentials](https://docs.payroc.com/solutions/essentials.md): Overview of Essentials as a suite of low-code payment solutions for merchants who want fast, self-service integration for in-person and online payments. - [In-person payments](https://docs.payroc.com/solutions/essentials/in-person-payments.md): Overview of Payroc Essentials in-person payment solutions, including Payroc Cloud, Roc Terminal+, and Roc Services for point-of-sale payment acceptance. - [Payroc Cloud](https://docs.payroc.com/solutions/essentials/in-person-payments/payroc-cloud.md): Overview of Payroc Cloud as a semi-integrated POS payment solution that connects payment devices to a POS system through the gateway without requiring a direct device connection. - [Roc Terminal+](https://docs.payroc.com/solutions/essentials/in-person-payments/roc-terminal.md): Overview of Roc Terminal+ as a no-code, multi-platform in-person payment solution supporting cards, bank transfers, recurring payments, and pre-authorizations on desktop, mobile, and compatible… - [Roc Services](https://docs.payroc.com/solutions/essentials/in-person-payments/roc-services.md): Overview of Roc Services as a no-code scheduling, invoicing, and payment solution for service-based merchants on desktop and mobile. - [Online payments](https://docs.payroc.com/solutions/essentials/online-payments.md): Overview of Essentials online payment solutions including Hosted Fields, Hosted Payment Page, Payment Links, and no-code terminal and invoicing options. - [Hosted Fields](https://docs.payroc.com/solutions/essentials/online-payments/hosted-fields.md): Overview of Hosted Fields as an online payment solution for merchants who want to embed card, ACH, and PAD payment forms directly into their checkout page without redirects. - [Hosted Payment Page](https://docs.payroc.com/solutions/essentials/online-payments/hosted-payment-page.md): Overview of Hosted Payment Page as a low-code online payment solution for merchants who want a Payroc-hosted, PCI-compliant checkout page. - [Payment Links](https://docs.payroc.com/solutions/essentials/online-payments/payment-links.md): Overview of Payment Links as a solution for merchants to create and share secure hosted payment URLs without requiring a website or checkout integration. - [Roc Terminal+](https://docs.payroc.com/solutions/essentials/online-payments/roc-terminal.md): Overview of Roc Terminal+ as a no-code, multi-platform payment solution for accepting cards, bank transfers, and recurring payments from a single application. - [Roc Services](https://docs.payroc.com/solutions/essentials/online-payments/roc-services.md): Overview of Roc Services as a no-code scheduling and invoicing solution for service-based merchants, covering appointments, recurring payments, and reporting. - [Essentials Guides](https://docs.payroc.com/solutions/essentials/guides.md): Explore step-by-step guides for integrating with Payroc Cloud, Hosted Payment Page, Hosted Fields, and Payment Links. - [Full Stack](https://docs.payroc.com/solutions/full-stack.md): Overview of Full Stack solutions covering end-to-end payment platform capabilities including merchant boarding, in-person and online payments, reporting, and merchant funding. - [Board merchants](https://docs.payroc.com/solutions/full-stack/board-merchants.md): Onboard and configure your merchants. - [Boarding](https://docs.payroc.com/solutions/full-stack/board-merchants/boarding.md): Overview of the Boarding solution for digitally onboarding merchants by submitting their information programmatically to enable faster account setup. - [Take payments](https://docs.payroc.com/solutions/full-stack/take-payments.md): Accept in-person and online payments with Full Stack. - [In-person payments](https://docs.payroc.com/solutions/full-stack/take-payments/in-person-payments.md): Overview of in-person payment solutions for merchants, covering API-based, semi-integrated, terminal, and invoicing options. - [Payroc API for in-person payments](https://docs.payroc.com/solutions/full-stack/take-payments/in-person-payments/payroc-api.md): Overview of the Payroc API as a fully customizable in-person payment solution for processing sales, pre-authorizations, refunds, and more with certified payment devices. - [Payroc Cloud](https://docs.payroc.com/solutions/full-stack/take-payments/in-person-payments/payroc-cloud.md): Overview of Payroc Cloud as a semi-integrated POS payments solution that connects payment devices to your POS through the gateway without requiring a direct device connection. - [Tap to Pay on iPhone](https://docs.payroc.com/solutions/full-stack/take-payments/in-person-payments/tap-to-pay-on-iphone.md): Overview of Tap to Pay on iPhone as an in-person payment solution that lets merchants accept contactless payments directly on an iPhone without external hardware. - [Online payments](https://docs.payroc.com/solutions/full-stack/take-payments/online-payments.md): Overview of Payroc's online payment solutions, including the Payroc API, Payment Links, Hosted Fields, Hosted Payment Page, and no-code terminal options. - [Payroc API for online payments](https://docs.payroc.com/solutions/full-stack/take-payments/online-payments/payroc-api.md): Overview of the Payroc API as a fully flexible online payment solution supporting cards, bank transfers, digital wallets, tokenization, and recurring payments. - [Payment Links](https://docs.payroc.com/solutions/full-stack/take-payments/online-payments/payment-links.md): Overview of Payment Links as a solution for merchants to create and share secure payment links without needing a website or checkout integration. - [Hosted Fields](https://docs.payroc.com/solutions/full-stack/take-payments/online-payments/hosted-fields.md): Overview of Hosted Fields as an online payment solution for merchants who want embedded checkout forms that accept card, ACH, and PAD payments without redirects. - [Hosted Payment Page](https://docs.payroc.com/solutions/full-stack/take-payments/online-payments/hosted-payment-page.md): Overview of Hosted Payment Page as a low-code online payment solution for merchants who want a secure, Payroc-hosted checkout page without handling sensitive payment data. - [View reports](https://docs.payroc.com/solutions/full-stack/view-reports.md): View transaction and settlement information. - [Real-time transaction data](https://docs.payroc.com/solutions/full-stack/view-reports/real-time-transaction-data.md): Overview of tools for accessing real-time merchant transaction data, including sales, refunds, pre-authorizations, and captures via the Payroc API or Self-Care Portal. - [Settlement data](https://docs.payroc.com/solutions/full-stack/view-reports/settlement-data.md): Overview of tools for accessing and reconciling merchants' settled transaction data using the Payroc API or Payroc Insights reporting portal. - [Fund merchants](https://docs.payroc.com/solutions/full-stack/fund-merchants.md): Fund your merchants and configure funding recipients. - [Funding](https://docs.payroc.com/solutions/full-stack/fund-merchants/funding.md): Overview of the Funding solution for controlling how and when settled transaction funds are delivered to merchant bank accounts, covering standard and dynamic funding models. - [Integration guides](https://docs.payroc.com/solutions/full-stack/guides.md): Explore guides for boarding merchants, taking payments, and funding merchants with the Payroc API. ## Guides - [Guides](https://docs.payroc.com/guides.md): Build and test your Payroc integration. - [Getting started](https://docs.payroc.com/guides/getting-started.md): Learn the stages of a Payroc integration, from your discovery call to going live with our API. - [Quickstart](https://docs.payroc.com/guides/getting-started/quickstart.md): Get sandbox credentials and make your first Payroc API call. - [API keys](https://docs.payroc.com/guides/api-keys.md): Create and manage Payroc App API keys. - [Generate a Payroc App API key](https://docs.payroc.com/guides/api-keys/generate-a-payroc-app-api-key.md): Shows how to generate and view a Payroc App API key in the Self-Care Portal to authenticate with the Payroc Cloud Simulator. - [View a Payroc App API key](https://docs.payroc.com/guides/api-keys/view-a-payroc-app-api-key.md): Explains how to locate and copy a Payroc App API key from the Self-Care Portal. - [Change the settings of a Payroc App API key](https://docs.payroc.com/guides/api-keys/change-the-settings-of-a-payroc-app-api-key.md): Explains how to update the alias, notification email, API permissions, and processing terminals of a Payroc App API key using the Self-Care Portal. - [Deactivate a Payroc App API key](https://docs.payroc.com/guides/api-keys/deactivate-a-payroc-app-api-key.md): Explains how to deactivate a Payroc App API key in the Self-Care Portal, preventing its use without permanently deleting it. - [Reactivate a Payroc App API key](https://docs.payroc.com/guides/api-keys/reactivate-a-payroc-app-api-key.md): Explains how to reactivate a previously deactivated Payroc App API key using the Self-Care Portal. - [Payments](https://docs.payroc.com/guides/payments.md): Explains how to use the Payments endpoints to take card, bank account, and digital wallet payments, and to run refunds and repeat payments - [Collect a payment with the Hosted Payment Page](https://docs.payroc.com/guides/payments/hosted-payment-page.md): Redirect your customer to Payroc's hosted checkout; sale, pre-auth, and tokenize variants. - [Authenticate your requests](https://docs.payroc.com/guides/payments/hosted-payment-page/authenticate-requests.md): Create a terminal secret in the Self-Care Portal and build a SHA-512 hash to authenticate your requests to load the Hosted Payment Page. - [Load the Hosted Payment Page](https://docs.payroc.com/guides/payments/hosted-payment-page/load-payment-page.md): Add a button that sends a POST request with the transaction details and SHA-512 hash to load the Hosted Payment Page for the customer. - [Build the merchant’s receipt page](https://docs.payroc.com/guides/payments/hosted-payment-page/build-receipt-page.md): Build a receipt page that parses the transaction response query parameters the Hosted Payment Page appends and shows the customer a success or decline message. - [Implement background validation](https://docs.payroc.com/guides/payments/hosted-payment-page/background-validation.md): Set up a validation URL in the Self-Care Portal and handle the webhook notification our gateway sends to confirm whether it processed a card payment. - [Load the Hosted Payment Page](https://docs.payroc.com/guides/payments/hosted-payment-page/preauth-load-payment-page.md): Load the Hosted Payment Page for a pre-authorization by sending a POST request to the Pre-authorization Page URL with a signed HASH parameter - [Load the Hosted Payment Page](https://docs.payroc.com/guides/payments/hosted-payment-page/save-details-load-payment-page.md): Load the Hosted Payment Page to save or update a customer's payment details by sending a POST request to the Secure Card Page URL with a signed HASH parameter - [Build the merchant’s receipt page](https://docs.payroc.com/guides/payments/hosted-payment-page/save-details-build-receipt-page.md): Build a receipt page that reads the CARDREFERENCE and MERCHANTREF query parameters the Hosted Payment Page returns after saving a customer's payment details - [Capture the pre-authorization](https://docs.payroc.com/guides/payments/hosted-payment-page/capture-pre-authorization.md): Capture a pre-authorization by sending a POST request to the Payments capture endpoint with the UNIQUEREF paymentId, optionally specifying an amount to capture a partial value. - [Customize your Hosted Payment Page](https://docs.payroc.com/guides/payments/hosted-payment-page/customize-hosted-payment-page.md): Customize the look of your Hosted Payment Page to match the look and feel of your website. - [Extend your integration](https://docs.payroc.com/guides/payments/hosted-payment-page/extend-your-integration.md): Explore guides for extending a Hosted Payment Page integration, including pre-authorizations, saving payment details, repeat payments, and background validation. - [Hosted Payment Page (/guides/payments/hosted-payment-page/integration-overview)](https://docs.payroc.com/guides/payments/hosted-payment-page/integration-overview.md): Learn how the Hosted Payment Page works and follow the integration journey to run a sale, then extend your integration with optional features. - [Hosted Payment Page (/guides/payments/hosted-payment-page/overview)](https://docs.payroc.com/guides/payments/hosted-payment-page/overview.md): Learn how the Hosted Payment Page works and follow the integration journey to run a sale, then extend your integration with optional features. - [Run a pre-authorization](https://docs.payroc.com/guides/payments/hosted-payment-page/pre-authorization.md): Run a pre-authorization on the Hosted Payment Page to hold an amount on a customer's card before your merchant captures it later - [Authenticate your requests](https://docs.payroc.com/guides/payments/hosted-payment-page/preauth-authenticate-requests.md): Authenticate a pre-authorization request on the Hosted Payment Page by reusing the same SHA-512 hash setup you built to run a sale - [Build the merchant’s receipt page](https://docs.payroc.com/guides/payments/hosted-payment-page/preauth-build-receipt-page.md): Build a receipt page that reads the query parameters the Hosted Payment Page appends after a pre-authorization, including the UNIQUEREF you need to capture it later - [Authenticate your requests](https://docs.payroc.com/guides/payments/hosted-payment-page/save-details-authenticate-requests.md): Build the SHA-512 hash string needed to authenticate a request that saves a customer's payment details on the Hosted Payment Page - [Save a Customer’s Payment Details](https://docs.payroc.com/guides/payments/hosted-payment-page/save-payment-details.md): Save a customer's card or bank details on the Hosted Payment Page and get back a secure token you can use for follow-on transactions - [Set up repeat payments](https://docs.payroc.com/guides/payments/hosted-payment-page/set-up-repeat-payments.md): Set up repeat payments via the Hosted Payment Page by creating a payment plan and subscription using POST requests to the Payment Plans and Subscriptions endpoints. - [Hosted Fields](https://docs.payroc.com/guides/payments/hosted-fields.md): Add secure, gateway-hosted payment fields to your own checkout page design using Hosted Fields. - [Add your own fields](https://docs.payroc.com/guides/payments/hosted-fields/add-your-own-fields.md): Add your own HTML fields to Hosted Fields to capture extra customer or transaction information, such as address details for address verification. - [Close a Hosted Fields session](https://docs.payroc.com/guides/payments/hosted-fields/close-session.md): Call the destroy method in your JavaScript to close an idle Hosted Fields session before starting a new one. - [Authenticate your session](https://docs.payroc.com/guides/payments/hosted-fields/authenticate-your-session.md): Generate a session token for Hosted Fields by sending a POST request to the Processing Terminals hosted-fields-sessions endpoint using a Bearer token. - [Create a payment form](https://docs.payroc.com/guides/payments/hosted-fields/create-a-payment-form.md): Build a card, ACH, or PAD payment form by adding HTML fields and configuring the Hosted Fields JavaScript library with your session token. - [Extend your integration](https://docs.payroc.com/guides/payments/hosted-fields/extend-your-integration.md): Extend your Hosted Fields integration by styling fields, adding custom fields, closing sessions, and saving payment details. - [Repeat payments With Hosted Fields](https://docs.payroc.com/guides/payments/hosted-fields/repeat-payments-with-hosted-fields.md): Set up repeat payments by charging a customer's stored payment token after saving their details with Hosted Fields. - [Save payment details when running a sale](https://docs.payroc.com/guides/payments/hosted-fields/run-a-sale-tokenize.md): Save card or bank account payment details when running a sale by sending a POST request to the Payments or Bank Transfer Payments endpoint with a credentialOnFile object. - [Run a sale](https://docs.payroc.com/guides/payments/hosted-fields/run-a-sale.md): Run a card or bank account sale using a Hosted Fields single-use token by sending a POST request to the Payments or Bank Transfer Payments endpoint. - [Save a customer's payment details](https://docs.payroc.com/guides/payments/hosted-fields/save-payment-details-overview.md): Convert a single-use payment token into a reusable secure token to save a customer's payment details for a future or repeat payment. - [Save a customer's payment details](https://docs.payroc.com/guides/payments/hosted-fields/save-payment-details.md): Convert a Hosted Fields single-use token into a reusable secure token by sending a POST request to the Secure Tokens endpoint, enabling future card and bank account payments without recapturing… - [Styling your Hosted Fields](https://docs.payroc.com/guides/payments/hosted-fields/styling-hosted-fields.md): Customize the look of your Hosted Fields payment form by replacing the default CSS and responding to the fieldValidityChange event. - [Update a customer's payment details](https://docs.payroc.com/guides/payments/hosted-fields/update-payment-details.md): Update a customer's saved payment details by submitting a single-use token from Hosted Fields to the Secure Tokens update-account endpoint. - [Apple Pay®](https://docs.payroc.com/guides/payments/apple-pay.md): Add Apple Pay to your integration so merchants can accept Apple Pay as a payment method for online transactions. - [Set up Apple Pay for a merchant](https://docs.payroc.com/guides/payments/apple-pay/set-up-apple-pay-merchant.md): Configure Apple Pay for a merchant by adding the domain verification file and registering the domain in the Self-Care Portal to generate a unique merchant domain ID. - [Add a convenience fee](https://docs.payroc.com/guides/payments/apple-pay/add-a-convenience-fee.md): Apply a convenience fee to Apple Pay payments by including the multiTokenContexts array in your ApplePayPaymentRequest and sending a single payment request to our gateway. - [Split a payment with multiple merchants](https://docs.payroc.com/guides/payments/apple-pay/split-a-payment-with-multiple-merchants.md): Split an Apple Pay payment between multiple merchants using the multi-merchant of record (MMoR) function by sending the multiTokenContexts array to Apple Pay and individual payment requests to our… - [Add Apple Pay to your integration](https://docs.payroc.com/guides/payments/apple-pay/apple-pay-integrate.md): Integrate Apple Pay by starting a merchant session via the Apple Pay sessions endpoint and running a sale via the Payments endpoint with encrypted digital wallet data. - [Extend your integration](https://docs.payroc.com/guides/payments/apple-pay/extend-your-integration.md): Extend your Apple Pay integration to add convenience fees or split payments between multiple merchants using the multi-merchant of record function. - [Google Pay](https://docs.payroc.com/guides/payments/google-pay.md): Add Google Pay to your integration so merchants can accept Google Pay as a payment method for online transactions. - [Add Google Pay to your integration](https://docs.payroc.com/guides/payments/google-pay/google-pay-integrate.md): Integrate Google Pay by retrieving encrypted payment details from the Google Pay API and submitting them to the POST /v1/payments endpoint with a digitalWallet paymentMethod type. - [Payroc Cloud](https://docs.payroc.com/guides/payments/payroc-cloud.md): Explore guides for configuring your payment device, running a sale, and extending your Payroc Cloud integration with refunds and signature capture. - [Device setup](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup.md): Configure ID TECH and Ingenico devices. - [ID TECH - Linux](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup/idtech-linux.md): Set up the Payroc Cloud middleware on a Linux host machine so it can connect to your ID TECH card reader and communicate with our gateway. - [ID TECH - Windows](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup/idtech-windows.md): Set up the Payroc Cloud middleware on a Windows host machine so it can connect to your ID TECH card reader and communicate with our gateway. - [Ingenico - Linux](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup/ingenico-linux.md): Set up the Payroc Cloud middleware on a Linux host machine so it can connect to your Ingenico card reader and communicate with our gateway. - [Ingenico - Windows](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup/ingenico-windows.md): Set up the Payroc Cloud middleware on a Windows host machine so it can connect to your Ingenico card reader and communicate with our gateway. - [Android (POS on a different device)](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup/android-diff-device.md): Connect your POS to an Android payment device running the Payroc App over the internet, so the app can process payments while your POS handles checkout. - [Android (POS on the same device)](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup/android-same-device.md): Configure your Android payment device to run your POS app and the Payroc App together, including permissions, app switching, and Paxstore upload. - [ID TECH](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup/idtech.md): Connect an ID TECH card reader to your POS through the Payroc Cloud middleware, choosing the setup guide for your Windows or Linux host machine. - [Ingenico](https://docs.payroc.com/guides/payments/payroc-cloud/device-setup/ingenico.md): Connect an Ingenico card reader to your POS through the Payroc Cloud middleware, choosing the setup guide for your Windows or Linux host machine. - [Capture a signature](https://docs.payroc.com/guides/payments/payroc-cloud/capture-signature.md): Capture a cardholder's signature on a Payroc Cloud device by submitting a signature instruction, polling for its status, and retrieving the captured signature image. - [Extend your solution](https://docs.payroc.com/guides/payments/payroc-cloud/extend-your-integration.md): Extend your Payroc Cloud integration with signature capture, referenced and unreferenced refunds, and transaction reversal. - [Run a sale](https://docs.payroc.com/guides/payments/payroc-cloud/run-sale.md): Run a card sale on a Payroc Cloud device by submitting a payment instruction via POST to the Devices endpoint, polling for status, and retrieving the final payment result. - [Run unreferenced refunds](https://docs.payroc.com/guides/payments/payroc-cloud/run-unreferenced-refund.md): Submit an unreferenced refund instruction to a Payroc Cloud device by sending a POST request to the Devices endpoint, then poll for status and retrieve refund details. - [Payment Links](https://docs.payroc.com/guides/payments/payment-links.md): Explains how to use Payment Links to create a hosted payment page that a merchant can share with a customer - [Create and share a payment link](https://docs.payroc.com/guides/payments/payment-links/create-share-link.md): Create a payment link and share it with customers by sending POST requests to the Processing Terminals and Payment Links endpoints. - [Extend your integration](https://docs.payroc.com/guides/payments/payment-links/extend-your-integration.md): Extend a payment links integration by sharing, updating, retrieving, listing, or deactivating payment links - [Refunds](https://docs.payroc.com/guides/payments/refunds.md): Explains referenced refunds, unreferenced refunds, and reversals, and when to use each one to return funds to a customer - [Send a referenced refund to a bank account](https://docs.payroc.com/guides/payments/refunds/referenced-refund-bank.md): Refund a bank transfer payment by sending a POST request to the Bank Transfer Payments Refund endpoint using the original paymentId. - [Run a referenced refund for a card payment](https://docs.payroc.com/guides/payments/refunds/referenced-refund-card.md): Refund a card payment by sending a POST request to the Payments endpoint using the original paymentId, with optional GET requests to retrieve payment details first. - [Send an unreferenced refund to a customer’s bank account](https://docs.payroc.com/guides/payments/refunds/unreferenced-refund-bank.md): Send an unreferenced refund to a customer's bank account by posting to the Bank Transfer Refunds endpoint without a paymentId. - [Run an unreferenced refund for a card payment](https://docs.payroc.com/guides/payments/refunds/unreferenced-refund-card.md): Run an unreferenced card refund by sending a POST request to the Refunds endpoint without a paymentId to return funds to a customer's card. - [Reverse a bank transfer payment](https://docs.payroc.com/guides/payments/refunds/void-bank.md): Reverse a bank transfer payment in an open batch by sending a POST request to the Bank Transfer Payments reverse endpoint with the paymentId. - [Reverse a card sale or a pre-authorization](https://docs.payroc.com/guides/payments/refunds/void-card.md): Reverse a card sale or pre-authorization in an open batch by sending a POST request to the Reverse endpoint with the paymentId. - [Repeat payments](https://docs.payroc.com/guides/payments/repeat-payments.md): Run recurring payments with your software or the gateway. - [Use our gateway](https://docs.payroc.com/guides/payments/repeat-payments/using-our-gateway-for-recurring-billing.md): Set up recurring billing by creating a payment plan, saving a secure token, and assigning a customer to a subscription via POST requests to the Payment Plans, Secure Tokens, and Subscriptions… - [Use your own software](https://docs.payroc.com/guides/payments/repeat-payments/using-your-own-system-for-recurring-billing.md): Set up recurring billing using your own software by creating secure tokens and sending POST requests to the Payments endpoint with standingInstructions to manage the payment cycle. - [Tap to Pay on iPhone](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone.md): Use our Tap to Pay on iPhone SDK to accept contactless card-present payments directly on an iPhone without an external card reader. - [Add a line item](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/add-a-line-item.md): Add itemized product details to a Tap to Pay on iPhone sale using the CoreLineItem object, including a per-item tax. - [Add a tax](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/add-a-tax.md): Add a predefined tax or a custom tax to a Tap to Pay on iPhone sale using the CoreTax object. - [Add a tip](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/add-a-tip.md): Add a predefined tip or a custom tip to a Tap to Pay on iPhone sale using the CoreTip object. - [Cancel a sale](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/cancel-a-sale.md): Cancel an in-progress sale with the Tap to Pay on iPhone SDK, and handle the cancellation status that the SDK returns. - [Configure the processing terminal](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/configure-the-processing-terminal.md): Configure the Tap to Pay on iPhone terminal by initializing it locally, setting the operating mode, and loading your settings from our gateway. - [Extend your integration](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/extend-your-integration.md): Extend your Tap to Pay on iPhone integration with refunds, transaction reporting, tips, taxes, line items, and surcharges. - [Handle errors](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/handle-errors.md): Handle transaction, communication, and device errors in your Tap to Pay on iPhone integration, and resolve a sale with an unknown outcome after a communication failure. - [Handle surcharges](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/handle-surcharges.md): Handle surcharges with Tap to Pay on iPhone by reading your terminal's surcharge settings, presenting the fee for confirmation, and letting the customer bypass it. - [Retrieve transactions](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/retrieve-transactions.md): Retrieve a single transaction or list multiple transactions with the Tap to Pay on iPhone SDK using the reporting listener. - [Run a refund](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/run-a-refund.md): Run a referenced refund with the Tap to Pay on iPhone SDK using the uniqueRef of the original sale. - [Run a sale](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/run-a-sale.md): Run a sale with Tap to Pay on iPhone by registering your listeners, initializing the contactless reader, and processing a CoreSale object. - [Run the sample apps](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/run-the-sample-apps.md): Run the Swift or Objective-C sample app from the Tap to Pay on iPhone SDK package by configuring signing, adding your API key, and setting your terminal ID. - [Set up the SDK](https://docs.payroc.com/guides/payments/tap-to-pay-on-iphone/set-up-the-sdk.md): Add the Tap to Pay on iPhone SDK to your Xcode project, link the libraries, and configure your build settings. - [3-D Secure](https://docs.payroc.com/guides/payments/three-d-secure.md): Explains how 3-D Secure verifies a cardholder's identity during online transactions and how it fits into your integration - [Run a sale with 3-D Secure](https://docs.payroc.com/guides/payments/three-d-secure/run-a-sale-with-3-d-secure.md): Run a card sale with 3-D Secure authentication by sending an MPI request to verify the cardholder's identity, then submitting the MPI reference in a POST request to the Payments endpoint. - [Add custom fields to your integration](https://docs.payroc.com/guides/payments/add-custom-fields.md): Add merchant-defined custom fields to card payments, bank transfers, refunds, subscriptions, and secure token requests using the customFields object. - [Close an ACH payment](https://docs.payroc.com/guides/payments/close-ach.md): Close an ACH payment: If NACHA returned an ACH payment and the merchant accepted an alternative payment method, you can use our API to close the return without re-presenting the payment to NACHA. - [Re-present an ACH payment](https://docs.payroc.com/guides/payments/represent-ach.md): Retrieve the reason a bank transfer payment failed and resubmit it by sending a GET and then a POST request to the Bank Transfer Payments endpoint - [Run a card sale](https://docs.payroc.com/guides/payments/run-a-card-sale.md): Run a card sale by sending a POST request to the Payments endpoint with card details and amount to take funds from a customer's card. - [Run a pre-authorization](https://docs.payroc.com/guides/payments/run-a-pre-authorization.md): Hold funds on a customer's card by sending a POST request to the Payments endpoint with autoCapture and processAsSale set to false, then optionally adjust and finally capture the pre-authorization. - [Run a sale with bank account details](https://docs.payroc.com/guides/payments/run-sale-using-bank-details.md): Run a bank transfer payment by sending a POST request to the Bank Transfer Payments endpoint with ACH or PAD bank account details and amount. - [Save payment details](https://docs.payroc.com/guides/payments/save-payment-details.md): Save a customer's payment details to the vault by sending a POST request to the secure-tokens endpoint, returning a secureTokenId for use in follow-on card or bank transfer transactions. - [Update saved payment details](https://docs.payroc.com/guides/payments/update-saved-payment-details.md): Update a customer's saved payment details by sending a PATCH request to the Update Secure Token endpoint or a POST request to the Update Account Details endpoint using a single-use token. - [Testing](https://docs.payroc.com/guides/testing.md): Send requests to the Payroc Cloud Simulator. - [Send test requests to our gateway](https://docs.payroc.com/guides/testing/send-test-requests-to-our-gateway.md): Step-by-step guide for using the Payroc Cloud Simulator to send test payment and refund requests to the gateway, including accessing the simulator and reviewing outcomes. - [Bank Payments](https://docs.payroc.com/guides/testing/bank-payments.md): Test values and return codes for validating bank payment integrations in the test environment. - [Funding](https://docs.payroc.com/guides/testing/funding-instructions.md): Test cases for verifying funding recipients, funding accounts, funding instructions, and funding activity integrations against the Payroc API. - [Payments](https://docs.payroc.com/guides/testing/online-payments.md): Test cases and test data for validating online payment integrations including card payments, secure tokens, payment plans, and bank transfers in the test environment. - [Payroc Cloud](https://docs.payroc.com/guides/testing/payroc-cloud.md): Test cases and test data for validating a Payroc Cloud physical POS integration before going live. - [Board a merchant](https://docs.payroc.com/guides/boarding.md): Board a merchant by creating a merchant platform with processing accounts, owners, contacts, and a terminal order. - [Add an attachment to a processing account](https://docs.payroc.com/guides/boarding/add-attachment-to-processing-account.md): Upload a document to a processing account by sending a POST request to the Processing Accounts attachments endpoint, then optionally check the upload status via the Attachments endpoint. - [Create a merchant platform](https://docs.payroc.com/guides/boarding/merchant-platform.md): Create a merchant platform by sending a POST request to the merchant-platforms endpoint with the business's legal information, then optionally send a reminder to prompt the merchant's signature. - [Order a terminal](https://docs.payroc.com/guides/boarding/order-a-terminal.md): Order one or more terminals for a processing account by sending a POST request to the processing accounts terminal-orders endpoint with training, shipping, and solution details. - [Create a pricing intent](https://docs.payroc.com/guides/boarding/pricing-intent.md): Create a pricing intent by sending a POST request to the Pricing Intents endpoint, defining base fees, processor fees, and gateway fees to use as a reusable template for merchant processing accounts. - [Add a processing account to a merchant platform](https://docs.payroc.com/guides/boarding/processing-account-create.md): Add a processing account to an existing merchant platform by sending a POST request to the Merchant Platforms endpoint with business, owner, processing, and pricing details. - [Event subscriptions](https://docs.payroc.com/guides/events.md): Subscribe to account changes and handle webhook notifications sent by our gateway. - [Create an event subscription](https://docs.payroc.com/guides/events/create-event-subscription.md): Create an event subscription by sending a POST request to the event-subscriptions endpoint to receive webhook notifications when specified events occur. - [Fund merchants](https://docs.payroc.com/guides/funding.md): Configure funding recipients and instructions. - [Send funds to your merchants](https://docs.payroc.com/guides/funding/create-funding-instructions.md): Send funds to your merchants by creating a Funding Instruction with a POST request to the Funding Instructions endpoint, optionally checking available balance first via GET /v1/funding-balance. - [Set up a funding recipient](https://docs.payroc.com/guides/funding/create-funding-recipients.md): Create a funding recipient by sending a POST request to the Funding Recipients endpoint, enabling third-party entities such as charities to receive funds from your account. ## Knowledge - [Knowledge](https://docs.payroc.com/knowledge.md): Understand Payroc API behavior and payment concepts. - [API basics](https://docs.payroc.com/knowledge/api-basics.md): Understand authentication, requests and API behavior. - [Getting started with the Payroc API](https://docs.payroc.com/knowledge/api-basics/getting-started.md): Sandbox account, API keys, and your first authenticated request. - [API keys](https://docs.payroc.com/knowledge/api-basics/api-keys.md): Explains the two types of API keys used to authenticate requests to the Payroc gateway — the standard API key for Bearer token generation and the Payroc App API key for terminal access. - [Hypermedia as the engine of application state (HATEOAS)](https://docs.payroc.com/knowledge/api-basics/hateoas.md): Explains how the Payroc API uses HATEOAS links to surface related resources and paginate large result sets within API responses. - [Glossary](https://docs.payroc.com/knowledge/api-basics/glossary.md): Definitions of payment industry terms, acronyms, and Payroc-specific concepts used across the developer documentation. - [Units of measurement](https://docs.payroc.com/knowledge/api-basics/unit-of-measure.md): Reference list of unit of measurement codes supported by the Payroc API, covering weight, volume, length, time, energy, and quantity units. - [Payments](https://docs.payroc.com/knowledge/payments.md): Understand payment methods, processing and transaction behavior. - [Credit card surcharging](https://docs.payroc.com/knowledge/payments/surcharging.md): Explains how credit card surcharging works, including how merchants add a fee to cover card processing costs and the rules governing surcharge rates and disclosure. - [Tokenization](https://docs.payroc.com/knowledge/payments/tokenization.md): Explains how tokenization replaces sensitive payment details with reusable secure tokens or single-use tokens, enabling repeat payments without additional PCI compliance requirements. - [Interchange fee](https://docs.payroc.com/knowledge/payments/interchange.md): Explains how interchange fees are structured, what card brands charge for network use, and what factors determine which interchange category a transaction is assigned. - [Refunds and reversals](https://docs.payroc.com/knowledge/payments/refunds-and-reversals.md): Explains the difference between refunds and reversals for card payments, including referenced and unreferenced refund types and when each applies. - [Dynamic currency conversion](https://docs.payroc.com/knowledge/payments/currency-conversion.md): Explains how Dynamic Currency Conversion (DCC) lets cardholders pay in their home currency at point of sale, including eligibility requirements, regulations, and decision screen rules. - [Repeat payments](https://docs.payroc.com/knowledge/payments/repeat-payments.md): Explains recurring payments and installment payments, and how to choose between your own software or our gateway to manage them - [Dynamic descriptors](https://docs.payroc.com/knowledge/payments/dynamic-descriptors.md): Explains how dynamic descriptors let merchants customize the transaction text displayed on a customer's card statement to reduce chargebacks. - [Payment plans and subscriptions](https://docs.payroc.com/knowledge/payments/payment-plans.md): Explains how payment plans and subscriptions work together to enable merchants to take recurring and installment payments from customers. - [Offline processing](https://docs.payroc.com/knowledge/payments/offline-processing.md): Explains how offline processing allows terminals to accept card payments without a gateway connection and store them for later submission. - [Payment method verification](https://docs.payroc.com/knowledge/payments/payment-method-verification.md): Explains the methods available for verifying a cardholder's identity during a transaction, including PIN, signature, AVS, CVV, and 3-D Secure. - [3-D Secure](https://docs.payroc.com/knowledge/payments/threedsecure.md): Explains how 3-D Secure authentication works to prevent e-commerce fraud by verifying cardholder identity with the issuing bank. - [Enhanced data](https://docs.payroc.com/knowledge/payments/enhanced-data.md): Explains how to add enhanced data to card payments and qualify for lower interchange rates. - [Payroc Cloud](https://docs.payroc.com/knowledge/payroc-cloud.md): Explains how Payroc Cloud works as a semi-integrated payments solution, enabling POS systems to communicate with payment devices through the Payroc gateway. - [How to send a signature to our gateway](https://docs.payroc.com/knowledge/payroc-cloud/signature-capture.md): Explains how to capture and encode a customer's handwritten signature as a base-28 coordinate string for submission to the Payroc gateway. - [Supported Devices](https://docs.payroc.com/knowledge/payroc-cloud/supported-devices.md): Reference for all card-reading devices supported across Payroc solutions, including device type, operating environment, certified processors, and integration requirements. - [Testing](https://docs.payroc.com/knowledge/testing.md): Use the simulator and its test transaction values. - [Test transaction values](https://docs.payroc.com/knowledge/testing/test-transaction-values.md): Reference of dollar amounts to use with the Payroc Cloud Simulator to trigger specific card entry methods and transaction behaviors during testing. - [Payroc Cloud Simulator](https://docs.payroc.com/knowledge/testing/payroc-cloud-simulator.md): Explains how to use the Payroc Cloud Simulator web app to test card-present payment requests in a virtual environment without a physical device or test card. - [Boarding](https://docs.payroc.com/knowledge/boarding.md): Understand pricing before boarding merchants. - [Pricing intents](https://docs.payroc.com/knowledge/boarding/pricing-intents.md): Explains how pricing intents work as fee templates that define base, gateway, and processor fees for merchants before boarding. - [Data migration](https://docs.payroc.com/knowledge/data-migration.md): Move payment data from another provider. - [Migrate data from another payments provider](https://docs.payroc.com/knowledge/data-migration/migrate-data.md): Explains how to migrate tokenized card data and PANs from another payments provider to Payroc using PGP encryption. - [Migrate payment data from another provider](https://docs.payroc.com/knowledge/data-migration/token-import.md): Explains how to migrate existing payment tokens from another provider to Payroc by contacting the Gateway Team, formatting a CSV file, encrypting it with PGP, and submitting it via SFTP. - [Integration tools](https://docs.payroc.com/knowledge/tooling.md): Find tools for building your integration. - [Payroc Skills Marketplace](https://docs.payroc.com/knowledge/tooling/skills-marketplace.md): Overview of the Payroc Skills Marketplace, listing available AI-optimized skills for integrating Hosted Fields, Hosted Payment Page, Payment Links, Apple Pay, Google Pay, Payroc Cloud, and Boarding. - [Events list](https://docs.payroc.com/knowledge/events.md): Reference list of all subscribable API events, explaining the CloudEvents format used for webhook notifications. - [processingAccount.riskStatus.changed](https://docs.payroc.com/knowledge/events/processingaccount-riskstatus-changed.md): processingAccount.riskStatus.changed: Event type: processingAccount.riskStatus.changed\ - [processingAccount.signature.signed](https://docs.payroc.com/knowledge/events/processingaccount-signature-signed.md): processingAccount.signature.signed: Event type: processingAccount.signature.signed\ - [processingAccount.status.changed](https://docs.payroc.com/knowledge/events/processingaccount-status-changed.md): Explains the processingAccount.status.changed event, which fires when a processing account's status changes, and describes the notification payload and possible status values. - [terminalOrder.status.changed](https://docs.payroc.com/knowledge/events/terminal-order-status-changed.md): Explains the terminalOrder.status.changed webhook event, which fires when Payroc updates the status of a terminal order such as shipping or cancellation. ## API reference - [OpenAPI specification (JSON)](https://docs.payroc.com/openapi.json): Every operation, schema and example of the API, as JSON. - [OpenAPI specification (YAML)](https://docs.payroc.com/openapi.yaml): The same specification as YAML. - [Introduction](https://docs.payroc.com/api.md): Overview of the Payroc API, covering merchant boarding, funding accounts, transaction processing, and core features such as idempotency, metadata, pagination, and versioning. - [Authentication](https://docs.payroc.com/api/authentication.md): How to authenticate Payroc API requests using API keys and Bearer tokens, including Identity Service endpoints, required request headers, and API key best practices. - [Idempotency](https://docs.payroc.com/api/idempotency.md): Explains how the Payroc API implements idempotency for POST and PATCH requests using the Idempotency-Key header to prevent duplicate processing. - [Metadata](https://docs.payroc.com/api/metadata.md): Guide to using metadata in the Payroc API — attaching custom key-value pairs to resources for auditing, troubleshooting, and third-party system integration. - [Pagination](https://docs.payroc.com/api/pagination.md): How to use cursor-based pagination with the Payroc API, including request parameters, response fields, and navigating pages of results. - [Versioning](https://docs.payroc.com/api/versioning.md): Explains the Payroc API agile versioning strategy, including how backward compatibility is maintained and how version numbers are incremented and specified in request URLs. - [Errors](https://docs.payroc.com/api/errors.md): Reference for all RFC-7807 error codes returned by the Payroc API, including error structure, causes, and example responses for each error type. - [Postman Collection](https://docs.payroc.com/api/postman-collection.md): Step-by-step guide to setting up and authorizing the Payroc Postman collection for testing API requests. - [API resources](https://docs.payroc.com/api/resources.md): Authored introductions to resources in the canonical payment API. - [Bank transfer payments](https://docs.payroc.com/api/resources/bank-transfer-payments.md): Reference for the bank transfer payment endpoints, covering how to create, retrieve, list, and re-present payments taken from a customer's bank account. - [Bank transfer refunds](https://docs.payroc.com/api/resources/bank-transfer-refunds.md): Reference for the bank transfer refund endpoints, covering how to reverse, refund, retrieve, list, and reverse refunds for bank transfer payments. - [Card Payments](https://docs.payroc.com/api/resources/card-payments.md): Reference for the card payment endpoints, covering how to create, retrieve, list, adjust, and capture payments taken from a card. - [Card payment refunds](https://docs.payroc.com/api/resources/card-refunds.md): Reference for the card refund endpoints, covering how to reverse, refund, retrieve, list, adjust, and reverse refunds for card transactions. - [Contacts](https://docs.payroc.com/api/resources/contacts.md): Reference for the contact endpoints, covering how to retrieve, update, and delete a contact linked to a processing account. - [Event Subscriptions](https://docs.payroc.com/api/resources/event-subscriptions.md): Reference for the event subscription endpoints, covering how to create, retrieve, list, update, and delete subscriptions that send you notifications when a resource changes. - [Funding Accounts](https://docs.payroc.com/api/resources/funding-accounts.md): Reference for the funding account endpoints, covering how to retrieve, list, update, and delete funding accounts linked to processing accounts and funding recipients. - [Funding Activity](https://docs.payroc.com/api/resources/funding-activity.md): Reference for the funding activity endpoints, covering how to list funding balances and funding activity for merchants linked to your account. - [Funding Instructions](https://docs.payroc.com/api/resources/funding-instructions.md): Reference for the funding instruction endpoints, covering how to create, retrieve, list, update, and delete instructions that tell us how to distribute funds to your merchants. - [Funding Recipients](https://docs.payroc.com/api/resources/funding-recipients.md): Reference for the funding recipient endpoints, covering how to create, retrieve, list, update, and delete a funding recipient along with its accounts and owners. - [Merchant Platforms](https://docs.payroc.com/api/resources/merchant-platforms.md): Reference for the merchant platform endpoints, covering how to create and retrieve a merchant platform, and how to list and add its processing accounts. - [Owners](https://docs.payroc.com/api/resources/owners.md): Reference for the owner endpoints, covering how to retrieve, update, and delete an owner of a processing account or a funding recipient. - [Payment Features - Cards](https://docs.payroc.com/api/resources/cards.md): Reference for the card payment feature endpoints, covering how to verify a card, view an EBT balance, look up BIN information, and check DCC eligibility. - [Payment Links](https://docs.payroc.com/api/resources/payment-links.md): Reference for the payment link endpoints, covering how to create, share, update, retrieve, list, and deactivate a payment link that a customer uses to pay for goods or services. - [Payroc Cloud](https://docs.payroc.com/api/resources/payroc-cloud.md): Reference for the Payroc Cloud endpoints, covering how to submit, retrieve, and cancel payment, refund, and signature instructions, and how to read a closed-loop card. - [Pricing Intents](https://docs.payroc.com/api/resources/pricing-intents.md): Reference for the pricing intent endpoints, covering how to create, retrieve, list, update, and delete a template of fees assigned to a processing account. - [Processing accounts](https://docs.payroc.com/api/resources/processing-accounts.md): Reference for the processing account endpoints, covering how to retrieve account details, pricing agreements, funding accounts, owners, contacts, and terminal orders. - [Processing terminals](https://docs.payroc.com/api/resources/processing-terminals.md): Reference for the processing terminal endpoints, covering how to retrieve terminal, host, and device configuration details, and how to close a batch. - [Payment Plans](https://docs.payroc.com/api/resources/payment-plans.md): Reference for the payment plan endpoints, covering how to create, retrieve, list, update, and delete a schedule that defines how often and how much a gateway collects. - [Subscriptions](https://docs.payroc.com/api/resources/subscriptions.md): Reference for the subscription endpoints, covering how to create, retrieve, list, update, deactivate, reactivate, and manually collect a repeat payment from a customer. - [Secure tokens](https://docs.payroc.com/api/resources/secure-tokens.md): Reference for the secure token endpoints, covering how to create, retrieve, list, update, and delete a token that represents a customer's saved payment details. ## Workflows - [Upload a document to a processing account, then optionally retrieve it.](https://docs.payroc.com/workflows/add-attachment.md): Upload a document to a processing account, then optionally retrieve it. - [Confirm a boarded merchant's hierarchy and status via read-only reads.](https://docs.payroc.com/workflows/review-merchant-hierarchy.md): Confirm a boarded merchant's hierarchy and status via read-only reads. - [Create a merchant platform, then optionally remind the merchant to sign.](https://docs.payroc.com/workflows/create-merchant-platform.md): Create a merchant platform, then optionally remind the merchant to sign. - [Create a processing account on a merchant platform, then optionally remind the merchant to sign.](https://docs.payroc.com/workflows/add-processing-account.md): Create a processing account on a merchant platform, then optionally remind the merchant to sign. - [Create a reusable pricing intent (fee template) for processing accounts.](https://docs.payroc.com/workflows/create-pricing-intent.md): Create a reusable pricing intent (fee template) for processing accounts. - [Create a terminal order for a processing account and track its status.](https://docs.payroc.com/workflows/order-a-terminal.md): Create a terminal order for a processing account and track its status. - [Create pricing, board the merchant platform, add accounts/terminals, and upload documents.](https://docs.payroc.com/workflows/board-a-merchant.md): Create pricing, board the merchant platform, add accounts/terminals, and upload documents. - [Create, list, retrieve, and delete a pricing intent.](https://docs.payroc.com/workflows/manage-pricing-intents.md): Create, list, retrieve, and delete a pricing intent. - [Fully replace a pricing intent via PUT.](https://docs.payroc.com/workflows/replace-a-pricing-intent.md): Fully replace a pricing intent via PUT. - [List, retrieve, then delete a processing account's contact.](https://docs.payroc.com/workflows/delete-a-contact.md): List, retrieve, then delete a processing account's contact. - [List, retrieve, then delete an owner of a funding recipient.](https://docs.payroc.com/workflows/delete-an-owner.md): List, retrieve, then delete an owner of a funding recipient. - [List, retrieve, then update (full PUT replace) a processing account's contact.](https://docs.payroc.com/workflows/update-a-contact.md): List, retrieve, then update (full PUT replace) a processing account's contact. - [List, retrieve, then update (full PUT) an owner.](https://docs.payroc.com/workflows/update-an-owner.md): List, retrieve, then update (full PUT) an owner. - [Partially update a pricing intent via PATCH.](https://docs.payroc.com/workflows/patch-a-pricing-intent.md): Partially update a pricing intent via PATCH. - [Create a funding recipient, optionally check the balance, then send funds via a funding instruction.](https://docs.payroc.com/workflows/send-funds-to-a-merchant.md): Create a funding recipient, optionally check the balance, then send funds via a funding instruction. - [Create a funding recipient, then optionally add extra accounts and owners.](https://docs.payroc.com/workflows/set-up-a-funding-recipient.md): Create a funding recipient, then optionally add extra accounts and owners. - [Discover a funding recipient, retrieve it, and read its nested accounts and owners.](https://docs.payroc.com/workflows/manage-funding-recipients.md): Discover a funding recipient, retrieve it, and read its nested accounts and owners. - [List, retrieve, then delete a funding account.](https://docs.payroc.com/workflows/delete-a-funding-account.md): List, retrieve, then delete a funding account. - [List, retrieve, then delete a funding instruction.](https://docs.payroc.com/workflows/delete-a-funding-instruction.md): List, retrieve, then delete a funding instruction. - [List, retrieve, then delete a funding recipient.](https://docs.payroc.com/workflows/delete-a-funding-recipient.md): List, retrieve, then delete a funding recipient. - [List, retrieve, then update (full PUT) a funding recipient.](https://docs.payroc.com/workflows/update-a-funding-recipient.md): List, retrieve, then update (full PUT) a funding recipient. - [List, retrieve, then update (replace) a funding instruction.](https://docs.payroc.com/workflows/update-a-funding-instruction.md): List, retrieve, then update (replace) a funding instruction. - [List, retrieve, then update a funding account.](https://docs.payroc.com/workflows/update-a-funding-account.md): List, retrieve, then update a funding account. - [Read funding balances then the funding activity ledger.](https://docs.payroc.com/workflows/review-funding-activity.md): Read funding balances then the funding activity ledger. - [Create an event subscription, then discover, retrieve, and delete it.](https://docs.payroc.com/workflows/create-event-subscription.md): Create an event subscription, then discover, retrieve, and delete it. - [Fully replace an event subscription via PUT.](https://docs.payroc.com/workflows/update-an-event-subscription.md): Fully replace an event subscription via PUT. - [Partially update an event subscription via PATCH.](https://docs.payroc.com/workflows/patch-an-event-subscription.md): Partially update an event subscription via PATCH. - [Close the current batch for a processing terminal.](https://docs.payroc.com/workflows/close-a-terminal-batch.md): Close the current batch for a processing terminal. - [Collect a payment via Payroc's redirect-based Hosted Payment Page, optionally capturing a pre-authorization afterward.](https://docs.payroc.com/workflows/collect-with-hosted-payment-page.md): Collect a payment via Payroc's redirect-based Hosted Payment Page, optionally capturing a pre-authorization afterward. - [Create a Hosted Fields session, tokenize card details client-side, then run the sale.](https://docs.payroc.com/workflows/collect-with-hosted-fields.md): Create a Hosted Fields session, tokenize card details client-side, then run the sale. - [Create a payment link, share it by email, track sharing events, and manage its lifecycle.](https://docs.payroc.com/workflows/collect-with-payment-link.md): Create a payment link, share it by email, track sharing events, and manage its lifecycle. - [Create a payment plan, save the customer's payment method, then subscribe the customer to the plan.](https://docs.payroc.com/workflows/set-up-repeat-payments.md): Create a payment plan, save the customer's payment method, then subscribe the customer to the plan. - [Create a reusable secure token from a customer's card or bank account.](https://docs.payroc.com/workflows/save-a-payment-method.md): Create a reusable secure token from a customer's card or bank account. - [Create a single-use token, run a payment, optionally reverse it](https://docs.payroc.com/workflows/pay-with-single-use-token.md): Create a single-use token, run a payment, optionally reverse it - [Create a tokenization session, tokenize card details client-side, then mint a reusable secure token.](https://docs.payroc.com/workflows/save-a-card-with-hosted-fields.md): Create a tokenization session, tokenize card details client-side, then mint a reusable secure token. - [Create, list, and retrieve a payment plan](https://docs.payroc.com/workflows/manage-payment-plans.md): Create, list, and retrieve a payment plan - [Create, list, retrieve, update, and manually pay a subscription](https://docs.payroc.com/workflows/manage-subscriptions.md): Create, list, retrieve, update, and manually pay a subscription - [Deactivate a subscription to stop collection.](https://docs.payroc.com/workflows/deactivate-a-subscription.md): Deactivate a subscription to stop collection. - [List payments, retrieve the target payment, then adjust it](https://docs.payroc.com/workflows/adjust-a-payment.md): List payments, retrieve the target payment, then adjust it - [List, retrieve, then adjust a card refund.](https://docs.payroc.com/workflows/adjust-a-refund.md): List, retrieve, then adjust a card refund. - [List, retrieve, then delete a payment plan.](https://docs.payroc.com/workflows/delete-a-payment-plan.md): List, retrieve, then delete a payment plan. - [List, retrieve, then delete a secure token.](https://docs.payroc.com/workflows/delete-a-saved-payment-method.md): List, retrieve, then delete a secure token. - [List, retrieve, then refresh a secure token from a single-use token.](https://docs.payroc.com/workflows/refresh-a-saved-payment-method.md): List, retrieve, then refresh a secure token from a single-use token. - [List, retrieve, then reverse (cancel) a bank-transfer refund.](https://docs.payroc.com/workflows/reverse-a-bank-transfer-refund.md): List, retrieve, then reverse (cancel) a bank-transfer refund. - [List, retrieve, then reverse (cancel) a card refund.](https://docs.payroc.com/workflows/reverse-a-refund.md): List, retrieve, then reverse (cancel) a card refund. - [List, retrieve, then update a payment plan via JSON Patch.](https://docs.payroc.com/workflows/update-a-payment-plan.md): List, retrieve, then update a payment plan via JSON Patch. - [List, retrieve, then update a secure token via JSON Patch.](https://docs.payroc.com/workflows/update-a-saved-payment-method.md): List, retrieve, then update a secure token via JSON Patch. - [Look up and reverse a bank-transfer payment in an open batch.](https://docs.payroc.com/workflows/reverse-a-bank-transfer-payment.md): Look up and reverse a bank-transfer payment in an open batch. - [Look up and reverse a card payment in an open batch.](https://docs.payroc.com/workflows/reverse-a-card-payment.md): Look up and reverse a card payment in an open batch. - [Look up card details from a BIN.](https://docs.payroc.com/workflows/look-up-bin.md): Look up card details from a BIN. - [Pre-authorize a card, optionally adjust the amount, capture, and optionally refund.](https://docs.payroc.com/workflows/run-a-pre-authorization.md): Pre-authorize a card, optionally adjust the amount, capture, and optionally refund. - [Reactivate a subscription to resume collection.](https://docs.payroc.com/workflows/reactivate-a-subscription.md): Reactivate a subscription to resume collection. - [Referenced refund of an existing bank-transfer / ACH payment.](https://docs.payroc.com/workflows/refund-a-bank-transfer-payment.md): Referenced refund of an existing bank-transfer / ACH payment. - [Referenced refund of an existing card payment.](https://docs.payroc.com/workflows/refund-a-card-payment.md): Referenced refund of an existing card payment. - [Refund a customer's bank account (ACH) with no originating payment reference.](https://docs.payroc.com/workflows/run-unreferenced-bank-transfer-refund.md): Refund a customer's bank account (ACH) with no originating payment reference. - [Refund a customer's card with no originating payment reference.](https://docs.payroc.com/workflows/run-unreferenced-card-refund.md): Refund a customer's card with no originating payment reference. - [Retrieve a returned ACH payment, then close the return.](https://docs.payroc.com/workflows/close-ach-return.md): Retrieve a returned ACH payment, then close the return. - [Retrieve an ACH return reason and re-present the payment.](https://docs.payroc.com/workflows/represent-ach-payment.md): Retrieve an ACH return reason and re-present the payment. - [Run a bank-transfer (ACH/PAD) sale.](https://docs.payroc.com/workflows/run-a-bank-transfer-sale.md): Run a bank-transfer (ACH/PAD) sale. - [Run a card sale.](https://docs.payroc.com/workflows/run-a-card-sale.md): Run a card sale. - [Run a sale using an encrypted Google Pay token.](https://docs.payroc.com/workflows/accept-google-pay.md): Run a sale using an encrypted Google Pay token. - [Submit an EBT balance inquiry and return the card's benefit balance.](https://docs.payroc.com/workflows/check-ebt-balance.md): Submit an EBT balance inquiry and return the card's benefit balance. - [Validate an Apple Pay merchant session, then run a sale with the wallet token.](https://docs.payroc.com/workflows/accept-apple-pay.md): Validate an Apple Pay merchant session, then run a sale with the wallet token. - [Verify DCC eligibility and retrieve a currency conversion quote for a card.](https://docs.payroc.com/workflows/check-dcc-eligibility.md): Verify DCC eligibility and retrieve a currency conversion quote for a card. - [Verify a customer's ACH (or PAD) bank account details.](https://docs.payroc.com/workflows/verify-a-bank-account.md): Verify a customer's ACH (or PAD) bank account details. - [Verify a customer's card with a zero-value authorization.](https://docs.payroc.com/workflows/verify-a-card.md): Verify a customer's card with a zero-value authorization. - [Confirm a signature instruction is still pending, then cancel it.](https://docs.payroc.com/workflows/cancel-a-device-signature-instruction.md): Confirm a signature instruction is still pending, then cancel it. - [Confirm an instruction is in progress, then cancel it. (/workflows/cancel-a-device-payment-instruction)](https://docs.payroc.com/workflows/cancel-a-device-payment-instruction.md): Confirm an instruction is in progress, then cancel it. - [Confirm an instruction is in progress, then cancel it. (/workflows/cancel-a-device-refund-instruction)](https://docs.payroc.com/workflows/cancel-a-device-refund-instruction.md): Confirm an instruction is in progress, then cancel it. - [Find a device, push a sale instruction, poll for the result, and retrieve the payment.](https://docs.payroc.com/workflows/run-a-sale-on-a-device.md): Find a device, push a sale instruction, poll for the result, and retrieve the payment. - [Retrieve terminal, host, and device configuration for a Payroc Cloud device.](https://docs.payroc.com/workflows/configure-a-device.md): Retrieve terminal, host, and device configuration for a Payroc Cloud device. - [Submit a refund instruction to a device, poll it to completion, and retrieve the refund.](https://docs.payroc.com/workflows/refund-on-a-device.md): Submit a refund instruction to a device, poll it to completion, and retrieve the refund. - [Submit a signature instruction to a device, then retrieve the captured signature.](https://docs.payroc.com/workflows/capture-signature-on-a-device.md): Submit a signature instruction to a device, then retrieve the captured signature. - [List then drill into settlement reports across five report types.](https://docs.payroc.com/workflows/review-settlement-reporting.md): List then drill into settlement reports across five report types. ## Legal - [API Terms of Service](https://docs.payroc.com/legal/api-terms-of-service.md): Merchant Solutions API Program Terms of Service, last revised March 2026. ## Optional - [Full documentation](https://docs.payroc.com/llms-full.txt): The Markdown of every page listed above, in one file. - [Documentation manifest](https://docs.payroc.com/ai/manifest.json): Every published page, operation and workflow, with its anchors. - [Workflow catalog](https://docs.payroc.com/ai/catalog.json): The workflows and the operations each one calls. - [API catalog](https://docs.payroc.com/.well-known/api-catalog): The API servers with their specification and documentation links (RFC 9727).