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

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {}
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "transaction_id": 65,
      "gateway_id": 201,
      "currency_id": 1,
      "token": "6by30nr7dxlh",
      "transaction_date": "2015-02-16",
      "gateway_status": 1,
      "gateway_transid": "*TEST CC* Mon, 16 Feb 2015 16:29:13 -0500",
      "gateway_msg": "",
      "amount": 10.95,
      "fee": -0.33,
      "transaction_type": "pay",
      "transaction_method": "Visa",
      "transaction_detail": "x1111",
      "transaction_datetime": "2015-02-16 20:29:13",
      "void_datetime": null,
      "transaction_type_name": "Payment",
      "currency_symbol": "$",
      "currency_iso4217": "USD",
      "customer_id": 1
    },
    {
      "transaction_id": 66,
      "gateway_id": 202,
      "currency_id": 1,
      "token": "flsxubzeao0t",
      "transaction_date": "2015-02-20",
      "gateway_status": 0,
      "gateway_transid": null,
      "gateway_msg": "-",
      "amount": 25.95,
      "fee": 0,
      "transaction_type": "pay",
      "transaction_method": "Visa",
      "transaction_detail": "x1111",
      "transaction_datetime": "2015-02-20 20:20:34",
      "void_datetime": null,
      "transaction_type_name": "Payment",
      "currency_symbol": "$",
      "currency_iso4217": "USD",
      "customer_id": 1
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...