---
title: Transaction API Reference
slug: api-reference
docTags: 
createdAt: 2024-07-25T12:36:15.728Z
---

Judopay’s Transaction API Reference documentation provides information on the available endpoints.

:::hint{type="info"}
All examples within the Judopay documentation use the **sandbox environment** so you can process test transactions while developing your app.
:::

**Important Fields**: Before you get started, note the key fields that need to be sent between your app and Judopay when making payments:

- **Judo Id**:
  - Specific to a merchant or location you wish to pay.
  - String of numbers.
  - Maximum length 9 characters.
  - Format: 100100100
  - Do not include spaces or dashes.
- **Your consumer reference**:
  - Allows you to uniquely identify your customer.
  - **Must **be supplied in a payment request.
  - Can be used to help merchants to reconcile.
  - Can be used to prevent fraud from occurring through the system.
  - All subsequent transactions must exactly match the consumer reference as it is case sensitive.
- **Your payment reference**:
  - Your reference for a payment.
  - Should be unique to protect your customers against duplicate transactions.
  - All subsequent transactions must exactly match the payment reference as it is case sensitive.

For more information, see [Key Terms.](docId\:S_8hOAMytkgY13t0P657-)
For more information on how to use our Transaction API, see [Interact with the Transaction API](docId\:ApyEqDsYCdRKUxgGnLHup).

View our [API Change Logs](docId\:OPWJu7rMaXcDj6bkiMg35).