For AI agents: visit https://pinpad.docs.netevia.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
PinPad
GuidesAPI Reference
v1.0

Log InPinPad
API Reference
Log In
v1.0GuidesAPI Reference

Introduction

  • Getting started
  • Administration section
  • Resources

Global network integration

  • Global connection
  • Mediator API

Local network integration

  • Local connection

Message format

  • Message format
  • Message types
  • Error codes

Message payloads

  • PIN Pad information
    • Response payload
  • Payment
    • Request payload
    • Response payload
  • Payment state (transient)
    • Response payload
  • Payment tender
    • Response payload
  • Void
    • Request payload
  • Refund
    • Request payload
    • Response payload
  • Capture
    • Request payload
    • Response payload
  • Tip adjustment
    • Request payload
    • Response payload
  • Batch report
    • Request payload
    • Response payload
  • Batch total
    • Response payload
  • Batch close
    • Request payload
    • Response payload
  • <Transaction>
  • <Batch report>

Transaction conditions

  • Void
  • Refund
  • Capture
  • Tip adjustment

Examples

  • Payment
    • Request
    • Response
    • Response when a tender selected by customer
  • Void
    • Request
    • Response
  • Refund
    • Request
    • Response
  • Capture
    • Request
    • Response
  • Tip adjustment
    • Request
    • Response
  • Batch report
    • Request
    • Response
  • Batch close
    • Request
    • Response
Powered by 

Request payload

{
  // Auth transaction being captured
  "originalTx": <Transaction>
}

Updated over 1 year ago


Response payload
Response payload
Did this page help you?

Updated over 1 year ago


Response payload
Response payload
Did this page help you?