Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Transactions

Get a transaction

Get transaction details by specific transaction ID. Query params will determine the level of transaction details returned. Expand on the information returned by including 'with' in the query parameters to include additional details of the transaction. For multiple attributes, separate with a comma (example : with=sale,credits)

get/transactions/{transaction_id}

Query parameters

with'order' | 'order_revisions' | 'line_items' | 'sale' | 'credits' | 'customer' | 'customer_card' | 'customer_address_billing' | 'customer_address_shipping' | 'shipments' | 'campaign' | 'merchant' | 'route_logs' | 'actions'

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

Response

OK

transaction_idinteger
connection_transaction_idstring nullable
customer_idinteger
order_idinteger
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
transaction_cycleinteger
transaction_attemptinteger
transaction_declinedboolean
merchant_idinteger
transaction_merchant_descriptorstring
response_codeinteger nullable
transaction_3ds_verified_statusstring nullable
gateway_response_idstring nullable
gateway_auth_codestring nullable
gateway_response_codestring nullable
gateway_response_descriptionstring nullable
gateway_response_avsstring nullable
gateway_response_cvvstring nullable
processor_response_textstring nullable
currency_idinteger
transaction_pricestring
transaction_discount_totalstring
transaction_shippingstring
transaction_sub_totalstring
transaction_taxstring
transaction_feestring
customer_balance_appliedstring
gift_card_appliedstring
transaction_totalstring
order_discount_totalstring
check_numberstring nullable
check_amountstring
dunning_cycle_idinteger nullable
dunning_cycle_totalstring
quantity_discount_cycle_idinteger nullable
quantity_discount_cycle_totalstring
discount_cycle_idinteger nullable
discount_cycle_totalstring
date_scheduledstring date-time
date_completestring date-time nullable
date_cancelledstring date-time nullable
date_skipstring date-time nullable
date_batchstring date-time nullable
date_depositstring date-time nullable
date_requeststring date-time nullable
date_responsestring date-time nullable
rebill_datestring date-time nullable
original_attempt_datestring date-time nullable
transaction_parent_idinteger nullable
parent_date_completestring date-time nullable
transaction_initial_idinteger nullable
is_prepaidboolean
customer_card_type_idnull | 1 | 2 | 3 | 4 | 5 | 6 | 7 nullable
  • 1 - Mastercard
  • 2 - Visa
  • 3 - Discover
  • 4 - American Express
  • 5 - Digital Wallet
  • 6 - ACH
  • 7 - SEPA
customer_card_binstring
chargeback_datestring date-time nullable
chargeback_codestring nullable
chargeback_reference_idstring nullable
chargeback_case_idstring nullable
transaction_total_usdstring
transaction_shipping_usdstring
transaction_tax_usdstring
transaction_price_usdstring
transaction_discount_total_usdstring
customer_balance_applied_usdstring
transaction_fee_usdstring
gift_card_applied_usdstring
date_createdstring date-time
created_byinteger
modified_byinteger
date_modifiedstring date-time
transaction_notesstring nullable

Example response

{
  "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"
    }
  ]
}