/

Docs
History
Schema
Generate

Filter operations

get/v1/customersList All Customers
post/v1/customersCreate a Customer
get/v1/customers/{customer_id}Retrieve a Customer
delete/v1/customers/{customer_id}Delete a Customer
patch/v1/customers/{customer_id}Update a Customer
get/v1/dashboard-export/customerExport Customers to Excel
patch/v1/cards/{card_id}Update a Card
delete/v1/customers/{customer_id}/cards/{card_id}Delete a Card
post/v1/tokensCreate a Token/Card
get/v1/chargesList All Charges
post/v1/charges/swipeCreate a Charge - Swipe
post/v1/charges/google/saleCreate a Charge - Google Pay
get/v1/charges/{charge_id}Retrieve a Charge
patch/v1/charges/{charge_id}Update Charge Metadata
post/v1/charges/{charge_id}/captureCapture a Charge
post/v1/charges/{charge_id}/voidVoid a Charge
post/v1/charges/{charge_id}/refundsRefund a Charge
get/v1/refundsList All Refunds
post/v1/charges/{id}/tip_adjustmentTip Adjustment
post/v1/cards/binGet Card BIN Information
post/v1/bankaccountsCreate Bank Account
patch/v1/bankaccounts/{id}Update Bank Account
get/v1/achcharges/{id}Retrieve an ACH Charge
post/v1/achchargesCreate ACH Charge
get/v1/subscriptionsList All Subscriptions
post/v1/subscriptionsCreate a Subscription
post/v1/subscriptions/{id}/pausePause a Subscription
post/v1/subscriptions/{id}/resumeResume a Subscription
patch/v1/subscriptions/{id}Update a Subscription
patch/v1/subscriptions/{id}/cancelCancel a Subscription
get/v1/dashboard-export/subscriptionExport Subscriptions to Excel
delete/v1/subscriptions/{subscription_id}Delete a Subscription
get/v1/plansList All Plans
post/v1/plansCreate a Plan
get/v1/plans/{plan_id}Retrieve a Plan
delete/v1/plans/{plan_id}Delete a Plan
patch/v1/plans/{plan_id}Update a Plan
get/v1/dashboard-export/planExport Plans
get/v1/discountsList All Coupons
post/v1/discountsCreate a Coupon
get/v1/discounts/{coupon_id}Retrieve a Coupon
delete/v1/discounts/{coupon_id}Delete a Coupon
get/v1/dashboard-export/discountExport Coupons to Excel
get/v1/invoices/Get Invoices
get/v1/resend-invoice/{invoice_id}Resend Invoice [ON HOLD]
get/v1/pay/{invoice_id}/invoiceExport Invoice to PDF
get/v1/dashboard-export/invoicesExport All Invoices to Excel
get/v1/invoicesettingsGet Invoice Settings
patch/v1/invoicesettings/{invoice_settings_id}Update Invoice Settings
get/v1/manualinvoicesettingGet Manual Invoice Settings
patch/v1/manualinvoicesetting/{manual_invoice_settings_id}Update Manual Invoice Settings
get/v1/accountsList All Accounts
get/v1/payout/scheduleGet Payout Schedule
get/v1/deposit/summaryExport Deposits
patch/v1/payout/schedule/{schedule_id}SETTING CHANGE- Deposits
get/v1/deposit/reports/details/Get Deposit Transaction Details
get/v1/deposit/reportsList All Deposits [ON HOLD]
get/v1/dispute-chartGet Disputes Chart
get/v1/casesExport Disputes
get/v1/cases/{id}/Retrieve a Dispute
post/v1/orders/Create an Order
get/v1/orders/{id}/chargeRetrieve an Order with Charge
post/v1/orders/customerCreate and Send Invoice
get/v1/orders/customer/get/Get Invoices/Orders
get/v1/dashboard-export/orderExport Invoice to Excel
get/v1/batch/reportsGet Transactions
get/v1/excel/charges/{charge_id}Download Transaction [ON HOLD]
get/v1/eventsGet Events & Logs
get/v1/events/{id}Get Single Event
get/v1/dashboard-export/eventExport Events & Logs to Excel
get/v1/dashboard-export/reviewExport Reviews
get/v1/reviewsGet Reviews
get/v1/risksGet Risks
get/v1/merchant_statementsGet Statements
get/v1/merchant_statements/{statement_id}Export Statement to PDF
get/v1/accounts/brandingGet Merchant's Profile
patch/v1/accountbrandingUpdate Merchant's Profile
get/v1/usersGet Users
post/v1/usersAdd User
get/v1/users/{user_id}Find User
delete/v1/users/{user_id}Delete User
patch/v1/users/{user_id}Update User
post/v1/users/{user_id}/attachAttach User
post/v1/roles/revokeRevoke Roles
post/v1/roles/assignAssign Roles
post/v1/password/forgotPassword Reset
get/v1/rolesGet Roles
post/v1/rolesCreate Role
post/v1/permissions/syncUpdate Role
delete/v1/roles/{role_id}Delete Role
post/v1/api/token/revealReveal API Token
get/v1/api/tokenGet API Token
post/v1/revoke-and-regenerateRevoke and Regenerate Token
get/v1/webhooksList Webhooks
post/v1/webhooksAdd Webhooks
delete/v1/webhooks/{id}Delete Webhook
patch/v1/webhooks/{id}Update (Disable) Webhooks
get/v1/terminalregistriesTerminal Registry
post/v1/terminalregistriesAdd New Terminal
delete/v1/terminalregistries/{TerminalID}Delete Terminal
post/v1/agent-hub/loginLogin Token

Changes to Login Token

post/v1/agent-hub/login

Nov 3, 2026d3ee769894e4 Revision changes
- info
  endpoint added