For AI agents: visit https://docs.payarc.net/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Payarc
HomeGuidesAPI Reference
v1.2.0

Log InPayarc
API Reference
Log In
v1.2.0HomeGuidesAPI Reference

MERCHANT APIs

  • Customers
    • Create a Customerpost
    • Update a Customerpatch
    • Retrieve a Customerget
    • Delete a Customerdel
    • List All Customersget
    • Export Customers to Excelget
  • Cards
    • Update a Cardpatch
    • Delete a Carddel
  • Tokens
    • Create a Token - Apple Paypost
    • Create a Token - Google Paypost
    • Create a Token - Cardpost
  • Charges
    • Create a Charge - Keyedpost
    • Create a Charge - Google Paypost
    • Create a Charge - Apple Paypost
    • List All Chargesget
    • Retrieve a Chargeget
    • Capture a Chargepost
    • Update Charge Metadatapatch
    • Void a Chargepost
    • Refund a Chargepost
    • List All Refundsget
    • Tip Adjustmentpost
    • Get Card BIN Informationpost
  • ACH Charges
    • Create Bank Accountpost
    • Update Bank Accountpatch
    • Retrieve an ACH Chargeget
    • Create ACH Chargepost
  • Subscriptions
    • Create a Subscriptionpost
    • List All Subscriptionsget
    • Pause a Subscriptionpost
    • Resume a Subscriptionpost
    • Update a Subscriptionpatch
    • Cancel a Subscriptionpatch
    • Export Subscriptions to Excelget
    • Delete a Subscriptiondel
  • Subscription Plans
    • Create a Planpost
    • List All Plansget
    • Retrieve a Planget
    • Update a Planpatch
    • Delete a Plandel
    • Export Plansget
  • Subscription Coupons
    • Create a Couponpost
    • List All Couponsget
    • Retrieve a Couponget
    • Delete a Coupondel
    • Export Coupons to Excel
  • Subscriptions Invoices
    • Get Invoicesget
    • Export Invoice to PDFget
    • Export All Invoices to Excelget
    • Get Invoice Settingsget
    • Update Invoice Settingspatch
    • Get Manual Invoice Settingsget
    • Update Manual Invoice Settingspatch
  • Accounts
    • List All Accountsget
  • Deposits
    • Get Payout Scheduleget
    • Export Depositsget
    • SETTING CHANGE- Depositspatch
    • Get Deposit Transaction Detailsget
  • Residuals
    • Agent Residuals Summaryget
    • Agent Residuals Detailsget
  • Disputes
    • Get Disputes Chartget
    • Export Disputesget
    • Retrieve a Disputeget
    • Upload Dispute Documentspost
  • Hosted Page and Checkout
    • Create an Orderpost
    • Retrieve an Order with Chargeget
    • Create and Send Invoicepost
    • Get Invoices/Ordersget
    • Export Invoice to Excelget
  • Transactions Export History
    • Get Transactionsget
  • Events & Logs
    • Get Events & Logsget
    • Get Single Eventget
    • Export Events & Logs to Excelget
  • Risk Management
    • Export Reviewsget
    • Get Reviewsget
    • Get Risksget
  • Statements
    • Get Statementsget
    • Export Statement to PDFget
  • Merchant Profile Account Branding
    • Get Merchant's Profileget
    • Update Merchant's Profilepatch
    • Upload Logopost
  • Merchant Profile User Management
    • Add Userpost
    • Get Usersget
    • Update Userpatch
    • Delete Userdel
    • Attach Userpost
    • Revoke Rolespost
    • Assign Rolespost
    • Find Userget
    • Password Resetpost
    • My user settingspost
    • My user settingsdel
    • My user settingsdel
  • Merchant Profile Role Management
    • Create Rolepost
    • Update Rolepost
    • Get Rolesget
    • Delete Roledel
  • Token Management
    • Reveal API Tokenpost
    • Get API Tokenget
    • Revoke and Regenerate Tokenpost
    • Generate Access Token with Client Credentialspost
    • Who Am Iget
  • WebHooks
    • Add Webhookspost
    • Delete Webhookdel
    • List Webhooksget
    • Update (Disable) Webhookspatch
  • Terminal Registry
    • Add New Terminalpost
    • Update Terminalpatch
    • Terminal Registryget
    • Delete Terminaldel
  • Instructional Funding
    • Create a Charge with Splits
    • Get Instructional Fundingsget
    • Create Instructional Fundingspost
    • Split Overwritepatch

AGENT PARTNER HUB API

  • Dashboard
    • Overview - Merchantsget
    • Overview - Applicationsget
  • Residuals
    • Get Last Published Dateget
    • Residual Detailsget
    • Additional Line Itemsget
    • Residual Summariesget
  • Events
    • Upcoming Eventsget
  • My Merchant Bridge
    • Dashboardget
    • Sub-Merchant Summaryget
    • Get Sub-Merchant Transactionsget
    • Sub-Merchant Customer Summaryget
  • Split Campaigns
    • Create Split Payment Campaignpost
    • Edit Split Payment Campaignpatch
    • Get All Split Payment Campaignsget
    • Get Split Payment Campaign By Idget
    • Delete Split Payment Campaigndel
  • Settlement Reporting
    • Get Agent Batch Reportsget
    • Batch Report Detailsget
  • Statements
    • Get Merchant Statementsget
  • My Merchants
    • Get Subagentsget
    • Get My Accountsget
    • Get Merchant Account By Idget
    • Get Agent Chargesget
    • Get Agent API Tokenget
    • Get Merchant API Tokenget
    • Get Agent Accountsget
  • Webhooks

Apply Wizard API

  • Traditional
    • General Information
    • Lead Management
      • Add Traditional Leadpost
      • Update Traditional Leadpatch
      • Lead Statuspost
      • Delete Leaddel
      • Submit Traditional Lead For Signaturepost
    • Document Management
      • Add Documentspost
      • Delete Documentsdel
    • Sub-Agent Management
      • List Sub Agentsget
  • Payfac
    • General Information
    • Lead Management
      • Add Payfac Leadpost
      • Update Payfac Leadpatch
      • Lead Status
      • Delete Lead
      • Submit For Signature Payfacget
      • Submit Applicationpost
    • Documentation Management
      • Add Documents
      • Delete documents
    • Get Terms and Conditionsget
    • Payee Management
      • Get Payeesget
      • Delete Payeedel
      • Create Payeepost

PayArc Connect

  • Payarc Connect - Getting Started
  • Loginpost
  • Transactions V1
    • Salepost
    • Voidpost
    • Refundpost
    • Authpost
    • Post Authpost
  • Transactions V2
    • Salepost
    • Voidpost
    • Refundpost
    • Authpost
    • Post Authpost
    • Get Transactionget
    • Cancel Transactionpost
    • Transaction Callback
  • Last Transactionget
  • Server Infoget
  • Terminalsget
  • Get Daily Auto Clear get
  • Set Daily Auto Clearpost

Payarc Connect V3

  • Terminal
    • Get Daily Auto Clearget
    • Set Daily Auto Clearput
  • Transactions
    • Salepost
    • Refundpost
    • Voidpost
    • Pre Authpost
    • Authpost
    • Cancelpost
    • Get Transactionget
    • Transaction Callback
  • Server Info
    • Get server informationget
Powered by 

General Information

Updated 12 months ago


Webhooks
Lead Management
Did this page help you?

Updated 12 months ago


Webhooks
Lead Management
Did this page help you?
    • Apply Wizard API: General Information
      • Purpose
      • Functionality
      • Use Case