Skip to main content

Query for transactions

GET 
/api/v3/transaction

Available query parameter values for filtering:

  • transaction_id
  • customer_id
  • gateway_id
  • currency_id
  • creditcard_id
  • ach_id
  • tokenized_id
  • token
  • external_key
  • gateway_status
  • gateway_transid
  • amount
  • fee
  • transaction_type
  • transaction_method
  • transaction_detail
  • transaction_datetime
  • transaction_status.state
  • transaction_status.str
  • applied_to.package_id (this will find transactions that are applied to invoices from a specific package)
  • applied_to.package_external_key (this will find transactions that are applied to invoices from a specific package)
  • applied_to.invoice_id (this will find transactions that are applied to a particular invoice)

Request​

Query Parameters

    where string

    transaction_type:EQUALS:pay

    order string

    transaction_id:ASC

    limit string

    2

    offset string

    8

Responses​

Object was fetched successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable

    response

    object[]

  • Array [

    • transaction_id integer

    Transaction ID #

    parent_transaction_id integer

    Parent transaction ID #

    transaction_batch_id integer

    Transaction batch ID #

    customer_id integer

    Customer ID #

    brand_id integer

    Brand ID #

    gateway_id integer

    Payment gateway ID #

    gateway_type string

    Payment gateway type

    gateway_nickname string

    Nickname for the payment gateway

    gateway_status integer

    Payment gateway status (1 for success, 0 for failure)

    gateway_transid string

    Payment gateway transaction identifier

    gateway_method string

    Payment gateway method

    gateway_msg string

    A customer-facing error message indicating why the transaction declined/failed

    gateway_err_code integer

    A merchant-facing specific error code indicating why the transaction declined/failed

    gateway_err_detail string

    A merchant-facing detailed error message indicating why the transaction declined/failed

    gateway_opts string

    Additional gateway-specific data

    token string

    A unique token for the transaction

    external_key string

    Transaction external key value

    currency_id integer

    Currency ID #

    currency_iso4217 string

    Currency ISO 4217 code

    currency_symbol string

    Currency symbol

    amount float

    Total transaction amount (refunds will be negative)

    fee float

    Transaction fee (if gateway provides this data)

    applied float

    Amount that is applied to invoices

    unapplied float

    Amount that is unapplied (not applied to any invoices)

    transaction_date date

    Date of the transaction

    transaction_status_name string

    Human-friendly transaction status

    transaction_status_str string

    Status string

    transaction_status_state string

    State code

    transaction_type string

    Transaction type (one of: pay, ref, cre, spl)

    transaction_type_name string

    Transaction type name

    transaction_method string

    Transaction method

    transaction_detail string

    Transaction details

    transaction_datetime string

    Date/time of the transaction was created

    transaction_ipaddr string

    IP address that created the transaction

    void_datetime string

    Date/time the transaction was voided

    url_self string

    URL for viewing the transaction in the GUI

    applied_to

    object[]

    Information about how the payment is applied

  • Array [

    • transaction_applied_id integer

    Line item ID #

    transaction_id integer

    Transaction ID #

    invoice_id integer

    Invoice ID #

    invoice_schedule_id integer

    Invoice schedule ID #

    applied float

    Amount applied to the invoice

  • ]

    • custom_1 string

    Custom field #1

    custom_2 string

    Custom field #2

    custom_3 string

    Custom field #3

    custom_4 string

    Custom field #4

    custom_5 string

    Custom field #5

    memo string

    Transaction memo

  • ]

Loading...