Release Notes

Terminal API

The Terminal API is now available in the Run Developer! Connect your software to P2PE-validated, card-present acceptance solutions via Run Developer. Your customers can swipe, dip, or tap on an integrated card reader, and your POS will receive a tokenized card or a completed charge without card data ever touching your systems. Read more in our Terminal API Overview.

To request a UAT device and credentials, please reach out to your Integration Delivery Lead or send a note to integrations@runpayments.io.

Endpoints added

The following endpoints have been added to the Run Payments API Reference:

• Authentication: WebSocket

  • POST /api/ws-token: Generate a single-use WebSocket auth token.

• Terminals

  • GET /api/terminal: List your terminals and their capabilities.
  • POST /api/terminal/{device_id}/connect: Connect a terminal session.
  • DELETE /api/terminal/{device_id}/disconnect: Disconnect a terminal session.
  • POST /api/terminal/{device_id}/ping: Ping a terminal.

• Card Read

  • POST /api/terminal/{device_id}/read-card: Initiate a card read.
  • GET /api/terminal/{device_id}/read-card/{interaction_id}: Get card read status.
  • DELETE /api/terminal/{device_id}/cancel/{interaction_id}: Cancel a card read.

• Charge Card

  • POST /api/terminal/{device_id}/charge-card: Read the card, optionally capture a signature, charge, and optionally deliver a receipt.
  • GET /api/terminal/{device_id}/charge-card/{interaction_id}: Get charge status.

• Receipt

  • POST /api/terminal/{device_id}/print-receipt: Print a receipt on the device.
  • POST /api/v1/send_receipt: Email a receipt to your customer.

Card Present Guides

The following guides have been added to the Run Developer site under Guides > Payments > Card Present:

• Overview: Choosing between the unified and two-step integration paths, supported devices, and the end-to-end flow
• Getting Started: Environment, authentication, and terminal capabilities
• Interactions & Status: Polling, WebSockets, cancelling, and sessions
• Unified Charge Workflow: Running charge-card and handling declines and stage_errors
• Signatures & Receipts: Capturing signatures and printing or emailing receipts
• Surcharging on Device: Card-present surcharging for enrolled merchants
• Endpoints & Errors: Endpoint summary, response codes, and error messages

API Reference Navigation

We have reorganized the API Reference into two sections based on authentication method. Please note the updated locations below.

• Processing (Payments and Terminal APIs): Authenticate with your Payments API key as a bearer token. Refresh API Keys has moved to its own Authentication section here.
• Reporting & Boarding (Reporting and Boarding APIs): Authenticate with OAuth 2.0 client credentials generated from Run Merchant or provided by your Run Integration Delivery rep.