API Gateway

All 15 Payroc actions proxied through the gateway. Click a linked page to use the action in context, or test standalone actions directly.

Hosted Fields Session

setup

Get a secure token for hosted fields form rendering

hostedFieldsSessionUsed by CardPaymentDialog on POS

Sale

payment

Process a card payment with a hosted fields token

saleCard entry → "Manual Entry" on POS

Manual Sale

payment

Process payment with raw card details

manualSaleUsed by SaveCardDialog on Clients page

Terminal Sale

payment

Process payment via physical card terminal

terminalSaleCard entry → "Terminal" on POS

Pre-Authorization

payment

Pre-authorize an amount on a card for later capture

preAuthClick to test →

Capture

payment

Capture a previously pre-authorized amount

captureClick to test →

Void

adjustment

Cancel a pending transaction before settlement

voidBefore 5:45 PM MST cutoff

Refund

adjustment

Refund a settled transaction (full or partial)

refundClick a transaction → Refund

Charge Customer

customer

Charge a saved customer card on file

chargeCustomerSelect appt → Card → "Saved" on POS

Create Customer

customer

Create a customer profile with saved payment card

createCustomerAdd client → Save Card

Update Customer

customer

Update an existing customer profile

updateCustomerEdit client → Change card info

Get Customer

customer

Retrieve customer details and saved card info

getCustomerClick to test →

Tokenize Card

customer

Create a secure token from card details without charging

secureTokenClick to test →

Delete Customer

customer

Remove a customer profile from the gateway

deleteCustomerCustomer management page

Create Order

order

Create a new order record

createOrderPoint of sale checkout

Get Order

order

Retrieve order details by ID

getOrderReference lookup