List Product Transactions Endpoint - Trace Knowledge Center

GET

transactions

product-transactions

curl --request GET \
  --url http://localhost:3000/connect/v1/transactions/product-transactions/ \
  --header 'Authorization: <api-key>'

{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "transaction_payments": [
        {
          "id": "<string>",
          "premium_details": {
            "id": "<string>",
            "options": [
              {
                "id": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "amount": 123,
                "is_active": true,
                "creator": "<string>",
                "updater": "<string>"
              }
            ],
            "updated_on": "2023-11-07T05:31:56Z",
            "created_on": "2023-11-07T05:31:56Z",
            "category": "PAYOUT",
            "name": "<string>",
            "type": "PER_TRANSACTION",
            "amount": 123,
            "included": true,
            "dependant_on_card": true,
            "applicable_activity": "BUY",
            "calculation_type": "NORMAL",
            "is_active": true,
            "creator": "<string>",
            "updater": "<string>",
            "owner": "<string>"
          },
          "currency_details": {
            "id": "<string>",
            "name": "<string>",
            "code": "<string>"
          },
          "type": "<string>",
          "currency": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "number": "<string>",
          "created_on": "2023-11-07T05:31:56Z",
          "date": "2023-11-07T05:31:56Z",
          "invoice": "<string>",
          "invoice_number": "<string>",
          "verification_latitude": 123,
          "verification_longitude": 123,
          "method": "CARD",
          "payment_type": "TRANSACTION",
          "amount": 123,
          "selected_option": "<string>",
          "creator": "<string>",
          "updater": "<string>",
          "source": "<string>",
          "destination": "<string>",
          "card": "<string>",
          "premium": "<string>",
          "transaction": "<string>",
          "submissions": [
            "<string>"
          ]
        }
      ],
      "amount": "<string>",
      "currency": "<string>",
      "type": "<string>",
      "source_quantity": "<string>",
      "current_quantity": "<string>",
      "submissions": [
        {
          "id": "<string>",
          "form_details": {
            "id": "<string>",
            "products": [
              {
                "id": "<string>",
                "premiums": "<string>",
                "is_active": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "description": "<string>",
                "image": "<string>",
                "creator": "<string>",
                "updater": "<string>"
              }
            ],
            "fields": [
              {
                "id": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "label": "<string>",
                "label_en_us": "<string>",
                "label_en_uk": "<string>",
                "label_fr": "<string>",
                "label_nl": "<string>",
                "label_ind": "<string>",
                "type": "TEXT",
                "key": "<string>",
                "required": true,
                "default_value": "<string>",
                "options": "<string>",
                "creator": "<string>",
                "updater": "<string>"
              }
            ],
            "field_config": [
              {
                "id": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "label": "<string>",
                "key": "<string>",
                "visibility": true,
                "required": true,
                "creator": "<string>",
                "updater": "<string>"
              }
            ],
            "updated_on": "2023-11-07T05:31:56Z",
            "created_on": "2023-11-07T05:31:56Z",
            "form_type": "TRANSACTION",
            "creator": "<string>",
            "updater": "<string>",
            "owner": "<string>"
          },
          "values": [
            {
              "id": "<string>",
              "field_details": {
                "id": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "label": "<string>",
                "label_en_us": "<string>",
                "label_en_uk": "<string>",
                "label_fr": "<string>",
                "label_nl": "<string>",
                "label_ind": "<string>",
                "type": "TEXT",
                "key": "<string>",
                "required": true,
                "default_value": "<string>",
                "options": "<string>",
                "creator": "<string>",
                "updater": "<string>"
              },
              "field": "<string>",
              "updated_on": "2023-11-07T05:31:56Z",
              "created_on": "2023-11-07T05:31:56Z",
              "value": "<string>",
              "creator": "<string>",
              "updater": "<string>"
            }
          ],
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "creator": "<string>",
          "updater": "<string>",
          "form": "<string>",
          "product": "<string>"
        }
      ],
      "card_details": {
        "id": "<string>",
        "card_id": "<string>",
        "updated_on": "2023-11-07T05:31:56Z",
        "created_on": "2023-11-07T05:31:56Z",
        "display_id": "<string>",
        "creator": "<string>",
        "updater": "<string>"
      },
      "currency_details": {
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "updated_on": "2023-11-07T05:31:56Z",
      "number": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "date": "2023-11-07T05:31:56Z",
      "invoice": "<string>",
      "invoice_number": "<string>",
      "verification_latitude": 123,
      "verification_longitude": 123,
      "method": "CARD",
      "quality_correction": 123,
      "quantity": "<string>",
      "creator": "<string>",
      "updater": "<string>",
      "source": "<string>",
      "destination": "<string>",
      "card": "<string>",
      "product": "<string>",
      "parents": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Query Parameters

updated_after

number

Filter results by items updated after the specified timestamp.

created_after

number

Filter results by items created after the specified timestamp.

updated_before

number

Filter results by items updated before the specified timestamp.

only_quantity_available

string

Filter results to only include items with available quantity.

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

Response

200 - application/json

count

integer

required

The total count of results.

results

object[]

required

Array containing product transactions.

results.amount

string

required

The amount of the transaction.

results.source

string

required

The source of the transaction.

results.destination

string

required

The destination of the transaction.

results.product

string

required

The product associated with the transaction.

results.id

string

Unique identifier for the transaction.

results.transaction_payments

object[]

Array of payment transactions associated with the product transaction.

results.transaction_payments.source

string

required

results.transaction_payments.destination

string

required

results.transaction_payments.id

string

results.transaction_payments.premium_details

object

results.transaction_payments.currency_details

object

results.transaction_payments.type

string

results.transaction_payments.currency

string

Minimum length: 1

results.transaction_payments.updated_on

string

results.transaction_payments.number

string | null

Maximum length: 10

results.transaction_payments.created_on

string

results.transaction_payments.date

string

results.transaction_payments.invoice

string | null

results.transaction_payments.invoice_number

string | null

Maximum length: 100

results.transaction_payments.verification_latitude

number

results.transaction_payments.verification_longitude

number

results.transaction_payments.method

enum<string> | null

Available options:

CARD,

INVOICE,

NONE

results.transaction_payments.payment_type

enum<string>

Available options:

TRANSACTION,

PREMIUM,

TRANSACTION_PREMIUM

results.transaction_payments.amount

number

results.transaction_payments.selected_option

string | null

Maximum length: 100

results.transaction_payments.creator

string

results.transaction_payments.updater

string

results.transaction_payments.card

string

results.transaction_payments.premium

string

results.transaction_payments.transaction

string

results.transaction_payments.submissions

string[]

results.currency

string

The currency used in the transaction.

Minimum length: 1

results.type

string

The type of the transaction.

results.source_quantity

string

The quantity from the source in the transaction.

results.current_quantity

string

The current quantity in the transaction.

results.submissions

object[]

Array of submissions associated with the product transaction.

results.submissions.values

object[]

required

results.submissions.form

string

required

results.submissions.id

string

results.submissions.form_details

object

results.submissions.form_details.fields

object[]

required

results.submissions.form_details.owner

string

required

results.submissions.form_details.id

string

results.submissions.form_details.products

object[]

results.submissions.form_details.field_config

object[]

results.submissions.form_details.updated_on

string

results.submissions.form_details.created_on

string

results.submissions.form_details.form_type

enum<string>

Available options:

TRANSACTION,

FARMER,

PAYMENT,

PRODUCT

results.submissions.form_details.creator

string

results.submissions.form_details.updater

string

results.submissions.updated_on

string

results.submissions.created_on

string

results.submissions.creator

string

results.submissions.updater

string

results.submissions.product

string

results.card_details

object

Details of the card used in the transaction.

results.currency_details

object

Details of the currency used in the transaction.

results.updated_on

string

Date and time when the transaction was last updated.

results.number

string | null

The number associated with the transaction.

Maximum length: 10

results.created_on

string

Date and time when the transaction was created.

results.date

string

The date of the transaction.

results.invoice

string | null

The invoice associated with the transaction.

results.invoice_number

string | null

The invoice number associated with the transaction.

Maximum length: 100

results.verification_latitude

number

The latitude of verification in the transaction.

results.verification_longitude

number

The longitude of verification in the transaction.

results.method

enum<string> | null

The method used in the transaction.

Available options:

CARD,

INVOICE,

NONE

results.quality_correction

number

The quality correction value in the transaction.

results.quantity

string | null

The quantity associated with the transaction.

results.creator

string

Identifier of the user who created the transaction.

results.updater

string

Identifier of the user who last updated the transaction.

results.card

string

The card used in the transaction.

results.parents

string[]

Array of parent transactions associated with the product transaction.

string | null

URI for the next page of results, if available.

string | null

URI for the previous page of results, if available.

Make a Transaction Retrieve User Information

curl --request GET \
  --url http://localhost:3000/connect/v1/transactions/product-transactions/ \
  --header 'Authorization: <api-key>'

{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "transaction_payments": [
        {
          "id": "<string>",
          "premium_details": {
            "id": "<string>",
            "options": [
              {
                "id": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "amount": 123,
                "is_active": true,
                "creator": "<string>",
                "updater": "<string>"
              }
            ],
            "updated_on": "2023-11-07T05:31:56Z",
            "created_on": "2023-11-07T05:31:56Z",
            "category": "PAYOUT",
            "name": "<string>",
            "type": "PER_TRANSACTION",
            "amount": 123,
            "included": true,
            "dependant_on_card": true,
            "applicable_activity": "BUY",
            "calculation_type": "NORMAL",
            "is_active": true,
            "creator": "<string>",
            "updater": "<string>",
            "owner": "<string>"
          },
          "currency_details": {
            "id": "<string>",
            "name": "<string>",
            "code": "<string>"
          },
          "type": "<string>",
          "currency": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "number": "<string>",
          "created_on": "2023-11-07T05:31:56Z",
          "date": "2023-11-07T05:31:56Z",
          "invoice": "<string>",
          "invoice_number": "<string>",
          "verification_latitude": 123,
          "verification_longitude": 123,
          "method": "CARD",
          "payment_type": "TRANSACTION",
          "amount": 123,
          "selected_option": "<string>",
          "creator": "<string>",
          "updater": "<string>",
          "source": "<string>",
          "destination": "<string>",
          "card": "<string>",
          "premium": "<string>",
          "transaction": "<string>",
          "submissions": [
            "<string>"
          ]
        }
      ],
      "amount": "<string>",
      "currency": "<string>",
      "type": "<string>",
      "source_quantity": "<string>",
      "current_quantity": "<string>",
      "submissions": [
        {
          "id": "<string>",
          "form_details": {
            "id": "<string>",
            "products": [
              {
                "id": "<string>",
                "premiums": "<string>",
                "is_active": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "description": "<string>",
                "image": "<string>",
                "creator": "<string>",
                "updater": "<string>"
              }
            ],
            "fields": [
              {
                "id": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "label": "<string>",
                "label_en_us": "<string>",
                "label_en_uk": "<string>",
                "label_fr": "<string>",
                "label_nl": "<string>",
                "label_ind": "<string>",
                "type": "TEXT",
                "key": "<string>",
                "required": true,
                "default_value": "<string>",
                "options": "<string>",
                "creator": "<string>",
                "updater": "<string>"
              }
            ],
            "field_config": [
              {
                "id": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "label": "<string>",
                "key": "<string>",
                "visibility": true,
                "required": true,
                "creator": "<string>",
                "updater": "<string>"
              }
            ],
            "updated_on": "2023-11-07T05:31:56Z",
            "created_on": "2023-11-07T05:31:56Z",
            "form_type": "TRANSACTION",
            "creator": "<string>",
            "updater": "<string>",
            "owner": "<string>"
          },
          "values": [
            {
              "id": "<string>",
              "field_details": {
                "id": "<string>",
                "updated_on": "2023-11-07T05:31:56Z",
                "created_on": "2023-11-07T05:31:56Z",
                "label": "<string>",
                "label_en_us": "<string>",
                "label_en_uk": "<string>",
                "label_fr": "<string>",
                "label_nl": "<string>",
                "label_ind": "<string>",
                "type": "TEXT",
                "key": "<string>",
                "required": true,
                "default_value": "<string>",
                "options": "<string>",
                "creator": "<string>",
                "updater": "<string>"
              },
              "field": "<string>",
              "updated_on": "2023-11-07T05:31:56Z",
              "created_on": "2023-11-07T05:31:56Z",
              "value": "<string>",
              "creator": "<string>",
              "updater": "<string>"
            }
          ],
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "creator": "<string>",
          "updater": "<string>",
          "form": "<string>",
          "product": "<string>"
        }
      ],
      "card_details": {
        "id": "<string>",
        "card_id": "<string>",
        "updated_on": "2023-11-07T05:31:56Z",
        "created_on": "2023-11-07T05:31:56Z",
        "display_id": "<string>",
        "creator": "<string>",
        "updater": "<string>"
      },
      "currency_details": {
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "updated_on": "2023-11-07T05:31:56Z",
      "number": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "date": "2023-11-07T05:31:56Z",
      "invoice": "<string>",
      "invoice_number": "<string>",
      "verification_latitude": 123,
      "verification_longitude": 123,
      "method": "CARD",
      "quality_correction": 123,
      "quantity": "<string>",
      "creator": "<string>",
      "updater": "<string>",
      "source": "<string>",
      "destination": "<string>",
      "card": "<string>",
      "product": "<string>",
      "parents": [
        "<string>"
      ]
    }
  ]
}

Trace Connect APIs

Authorizations

Query Parameters

Response