Prepaid Orders

With Paytronix Online Ordering, integrators have the ability to collect order payment outside of our platform and submit orders as prepaid.

Marking Orders as Prepaid

Prepaid integration orders should be submitted with a payment_type of 'integration'.

Auth/Capture

It is recommended that integrators authorize a card before order submission and capture the funds after an order is accepted by the restaurant (accounting for manual confirmation if enabled). Order submission can fail for several reasons, and waiting to capture the funds means the transaction doesn’t need to be refunded if it fails. If capture happens before submission, the integration must handle refunding failed submissions.

Payment Tracking

Orders with integration payments must submit a payment transaction token for tracking purposes. The payment transaction token should be a value that can be shared with the integrator/merchant to look up specific payment transactions. This will typically identify the auth transaction, since the capture won’t have happened prior to submission (based on the recommendation above).

Prepaid integration orders should be submitted with a 'payment_transaction_token' field where the value uniquely identifies the payment transaction. Paytronix only verifies that this field is populated and cannot verify it corresponds to a real transaction. The final order will have this token in a paid field that tracks the payment transaction.

Refunds

Refunds will be disabled for orders prepaid by an integration. Refunds must be initiated through the integration collecting the payment.

Configuring Prepaid Orders

There is required configuration on the integration level, the merchant, and the restaurant level. All configuration steps must be completed before integration payments can be accepted.

  1. Enforce Hash-Based Message Authentication Code (HMAC) Signing
    • HMAC signing documentation
    • HMAC signing is a cryptographic technique that uses a secret key and hash function to verify data authenticity and integrity.
    • Enforcing HMAC signing is a requirement to enable integration payments to ensure secure server-to-server communication.
    • This can be configured through the internal “Edit Integration” page.

  2. Enable prepaid orders on the integration
    • This allows the integration API key to submit orders as prepaid.
    • Cannot be enabled until HMAC signing is enforced.
    • This can be set in the Integration Settings.

  3. Enable prepaid orders for the merchant.
    • This is needed because integrations at Paytronix can be used by multiple merchants.
    • This can be set in the Merchant Level General Settings.

  4. Enable prepaid orders for specific order types.
    • Payment methods can be enabled/disabled for specific order types (takeout/delivery).
    • This can be set on the merchant level for groups of restaurants or on the individual restaurant level in the Order Payment Settings.