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

null

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...