v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Transactions

Search transactions

get/transactions

Query parameters

transaction_idstring

Search for specific transaction ID(s). Comma separate for multiple.

order_idinteger

Search for transactions that belong to a specific order.

customer_idinteger

Search for transactions that belong to a specific customer.

date_complete_fromstring date-time

Example:2023-04-01 00:00:00

Return only transactions that were completed on or after this date. A date to and from field is required when not passing transaction ID(s), a customer ID, a transaction charge ID or order ID.

date_complete_tostring date-time

Example:2023-04-01 00:00:00

Return only transactions that were completed on or before this date. Required when passing date_complete_from. Maximum date range: 31 days.

date_scheduled_fromstring date-time

Example:2023-04-01 00:00:00

Return only transactions that were scheduled on or after this date. A date to and from field is required when not passing transaction ID(s), a customer ID, a transaction charge ID or order ID.

date_scheduled_tostring date-time

Example:2023-04-01 00:00:00

Return only transactions that were scheduled on or before this date. Required when passing date_scheduled_from. Maximum date range: 31 days.

transaction_status1 | 2 | 3 | 4 | 5

1 - Pending
2 - Complete
3 - Scheduled
4 - Cancelled
5 - Skipped

Return transactions of a specific status.

1 - Pending
2 - Complete
3 - Scheduled
4 - Cancelled
5 - Skipped

payment_method_id1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13

1 - Credit Card
2 - Check
3 - Google Pay
4 - Apple Pay
5 - Cash
6 - Paypal
7 - Alternative Payments Sofort
8 - Alternative Payments POLi
9 - Alternative Payments SEPA
10 - ACH
11 - Afterpay
12 - Klarna
13 - SEPA

transaction_type_id1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10

1 - Sale
2 - Refund
3 - Void
4 - Chargeback
5 - Alert
6 - Auth
7 - Capture
8 - COD
9 - Chargeback Reversal
10 - Returned Check

merchant_idinteger

Search transactions for a specific merchant.

campaign_idinteger

Search transactions that are tied to orders of a specific campaign.

gateway_response_idstring

Search transactions by the gateway response ID.

transaction_totalstring

Search transactions by the total.

currency_idinteger

Return transactions that were charges in a specific currency. Comma separate for Multiple

1 - USD
2 - EUR
3 - GBP
4 - CAD
5 - AUD
6 - NZD
7 - DKK
8 - SEK
9 - NOK

transaction_cycleinteger

Search transactions by cycle.

transaction_successboolean

Search transactions by success status.

transaction_attemptinteger

Search transactions by attempt.

card_binstring

Search transactions that were charged on specific BINs.

card_last_4string

Search transactions that were charged on cards with a specific last 4.

tracking1-20string

Search transactions by order Custom Tracking Variable Options 1-20.

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=order,customer)

limitinteger

Limit the number of results. Default: 25, max: 200.

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

totalinteger

Example response

{
  "transactions": [
    {
      "date_scheduled": "2023-04-01 00:00:00",
      "date_complete": "2023-04-01 00:00:00",
      "date_cancelled": "2023-04-01 00:00:00",
      "date_skip": "2023-04-01 00:00:00",
      "date_batch": "2023-04-01 00:00:00",
      "date_deposit": "2023-04-01 00:00:00",
      "date_request": "2023-04-01 00:00:00",
      "date_response": "2023-04-01 00:00:00",
      "rebill_date": "2023-04-01 00:00:00",
      "original_attempt_date": "2023-04-01 00:00:00",
      "parent_date_complete": "2023-04-01 00:00:00",
      "chargeback_date": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "order": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00",
        "date_authorized": "2023-04-01 00:00:00",
        "date_auto_capture": "2023-04-01 00:00:00",
        "date_ordered": "2023-04-01 00:00:00",
        "date_capture": "2023-04-01 00:00:00"
      },
      "order_revisions": [
        {
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "customer": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00",
        "customer_cards": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ],
        "customer_addresses": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ]
      },
      "customer_card": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "customer_address_billing": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "customer_address_shipping": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "merchant": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "sale": {
        "date_sale": "2023-04-01 00:00:00",
        "date_attempt": "2023-04-01 00:00:00"
      },
      "credits": [
        {
          "date_scheduled": "2023-04-01 00:00:00",
          "date_complete": "2023-04-01 00:00:00",
          "date_cancelled": "2023-04-01 00:00:00",
          "date_skip": "2023-04-01 00:00:00",
          "date_batch": "2023-04-01 00:00:00",
          "date_deposit": "2023-04-01 00:00:00",
          "date_request": "2023-04-01 00:00:00",
          "date_response": "2023-04-01 00:00:00",
          "rebill_date": "2023-04-01 00:00:00",
          "original_attempt_date": "2023-04-01 00:00:00",
          "parent_date_complete": "2023-04-01 00:00:00",
          "chargeback_date": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "line_items": [
        {
          "date_complete": "2023-04-01 00:00:00"
        }
      ],
      "shipments": [
        {
          "date_cancel": "2023-04-01 00:00:00",
          "date_scheduled": "2023-04-01 00:00:00",
          "date_complete": "2023-04-01 00:00:00",
          "date_scan": "2023-04-01 00:00:00",
          "date_deliver": "2023-04-01 00:00:00",
          "date_return": "2023-04-01 00:00:00",
          "date_skip": "2023-04-01 00:00:00",
          "date_rma": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00",
          "customer_address_billing": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "customer_address_shipping": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "tracking_history": [
            {
              "date": "2023-04-01 00:00:00"
            }
          ]
        }
      ],
      "route_logs": [
        {
          "date_complete": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00"
        }
      ]
    }
  ]
}