Search
432 results in this documentation build
API reference169
- API reference
Introduction
Overview of the Payroc API, covering merchant boarding, funding accounts, transaction processing, and core features such as idempotency, metadata, pagination, and versioning.
- API reference
Authentication
How to authenticate Payroc API requests using API keys and Bearer tokens, including Identity Service endpoints, required request headers, and API key best practices.
- API reference
Errors
Reference for all RFC-7807 error codes returned by the Payroc API, including error structure, causes, and example responses for each error type.
- API reference
Idempotency
Explains how the Payroc API implements idempotency for POST and PATCH requests using the Idempotency-Key header to prevent duplicate processing.
- API reference
Metadata
Guide to using metadata in the Payroc API — attaching custom key-value pairs to resources for auditing, troubleshooting, and third-party system integration.
- API reference
Pagination
How to use cursor-based pagination with the Payroc API, including request parameters, response fields, and navigating pages of results.
- API reference
Postman Collection
Step-by-step guide to setting up and authorizing the Payroc Postman collection for testing API requests.
- API reference
API resources
Authored introductions to resources in the canonical payment API.
- API reference
Bank transfer payments
Reference for the bank transfer payment endpoints, covering how to create, retrieve, list, and re-present payments taken from a customer's bank account.
- API reference
Bank transfer refunds
Reference for the bank transfer refund endpoints, covering how to reverse, refund, retrieve, list, and reverse refunds for bank transfer payments.
- API reference
Card Payments
Reference for the card payment endpoints, covering how to create, retrieve, list, adjust, and capture payments taken from a card.
- API reference
Card payment refunds
Reference for the card refund endpoints, covering how to reverse, refund, retrieve, list, adjust, and reverse refunds for card transactions.
- API reference
Payment Features - Cards
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.
- API reference
Contacts
Reference for the contact endpoints, covering how to retrieve, update, and delete a contact linked to a processing account.
- API reference
Event Subscriptions
Reference for the event subscription endpoints, covering how to create, retrieve, list, update, and delete subscriptions that send you notifications when a resource changes.
- API reference
Funding Accounts
Reference for the funding account endpoints, covering how to retrieve, list, update, and delete funding accounts linked to processing accounts and funding recipients.
- API reference
Funding Activity
Reference for the funding activity endpoints, covering how to list funding balances and funding activity for merchants linked to your account.
- API reference
Funding Instructions
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.
- API reference
Funding Recipients
Reference for the funding recipient endpoints, covering how to create, retrieve, list, update, and delete a funding recipient along with its accounts and owners.
- API reference
Merchant Platforms
Reference for the merchant platform endpoints, covering how to create and retrieve a merchant platform, and how to list and add its processing accounts.
- API reference
Owners
Reference for the owner endpoints, covering how to retrieve, update, and delete an owner of a processing account or a funding recipient.
- API reference
Payment Links
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.
- API reference
Payment Plans
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.
- API reference
Payroc Cloud
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.
- API reference
Pricing Intents
Reference for the pricing intent endpoints, covering how to create, retrieve, list, update, and delete a template of fees assigned to a processing account.
- API reference
Processing accounts
Reference for the processing account endpoints, covering how to retrieve account details, pricing agreements, funding accounts, owners, contacts, and terminal orders.
- API reference
Processing terminals
Reference for the processing terminal endpoints, covering how to retrieve terminal, host, and device configuration details, and how to close a batch.
- API reference
Secure tokens
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.
- API reference
Subscriptions
Reference for the subscription endpoints, covering how to create, retrieve, list, update, deactivate, reactivate, and manually collect a repeat payment from a customer.
- API reference
Versioning
Explains the Payroc API agile versioning strategy, including how backward compatibility is maintained and how version numbers are incremented and specified in request URLs.
- API reference
Update account details
POST /processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}/update-account
- API reference
Adjust payment
POST /payments/{paymentId}/adjust
- API reference
Adjust refund
POST /refunds/{refundId}/adjust
- API reference
Start Apple Pay session
POST /processing-terminals/{processingTerminalId}/apple-pay-sessions
- API reference
View EBT balance
POST /cards/balance
- API reference
Create payment
POST /bank-transfer-payments
- API reference
Create unreferenced refund
POST /bank-transfer-refunds
- API reference
Look up BIN information
POST /cards/bin-lookup
- API reference
Capture payment
POST /payments/{paymentId}/capture
- API reference
Close return
POST /bank-transfer-payments/{paymentId}/close
- API reference
Close batch for processing terminal
POST /processing-terminals/{processingTerminalId}/close-batch
- API reference
Create event subscription
POST /event-subscriptions
- API reference
Create funding account
POST /funding-recipients/{recipientId}/funding-accounts
- API reference
Create funding recipient owner
POST /funding-recipients/{recipientId}/owners
- API reference
Create funding recipient
POST /funding-recipients
- API reference
Create funding instruction
POST /funding-instructions
- API reference
Create merchant platform
POST /merchant-platforms
- API reference
Create payment link
POST /processing-terminals/{processingTerminalId}/payment-links
- API reference
Create payment plan
POST /processing-terminals/{processingTerminalId}/payment-plans
- API reference
Create pricing intent
POST /pricing-intents
- API reference
Create processing account
POST /merchant-platforms/{merchantPlatformId}/processing-accounts
- API reference
Upload attachment to processing account
POST /processing-accounts/{processingAccountId}/attachments
- API reference
Create reminder for processing account
POST /processing-accounts/{processingAccountId}/reminders
- API reference
Create secure token
POST /processing-terminals/{processingTerminalId}/secure-tokens
- API reference
Create Hosted Fields session
POST /processing-terminals/{processingTerminalId}/hosted-fields-sessions
- API reference
Create single use token
POST /processing-terminals/{processingTerminalId}/single-use-tokens
- API reference
Create subscription
POST /processing-terminals/{processingTerminalId}/subscriptions
- API reference
Create terminal order
POST /processing-accounts/{processingAccountId}/terminal-orders
- API reference
Deactivate payment link
POST /payment-links/{paymentLinkId}/deactivate
- API reference
Deactivate subscription
POST /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/deactivate
- API reference
Delete contact
DELETE /contacts/{contactId}
- API reference
Delete event subscription
DELETE /event-subscriptions/{subscriptionId}
- API reference
Delete funding account
DELETE /funding-accounts/{fundingAccountId}
- API reference
Delete funding recipient
DELETE /funding-recipients/{recipientId}
- API reference
Delete funding instruction
DELETE /funding-instructions/{instructionId}
- API reference
Delete owner
DELETE /owners/{ownerId}
- API reference
Cancel payment instruction
DELETE /payment-instructions/{paymentInstructionId}
- API reference
Delete payment plan
DELETE /processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}
- API reference
Delete pricing intent
DELETE /pricing-intents/{pricingIntentId}
- API reference
Cancel refund instruction
DELETE /refund-instructions/{refundInstructionId}
- API reference
Delete secure token
DELETE /processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}
- API reference
Cancel signature instruction
DELETE /signature-instructions/{signatureInstructionId}
- API reference
Retrieve ACH deposit
GET /ach-deposits/{achDepositId}
- API reference
List ACH deposit fees
GET /ach-deposit-fees
- API reference
List ACH deposits
GET /ach-deposits
- API reference
Retrieve attachment
GET /attachments/{attachmentId}
- API reference
Retrieve authorization
GET /authorizations/{authorizationId}
- API reference
List authorizations
GET /authorizations
- API reference
Retrieve payment
GET /bank-transfer-payments/{paymentId}
- API reference
Retrieve refund
GET /bank-transfer-refunds/{refundId}
- API reference
Retrieve closed loop read
GET /closed-loop-reads/{closedLoopReadId}
- API reference
Retrieve contact
GET /contacts/{contactId}
- API reference
Retrieve event subscription
GET /event-subscriptions/{subscriptionId}
- API reference
Retrieve funding account
GET /funding-accounts/{fundingAccountId}
- API reference
List funding activity
GET /funding-activity
- API reference
List funding balances
GET /funding-balance
- API reference
Retrieve funding recipient
GET /funding-recipients/{recipientId}
- API reference
Verify DCC eligibility
POST /fx-rates
- API reference
Retrieve funding instruction
GET /funding-instructions/{instructionId}
- API reference
Retrieve merchant platform
GET /merchant-platforms/{merchantPlatformId}
- API reference
Retrieve owner
GET /owners/{ownerId}
- API reference
Retrieve payment
GET /payments/{paymentId}
- API reference
Retrieve payment instruction
GET /payment-instructions/{paymentInstructionId}
- API reference
Retrieve payment intent
GET /payment-intents/{paymentIntentId}
- API reference
Retrieve payment plan
GET /processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}
- API reference
Retrieve pricing intent
GET /pricing-intents/{pricingIntentId}
- API reference
Retrieve processing account
GET /processing-accounts/{processingAccountId}
- API reference
Retrieve processing terminal
GET /processing-terminals/{processingTerminalId}
- API reference
Retrieve host processor configuration
GET /processing-terminals/{processingTerminalId}/host-configurations
- API reference
Retrieve refund
GET /refunds/{refundId}
- API reference
Retrieve refund instruction
GET /refund-instructions/{refundInstructionId}
- API reference
Retrieve secure token
GET /processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}
- API reference
Retrieve signature instruction
GET /signature-instructions/{signatureInstructionId}
- API reference
Retrieve subscription
GET /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}
- API reference
Retrieve terminal order
GET /terminal-orders/{terminalOrderId}
- API reference
List transactions
GET /transactions
- API reference
Retrieve batch
GET /batches/{batchId}
- API reference
List batches
GET /batches
- API reference
List disputes
GET /disputes
- API reference
List dispute statuses
GET /disputes/{disputeId}/statuses
- API reference
Retrieve transaction
GET /transactions/{transactionId}
- API reference
List payments
GET /bank-transfer-payments
- API reference
List refunds
GET /bank-transfer-refunds
- API reference
List event subscriptions
GET /event-subscriptions
- API reference
List funding recipient's funding accounts
GET /funding-recipients/{recipientId}/funding-accounts
- API reference
List funding recipient owners
GET /funding-recipients/{recipientId}/owners
- API reference
List funding accounts
GET /funding-accounts
- API reference
List funding recipients
GET /funding-recipients
- API reference
List funding instructions
GET /funding-instructions
- API reference
List merchant platform's processing accounts
GET /merchant-platforms/{merchantPlatformId}/processing-accounts
- API reference
List owners
GET /processing-accounts/{processingAccountId}/owners
- API reference
List merchant platforms
GET /merchant-platforms
- API reference
List payment link sharing events
GET /payment-links/{paymentLinkId}/sharing-events
- API reference
List payment links
GET /processing-terminals/{processingTerminalId}/payment-links
- API reference
List payment plans
GET /processing-terminals/{processingTerminalId}/payment-plans
- API reference
List payments
GET /payments
- API reference
List pricing intents
GET /pricing-intents
- API reference
List contacts
GET /processing-accounts/{processingAccountId}/contacts
- API reference
List processing account's funding accounts
GET /processing-accounts/{processingAccountId}/funding-accounts
- API reference
List processing terminals
GET /processing-accounts/{processingAccountId}/processing-terminals
- API reference
List terminal orders
GET /processing-accounts/{processingAccountId}/terminal-orders
- API reference
List refunds
GET /refunds
- API reference
List secure tokens
GET /processing-terminals/{processingTerminalId}/secure-tokens
- API reference
List subscriptions
GET /processing-terminals/{processingTerminalId}/subscriptions
- API reference
Partially update event subscription
PATCH /event-subscriptions/{subscriptionId}
- API reference
Partially update pricing intent
PATCH /pricing-intents/{pricingIntentId}
- API reference
Pay manual subscription
POST /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/pay
- API reference
Create payment
POST /payments
- API reference
Re-activate subscription
POST /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/reactivate
- API reference
Create referenced refund
POST /bank-transfer-payments/{paymentId}/refund
- API reference
Create referenced refund
POST /payments/{paymentId}/refund
- API reference
Re-present payment
POST /bank-transfer-payments/{paymentId}/represent
- API reference
Retrieve a device configuration
GET /processing-terminals/{processingTerminalId}/device-configurations/{model}
- API reference
Retrieve payment link
GET /payment-links/{paymentLinkId}
- API reference
Retrieve processing account pricing agreement
GET /processing-accounts/{processingAccountId}/pricing
- API reference
Retrieve signature
GET /signatures/{signatureId}
- API reference
Reverse payment
POST /bank-transfer-payments/{paymentId}/reverse
- API reference
Reverse refund
POST /bank-transfer-refunds/{refundId}/reverse
- API reference
Reverse payment
POST /payments/{paymentId}/reverse
- API reference
Reverse refund
POST /refunds/{refundId}/reverse
- API reference
Search devices
GET /devices
- API reference
Submit payment instruction
POST /devices/{serialNumber}/payment-instructions
- API reference
Submit refund instruction
POST /devices/{serialNumber}/refund-instructions
- API reference
Submit signature instruction
POST /devices/{serialNumber}/signature-instructions
- API reference
Share payment link
POST /payment-links/{paymentLinkId}/sharing-events
- API reference
Create unreferenced refund
POST /refunds
- API reference
Update contact
PUT /contacts/{contactId}
- API reference
Update event subscription
PUT /event-subscriptions/{subscriptionId}
- API reference
Update funding account
PUT /funding-accounts/{fundingAccountId}
- API reference
Update funding recipient
PUT /funding-recipients/{recipientId}
- API reference
Update funding instruction
PUT /funding-instructions/{instructionId}
- API reference
Update owner
PUT /owners/{ownerId}
- API reference
Partially update payment link
PATCH /payment-links/{paymentLinkId}
- API reference
Partially update payment plan
PATCH /processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}
- API reference
Update pricing intent
PUT /pricing-intents/{pricingIntentId}
- API reference
Partially update secure token
PATCH /processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}
- API reference
Partially update subscription
PATCH /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}
- API reference
Verify bank account
POST /bank-accounts/verify
- API reference
Verify card
POST /cards/verify
Guides118
- Guides
Guides
Build and test your Payroc integration.
- Guides
API keys
Create and manage Payroc App API keys.
- Guides
Change the settings of a Payroc App API key
Explains how to update the alias, notification email, API permissions, and processing terminals of a Payroc App API key using the Self-Care Portal.
- Guides
Deactivate a Payroc App API key
Explains how to deactivate a Payroc App API key in the Self-Care Portal, preventing its use without permanently deleting it.
- Guides
Generate a Payroc App API key
Shows how to generate and view a Payroc App API key in the Self-Care Portal to authenticate with the Payroc Cloud Simulator.
- Guides
Reactivate a Payroc App API key
Explains how to reactivate a previously deactivated Payroc App API key using the Self-Care Portal.
- Guides
View a Payroc App API key
Explains how to locate and copy a Payroc App API key from the Self-Care Portal.
- Guides
Board a merchant
Board a merchant by creating a merchant platform with processing accounts, owners, contacts, and a terminal order.
- Guides
Add an attachment to a processing account
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.
- Guides
Create a merchant platform
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.
- Guides
Order a terminal
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.
- Guides
Create a pricing intent
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.
- Guides
Add a processing account to a merchant platform
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.
- Guides
Event subscriptions
Subscribe to account changes and handle webhook notifications sent by our gateway.
- Guides
Create an event subscription
Create an event subscription by sending a POST request to the event-subscriptions endpoint to receive webhook notifications when specified events occur.
- Guides
Fund merchants
Configure funding recipients and instructions.
- Guides
Send funds to your merchants
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.
- Guides
Set up a funding recipient
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.
- Guides
Getting started
Learn the stages of a Payroc integration, from your discovery call to going live with our API.
- Guides
Quickstart
Get sandbox credentials and make your first Payroc API call.
- Guides
Payments
Explains how to use the Payments endpoints to take card, bank account, and digital wallet payments, and to run refunds and repeat payments
- Guides
Add custom fields to your integration
Add merchant-defined custom fields to card payments, bank transfers, refunds, subscriptions, and secure token requests using the customFields object.
- Guides
Apple Pay®
Add Apple Pay to your integration so merchants can accept Apple Pay as a payment method for online transactions.
- Guides
Add a convenience fee
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.
- Guides
Add Apple Pay to your integration
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.
- Guides
Extend your integration
Extend your Apple Pay integration to add convenience fees or split payments between multiple merchants using the multi-merchant of record function.
- Guides
Set up Apple Pay for a merchant
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.
- Guides
Split a payment with multiple merchants
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 gateway.
- Guides
Close an ACH payment
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.
- Guides
Google Pay
Add Google Pay to your integration so merchants can accept Google Pay as a payment method for online transactions.
- Guides
Add Google Pay to your integration
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.
- Guides
Hosted Fields
Add secure, gateway-hosted payment fields to your own checkout page design using Hosted Fields.
- Guides
Add your own fields
Add your own HTML fields to Hosted Fields to capture extra customer or transaction information, such as address details for address verification.
- Guides
Authenticate your session
Generate a session token for Hosted Fields by sending a POST request to the Processing Terminals hosted-fields-sessions endpoint using a Bearer token.
- Guides
Close a Hosted Fields session
Call the destroy method in your JavaScript to close an idle Hosted Fields session before starting a new one.
- Guides
Create a payment form
Build a card, ACH, or PAD payment form by adding HTML fields and configuring the Hosted Fields JavaScript library with your session token.
- Guides
Extend your integration
Extend your Hosted Fields integration by styling fields, adding custom fields, closing sessions, and saving payment details.
- Guides
Repeat payments With Hosted Fields
Set up repeat payments by charging a customer's stored payment token after saving their details with Hosted Fields.
- Guides
Run a sale
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.
- Guides
Save payment details when running a sale
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.
- Guides
Save a customer's payment details
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 payment details.
- Guides
Save a customer's payment details
Convert a single-use payment token into a reusable secure token to save a customer's payment details for a future or repeat payment.
- Guides
Styling your Hosted Fields
Customize the look of your Hosted Fields payment form by replacing the default CSS and responding to the fieldValidityChange event.
- Guides
Update a customer's payment details
Update a customer's saved payment details by submitting a single-use token from Hosted Fields to the Secure Tokens update-account endpoint.
- Guides
Collect a payment with the Hosted Payment Page
Redirect your customer to Payroc's hosted checkout; sale, pre-auth, and tokenize variants.
- Guides
Authenticate your requests
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.
- Guides
Implement background validation
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.
- Guides
Build the merchant’s receipt page
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.
- Guides
Capture the pre-authorization
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.
- Guides
Customize your Hosted Payment Page
Customize the look of your Hosted Payment Page to match the look and feel of your website.
- Guides
Extend your integration
Explore guides for extending a Hosted Payment Page integration, including pre-authorizations, saving payment details, repeat payments, and background validation.
- Guides
Hosted Payment Page
Learn how the Hosted Payment Page works and follow the integration journey to run a sale, then extend your integration with optional features.
- Guides
Load the Hosted Payment Page
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.
- Guides
Hosted Payment Page
Learn how the Hosted Payment Page works and follow the integration journey to run a sale, then extend your integration with optional features.
- Guides
Run a pre-authorization
Run a pre-authorization on the Hosted Payment Page to hold an amount on a customer's card before your merchant captures it later
- Guides
Authenticate your requests
Authenticate a pre-authorization request on the Hosted Payment Page by reusing the same SHA-512 hash setup you built to run a sale
- Guides
Build the merchant’s receipt page
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
- Guides
Load the Hosted Payment Page
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
- Guides
Authenticate your requests
Build the SHA-512 hash string needed to authenticate a request that saves a customer's payment details on the Hosted Payment Page
- Guides
Build the merchant’s receipt page
Build a receipt page that reads the CARDREFERENCE and MERCHANTREF query parameters the Hosted Payment Page returns after saving a customer's payment details
- Guides
Load the Hosted Payment Page
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
- Guides
Save a Customer’s Payment Details
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
- Guides
Set up repeat payments
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.
- Guides
Payment Links
Explains how to use Payment Links to create a hosted payment page that a merchant can share with a customer
- Guides
Create and share a payment link
Create a payment link and share it with customers by sending POST requests to the Processing Terminals and Payment Links endpoints.
- Guides
Extend your integration
Extend a payment links integration by sharing, updating, retrieving, listing, or deactivating payment links
- Guides
Payroc Cloud
Explore guides for configuring your payment device, running a sale, and extending your Payroc Cloud integration with refunds and signature capture.
- Guides
Capture a signature
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.
- Guides
Device setup
Configure ID TECH and Ingenico devices.
- Guides
Android (POS on a different device)
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.
- Guides
Android (POS on the same device)
Configure your Android payment device to run your POS app and the Payroc App together, including permissions, app switching, and Paxstore upload.
- Guides
ID TECH
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.
- Guides
ID TECH - Linux
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.
- Guides
ID TECH - Windows
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.
- Guides
Ingenico
Connect an Ingenico card reader to your POS through the Payroc Cloud middleware, choosing the setup guide for your Windows or Linux host machine.
- Guides
Ingenico - Linux
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.
- Guides
Ingenico - Windows
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.
- Guides
Extend your solution
Extend your Payroc Cloud integration with signature capture, referenced and unreferenced refunds, and transaction reversal.
- Guides
Run a sale
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.
- Guides
Run unreferenced refunds
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.
- Guides
Refunds
Explains referenced refunds, unreferenced refunds, and reversals, and when to use each one to return funds to a customer
- Guides
Send a referenced refund to a bank account
Refund a bank transfer payment by sending a POST request to the Bank Transfer Payments Refund endpoint using the original paymentId.
- Guides
Run a referenced refund for a card payment
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.
- Guides
Send an unreferenced refund to a customer’s bank account
Send an unreferenced refund to a customer's bank account by posting to the Bank Transfer Refunds endpoint without a paymentId.
- Guides
Run an unreferenced refund for a card payment
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.
- Guides
Reverse a bank transfer payment
Reverse a bank transfer payment in an open batch by sending a POST request to the Bank Transfer Payments reverse endpoint with the paymentId.
- Guides
Reverse a card sale or a pre-authorization
Reverse a card sale or pre-authorization in an open batch by sending a POST request to the Reverse endpoint with the paymentId.
- Guides
Repeat payments
Run recurring payments with your software or the gateway.
- Guides
Use our gateway
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 endpoints.
- Guides
Use your own software
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.
- Guides
Re-present an ACH payment
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
- Guides
Run a card sale
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.
- Guides
Run a pre-authorization
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.
- Guides
Run a sale with bank account details
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.
- Guides
Save payment details
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.
- Guides
Tap to Pay on iPhone
Use our Tap to Pay on iPhone SDK to accept contactless card-present payments directly on an iPhone without an external card reader.
- Guides
Add a line item
Add itemized product details to a Tap to Pay on iPhone sale using the CoreLineItem object, including a per-item tax.
- Guides
Add a tax
Add a predefined tax or a custom tax to a Tap to Pay on iPhone sale using the CoreTax object.
- Guides
Add a tip
Add a predefined tip or a custom tip to a Tap to Pay on iPhone sale using the CoreTip object.
- Guides
Cancel a sale
Cancel an in-progress sale with the Tap to Pay on iPhone SDK, and handle the cancellation status that the SDK returns.
- Guides
Configure the processing terminal
Configure the Tap to Pay on iPhone terminal by initializing it locally, setting the operating mode, and loading your settings from our gateway.
- Guides
Extend your integration
Extend your Tap to Pay on iPhone integration with refunds, transaction reporting, tips, taxes, line items, and surcharges.
- Guides
Handle errors
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.
- Guides
Handle surcharges
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.
- Guides
Retrieve transactions
Retrieve a single transaction or list multiple transactions with the Tap to Pay on iPhone SDK using the reporting listener.
- Guides
Run a refund
Run a referenced refund with the Tap to Pay on iPhone SDK using the uniqueRef of the original sale.
- Guides
Run a sale
Run a sale with Tap to Pay on iPhone by registering your listeners, initializing the contactless reader, and processing a CoreSale object.
- Guides
Run the sample apps
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.
- Guides
Set up the SDK
Add the Tap to Pay on iPhone SDK to your Xcode project, link the libraries, and configure your build settings.
- Guides
3-D Secure
Explains how 3-D Secure verifies a cardholder's identity during online transactions and how it fits into your integration
- Guides
Run a sale with 3-D Secure
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.
- Guides
Update saved payment details
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.
- Guides
Testing
Send requests to the Payroc Cloud Simulator.
- Guides
Bank Payments
Test values and return codes for validating bank payment integrations in the test environment.
- Guides
Funding
Test cases for verifying funding recipients, funding accounts, funding instructions, and funding activity integrations against the Payroc API.
- Guides
Payments
Test cases and test data for validating online payment integrations including card payments, secure tokens, payment plans, and bank transfers in the test environment.
- Guides
Payroc Cloud
Test cases and test data for validating a Payroc Cloud physical POS integration before going live.
- Guides
Send test requests to our gateway
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.
Knowledge38
- Knowledge
Knowledge
Understand Payroc API behavior and payment concepts.
- Knowledge
API basics
Understand authentication, requests and API behavior.
- Knowledge
API keys
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.
- Knowledge
Getting started with the Payroc API
Sandbox account, API keys, and your first authenticated request.
- Knowledge
Glossary
Definitions of payment industry terms, acronyms, and Payroc-specific concepts used across the developer documentation.
- Knowledge
Hypermedia as the engine of application state (HATEOAS)
Explains how the Payroc API uses HATEOAS links to surface related resources and paginate large result sets within API responses.
- Knowledge
Units of measurement
Reference list of unit of measurement codes supported by the Payroc API, covering weight, volume, length, time, energy, and quantity units.
- Knowledge
Boarding
Understand pricing before boarding merchants.
- Knowledge
Pricing intents
Explains how pricing intents work as fee templates that define base, gateway, and processor fees for merchants before boarding.
- Knowledge
Data migration
Move payment data from another provider.
- Knowledge
Migrate data from another payments provider
Explains how to migrate tokenized card data and PANs from another payments provider to Payroc using PGP encryption.
- Knowledge
Migrate payment data from another provider
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.
- Knowledge
Events list
Reference list of all subscribable API events, explaining the CloudEvents format used for webhook notifications.
- Knowledge
processingAccount.riskStatus.changed
processingAccount.riskStatus.changed: Event type: processingAccount.riskStatus.changed\
- Knowledge
processingAccount.signature.signed
processingAccount.signature.signed: Event type: processingAccount.signature.signed\
- Knowledge
processingAccount.status.changed
Explains the processingAccount.status.changed event, which fires when a processing account's status changes, and describes the notification payload and possible status values.
- Knowledge
terminalOrder.status.changed
Explains the terminalOrder.status.changed webhook event, which fires when Payroc updates the status of a terminal order such as shipping or cancellation.
- Knowledge
Payments
Understand payment methods, processing and transaction behavior.
- Knowledge
Dynamic currency conversion
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.
- Knowledge
Dynamic descriptors
Explains how dynamic descriptors let merchants customize the transaction text displayed on a customer's card statement to reduce chargebacks.
- Knowledge
Enhanced data
Explains how to add enhanced data to card payments and qualify for lower interchange rates.
- Knowledge
Interchange fee
Explains how interchange fees are structured, what card brands charge for network use, and what factors determine which interchange category a transaction is assigned.
- Knowledge
Offline processing
Explains how offline processing allows terminals to accept card payments without a gateway connection and store them for later submission.
- Knowledge
Payment method verification
Explains the methods available for verifying a cardholder's identity during a transaction, including PIN, signature, AVS, CVV, and 3-D Secure.
- Knowledge
Payment plans and subscriptions
Explains how payment plans and subscriptions work together to enable merchants to take recurring and installment payments from customers.
- Knowledge
Refunds and reversals
Explains the difference between refunds and reversals for card payments, including referenced and unreferenced refund types and when each applies.
- Knowledge
Repeat payments
Explains recurring payments and installment payments, and how to choose between your own software or our gateway to manage them
- Knowledge
Credit card surcharging
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.
- Knowledge
3-D Secure
Explains how 3-D Secure authentication works to prevent e-commerce fraud by verifying cardholder identity with the issuing bank.
- Knowledge
Tokenization
Explains how tokenization replaces sensitive payment details with reusable secure tokens or single-use tokens, enabling repeat payments without additional PCI compliance requirements.
- Knowledge
Payroc Cloud
Explains how Payroc Cloud works as a semi-integrated payments solution, enabling POS systems to communicate with payment devices through the Payroc gateway.
- Knowledge
How to send a signature to our gateway
Explains how to capture and encode a customer's handwritten signature as a base-28 coordinate string for submission to the Payroc gateway.
- Knowledge
Supported Devices
Reference for all card-reading devices supported across Payroc solutions, including device type, operating environment, certified processors, and integration requirements.
- Knowledge
Testing
Use the simulator and its test transaction values.
- Knowledge
Payroc Cloud Simulator
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.
- Knowledge
Test transaction values
Reference of dollar amounts to use with the Payroc Cloud Simulator to trigger specific card entry methods and transaction behaviors during testing.
- Knowledge
Integration tools
Find tools for building your integration.
- Knowledge
Payroc Skills Marketplace
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.
legal1
Solutions32
- Solutions
One payments platform. Two ways to build on it.
Compare Payroc Essentials for low-code integration with Full Stack for full API access and advanced customization.
- Solutions
Essentials
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.
- Solutions
Essentials Guides
Explore step-by-step guides for integrating with Payroc Cloud, Hosted Payment Page, Hosted Fields, and Payment Links.
- Solutions
In-person payments
Overview of Payroc Essentials in-person payment solutions, including Payroc Cloud, Roc Terminal+, and Roc Services for point-of-sale payment acceptance.
- Solutions
Payroc Cloud
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.
- Solutions
Roc Services
Overview of Roc Services as a no-code scheduling, invoicing, and payment solution for service-based merchants on desktop and mobile.
- Solutions
Roc Terminal+
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 payment devices.
- Solutions
Online payments
Overview of Essentials online payment solutions including Hosted Fields, Hosted Payment Page, Payment Links, and no-code terminal and invoicing options.
- Solutions
Hosted Fields
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.
- Solutions
Hosted Payment Page
Overview of Hosted Payment Page as a low-code online payment solution for merchants who want a Payroc-hosted, PCI-compliant checkout page.
- Solutions
Payment Links
Overview of Payment Links as a solution for merchants to create and share secure hosted payment URLs without requiring a website or checkout integration.
- Solutions
Roc Services
Overview of Roc Services as a no-code scheduling and invoicing solution for service-based merchants, covering appointments, recurring payments, and reporting.
- Solutions
Roc Terminal+
Overview of Roc Terminal+ as a no-code, multi-platform payment solution for accepting cards, bank transfers, and recurring payments from a single application.
- Solutions
Full Stack
Overview of Full Stack solutions covering end-to-end payment platform capabilities including merchant boarding, in-person and online payments, reporting, and merchant funding.
- Solutions
Board merchants
Onboard and configure your merchants.
- Solutions
Boarding
Overview of the Boarding solution for digitally onboarding merchants by submitting their information programmatically to enable faster account setup.
- Solutions
Fund merchants
Fund your merchants and configure funding recipients.
- Solutions
Funding
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.
- Solutions
Integration guides
Explore guides for boarding merchants, taking payments, and funding merchants with the Payroc API.
- Solutions
Take payments
Accept in-person and online payments with Full Stack.
- Solutions
In-person payments
Overview of in-person payment solutions for merchants, covering API-based, semi-integrated, terminal, and invoicing options.
- Solutions
Payroc API for in-person payments
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.
- Solutions
Payroc Cloud
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.
- Solutions
Tap to Pay on iPhone
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.
- Solutions
Online payments
Overview of Payroc's online payment solutions, including the Payroc API, Payment Links, Hosted Fields, Hosted Payment Page, and no-code terminal options.
- Solutions
Hosted Fields
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.
- Solutions
Hosted Payment Page
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.
- Solutions
Payment Links
Overview of Payment Links as a solution for merchants to create and share secure payment links without needing a website or checkout integration.
- Solutions
Payroc API for online payments
Overview of the Payroc API as a fully flexible online payment solution supporting cards, bank transfers, digital wallets, tokenization, and recurring payments.
- Solutions
View reports
View transaction and settlement information.
- Solutions
Real-time transaction data
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.
- Solutions
Settlement data
Overview of tools for accessing and reconciling merchants' settled transaction data using the Payroc API or Payroc Insights reporting portal.
Workflows74
- Workflows
Validate an Apple Pay merchant session, then run a sale with the wallet token.
Validate an Apple Pay merchant session, then run a sale with the wallet token.
- Workflows
Run a sale using an encrypted Google Pay token.
Run a sale using an encrypted Google Pay token.
- Workflows
Upload a document to a processing account, then optionally retrieve it.
Upload a document to a processing account, then optionally retrieve it.
- Workflows
Create a processing account on 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.
- Workflows
List payments, retrieve the target payment, then adjust it
List payments, retrieve the target payment, then adjust it
- Workflows
List, retrieve, then adjust a card refund.
List, retrieve, then adjust a card refund.
- Workflows
Create pricing, board the merchant platform, add accounts/terminals, and upload documents.
Create pricing, board the merchant platform, add accounts/terminals, and upload documents.
- Workflows
Confirm an instruction is in progress, then cancel it.
Confirm an instruction is in progress, then cancel it.
- Workflows
Confirm an instruction is in progress, then cancel it.
Confirm an instruction is in progress, then cancel it.
- Workflows
Confirm a signature instruction is still pending, then cancel it.
Confirm a signature instruction is still pending, then cancel it.
- Workflows
Submit a signature instruction to a device, then retrieve the captured signature.
Submit a signature instruction to a device, then retrieve the captured signature.
- Workflows
Verify DCC eligibility and retrieve a currency conversion quote for a card.
Verify DCC eligibility and retrieve a currency conversion quote for a card.
- Workflows
Submit an EBT balance inquiry and return the card's benefit balance.
Submit an EBT balance inquiry and return the card's benefit balance.
- Workflows
Close the current batch for a processing terminal.
Close the current batch for a processing terminal.
- Workflows
Retrieve a returned ACH payment, then close the return.
Retrieve a returned ACH payment, then close the return.
- Workflows
Create a Hosted Fields session, tokenize card details client-side, then run the sale.
Create a Hosted Fields session, tokenize card details client-side, then run the sale.
- Workflows
Collect a payment via Payroc's redirect-based Hosted Payment Page, optionally capturing a pre-authorization afterward.
Collect a payment via Payroc's redirect-based Hosted Payment Page, optionally capturing a pre-authorization afterward.
- Workflows
Create a payment link, share it by email, track sharing events, and manage its lifecycle.
Create a payment link, share it by email, track sharing events, and manage its lifecycle.
- Workflows
Retrieve terminal, host, and device configuration for a Payroc Cloud device.
Retrieve terminal, host, and device configuration for a Payroc Cloud device.
- Workflows
Create an event subscription, then discover, retrieve, and delete it.
Create an event subscription, then discover, retrieve, and delete it.
- Workflows
Create a merchant platform, then optionally remind the merchant to sign.
Create a merchant platform, then optionally remind the merchant to sign.
- Workflows
Create a reusable pricing intent (fee template) for processing accounts.
Create a reusable pricing intent (fee template) for processing accounts.
- Workflows
Deactivate a subscription to stop collection.
Deactivate a subscription to stop collection.
- Workflows
List, retrieve, then delete a processing account's contact.
List, retrieve, then delete a processing account's contact.
- Workflows
List, retrieve, then delete a funding account.
List, retrieve, then delete a funding account.
- Workflows
List, retrieve, then delete a funding instruction.
List, retrieve, then delete a funding instruction.
- Workflows
List, retrieve, then delete a funding recipient.
List, retrieve, then delete a funding recipient.
- Workflows
List, retrieve, then delete a payment plan.
List, retrieve, then delete a payment plan.
- Workflows
List, retrieve, then delete a secure token.
List, retrieve, then delete a secure token.
- Workflows
List, retrieve, then delete an owner of a funding recipient.
List, retrieve, then delete an owner of a funding recipient.
- Workflows
Look up card details from a BIN.
Look up card details from a BIN.
- Workflows
Discover a funding recipient, retrieve it, and read its nested accounts and owners.
Discover a funding recipient, retrieve it, and read its nested accounts and owners.
- Workflows
Create, list, and retrieve a payment plan
Create, list, and retrieve a payment plan
- Workflows
Create, list, retrieve, and delete a pricing intent.
Create, list, retrieve, and delete a pricing intent.
- Workflows
Create, list, retrieve, update, and manually pay a subscription
Create, list, retrieve, update, and manually pay a subscription
- Workflows
Create a terminal order for a processing account and track its status.
Create a terminal order for a processing account and track its status.
- Workflows
Partially update a pricing intent via PATCH.
Partially update a pricing intent via PATCH.
- Workflows
Partially update an event subscription via PATCH.
Partially update an event subscription via PATCH.
- Workflows
Create a single-use token, run a payment, optionally reverse it
Create a single-use token, run a payment, optionally reverse it
- Workflows
Reactivate a subscription to resume collection.
Reactivate a subscription to resume collection.
- Workflows
List, retrieve, then refresh a secure token from a single-use token.
List, retrieve, then refresh a secure token from a single-use token.
- Workflows
Referenced refund of an existing bank-transfer / ACH payment.
Referenced refund of an existing bank-transfer / ACH payment.
- Workflows
Referenced refund of an existing card payment.
Referenced refund of an existing card payment.
- Workflows
Submit a refund instruction to a device, poll it to completion, and retrieve the refund.
Submit a refund instruction to a device, poll it to completion, and retrieve the refund.
- Workflows
Fully replace a pricing intent via PUT.
Fully replace a pricing intent via PUT.
- Workflows
Retrieve an ACH return reason and re-present the payment.
Retrieve an ACH return reason and re-present the payment.
- Workflows
Look up and reverse a bank-transfer payment in an open batch.
Look up and reverse a bank-transfer payment in an open batch.
- Workflows
List, retrieve, then reverse (cancel) a bank-transfer refund.
List, retrieve, then reverse (cancel) a bank-transfer refund.
- Workflows
Look up and reverse a card payment in an open batch.
Look up and reverse a card payment in an open batch.
- Workflows
List, retrieve, then reverse (cancel) a card refund.
List, retrieve, then reverse (cancel) a card refund.
- Workflows
Read funding balances then the funding activity ledger.
Read funding balances then the funding activity ledger.
- Workflows
Confirm a boarded merchant's hierarchy and status via read-only reads.
Confirm a boarded merchant's hierarchy and status via read-only reads.
- Workflows
List then drill into settlement reports across five report types.
List then drill into settlement reports across five report types.
- Workflows
Run a bank-transfer (ACH/PAD) sale.
Run a bank-transfer (ACH/PAD) sale.
- Workflows
Run a card sale.
Run a card sale.
- Workflows
Pre-authorize a card, optionally adjust the amount, capture, and optionally refund.
Pre-authorize a card, optionally adjust the amount, capture, and optionally refund.
- Workflows
Find a device, push a sale instruction, poll for the result, and retrieve the payment.
Find a device, push a sale instruction, poll for the result, and retrieve the payment.
- Workflows
Refund a customer's bank account (ACH) with no originating payment reference.
Refund a customer's bank account (ACH) with no originating payment reference.
- Workflows
Refund a customer's card with no originating payment reference.
Refund a customer's card with no originating payment reference.
- Workflows
Create a tokenization session, tokenize card details client-side, then mint a reusable secure token.
Create a tokenization session, tokenize card details client-side, then mint a reusable secure token.
- Workflows
Create a reusable secure token from a customer's card or bank account.
Create a reusable secure token from a customer's card or bank account.
- Workflows
Create a funding recipient, optionally check the balance, then send funds via a funding instruction.
Create a funding recipient, optionally check the balance, then send funds via a funding instruction.
- Workflows
Create a funding recipient, then optionally add extra accounts and owners.
Create a funding recipient, then optionally add extra accounts and owners.
- Workflows
Create a payment plan, save the customer's payment method, then subscribe the customer to the plan.
Create a payment plan, save the customer's payment method, then subscribe the customer to the plan.
- Workflows
List, retrieve, then update (full PUT replace) a processing account's contact.
List, retrieve, then update (full PUT replace) a processing account's contact.
- Workflows
List, retrieve, then update a funding account.
List, retrieve, then update a funding account.
- Workflows
List, retrieve, then update (replace) a funding instruction.
List, retrieve, then update (replace) a funding instruction.
- Workflows
List, retrieve, then update (full PUT) a funding recipient.
List, retrieve, then update (full PUT) a funding recipient.
- Workflows
List, retrieve, then update a payment plan via JSON Patch.
List, retrieve, then update a payment plan via JSON Patch.
- Workflows
List, retrieve, then update a secure token via JSON Patch.
List, retrieve, then update a secure token via JSON Patch.
- Workflows
Fully replace an event subscription via PUT.
Fully replace an event subscription via PUT.
- Workflows
List, retrieve, then update (full PUT) an owner.
List, retrieve, then update (full PUT) an owner.
- Workflows
Verify a customer's ACH (or PAD) bank account details.
Verify a customer's ACH (or PAD) bank account details.
- Workflows
Verify a customer's card with a zero-value authorization.
Verify a customer's card with a zero-value authorization.