For AI agents: the docs index is at https://pinpad.docs.netevia.com/llms.txt. 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 

Refund

Allowed when the following conditions are met:

  • transaction type: Sale;
  • current refunded amount is less that the transaction amount;
  • transaction is not voided;
  • tender type: not Cash.

Updated 7 months ago


Void
Capture
Did this page help you?

Updated 7 months ago


Void
Capture
Did this page help you?