Appearance

Search Transactions ​

Get Transaction By ID ​

Retrieve details for a specific transaction.

Request Method: GET

URL Endpoint: /api/transaction/{ transaction ID }

json
{
  "status": "success",
  "msg": "success",
  "data": [
    {
      "id": "b7kgflt1tlv51er0fts0",
      "type": "sale",
      "amount": 1112,
      "tax_amount": 100,
      "tax_exempt": false,
      "shipping_amount": 100,
      "currency": "usd",
      "description": "test transaction",
      "order_id": "someOrderID",
      "po_number": "somePONumber",
      "ip_address": "4.2.2.2",
      "email_receipt": false,
      "payment_method": "card",
      "response": {
        "card": {
          "id": "b7kgflt1tlv51er0ftsg",
          "card_type": "visa",
          "first_six": "401200",
          "last_four": "5439",
          "masked_card": "401200******5439",
          "expiration_date": "12/20",
          "status": "approved",
          "auth_code": "TAS731",
          "processor_response_code": "00",
          "processor_response_text": "APPROVAL TAS731 ",
          "processor_type": "tsys_sierra",
          "processor_id": "b7kgflt1tlv51er0f1sg",
          "avs_response_code": "0",
          "cvv_response_code": "M",
          "processor_specific": {},
          "created_at": "2017-10-19T20:15:19.80368Z",
          "updated_at": "2017-10-19T20:15:20.777011Z"
        }
      },
      "status": "pending_settlement",
      "billing_address": {
        "first_name": "John",
        "last_name": "Smith",
        "company": "Test Company",
        "address_line_1": "123 Some St",
        "address_line_2": "",
        "city": "Wheaton",
        "state": "IL",
        "postal_code": "60187",
        "country": "US",
        "phone": "5555555555",
        "fax": "5555555555",
        "email": "help@website.com"
      },
      "shipping_address": {
        "first_name": "John",
        "last_name": "Smith",
        "company": "Test Company",
        "address_line_1": "123 Some St",
        "address_line_2": "",
        "city": "Wheaton",
        "state": "IL",
        "postal_code": "60187",
        "country": "US",
        "phone": "5555555555",
        "fax": "5555555555",
        "email": "help@website.com"
      },
      "created_at": "2017-10-19T20:15:19.560708Z",
      "updated_at": "2017-10-19T20:15:20.832049Z"
    }
  ],
  "total_count": 1
}

Search Transactions ​

Retrieve details for all transactions that match provided search criteria.

TIP

If you do not pass in a created_at date range, we will default this range to the prior four months.

Request Method: POST

URL Endpoint: /api/transaction/search

QuerySearchString: Operator can be =, !=

QuerySearchInt: Operator can be =, !=, <, >

json
Example Body
{
  "{name}": {
    "operator": "=",
    // =, !=, <, >
    "value": "{value}"
  }
}
NameTypeDescription
transaction_idQuerySearchStringSearches for transaction id
user_idQuerySearchStringSearches for user_id
typeQuerySearchStringSearches for transaction type (sale, authorize...etc)
ip_addressQuerySearchStringSearches for ip_address, either ipv4 or ipv6
amountQuerySearchIntSearches for originally requested amount
amount_authorizedQuerySearchIntSearches for amount_authorized
amount_capturedQuerySearchIntSearches for amount_captured
amount_settledQuerySearchIntSearches for amount_settled
tax_amountQuerySearchIntSearches for tax_amount
po_numberQuerySearchStringSearches for po_number
order_idQuerySearchStringSearches for order_id
payment_methodQuerySearchStringSearches by payment_method, (token, card, terminal)
payment_typeQuerySearchStringSearches by payment_type (card, echeck)
statusQuerySearchStringSearches by transaction status (unknown, declined, authorized, pending_settlement, settled, voided, reversed, refunded)
processor_idQuerySearchStringSearches by processor_id
customer_idQuerySearchStringSearches by customer_id
settlement_batch_idQuerySearchStringSearches by settlement_batch_id
created_atQueryDateRangeSearches by created_at between the provided start_date and end_date. (Dates in UTC "YYYY-MM-DDTHH:II:SSZ")
captured_atQueryDateRangeSearches by captured_at between the provided start_date and end_date. (Dates in UTC "YYYY-MM-DDTHH:II:SSZ")
settled_atQueryDateRangeSearches by settled_at between the provided start_date and end_date. (Dates in UTC "YYYY-MM-DDTHH:II:SSZ")
billing_address
    .address_id		QuerySearchStringSearches by billing_address.id
billing_address
    .first_name		QuerySearchStringSearches by billing_address.first_name (0-50 characters)
billing_address
    .last_name		QuerySearchStringSearches by billing_address.last_name (0-50 characters)
billing_address
    .company		QuerySearchStringSearches by billing_address.company (0-50 characters)
billing_address
    .address_line_1		QuerySearchStringSearches by billing_address.address_line_1 (0-100 characters)
billing_address
    .address_line_2		QuerySearchStringSearches by billing_address.address_line_2 (0-100 characters)
billing_address
    .city		QuerySearchStringSearches by billing_address.city (0-50 characters)
billing_address
    .state		QuerySearchStringSearches by billing_address.state (2 Character)
billing_address
    .postal_code		QuerySearchStringSearches by billing_address.postal_code (0-6 Characters)
billing_address
    .country		QuerySearchStringSearches by billing_address.country (2 Characters)
billing_address
    .email		QuerySearchStringSearches by billing_address.email
billing_address
    .phone		QuerySearchStringSearches by billing_address.phone (0-14 digits only)
billing_address
    .fax		QuerySearchStringSearches by billing_address.fax (0-14 digits only)
shipping_address
    .address_id		QuerySearchStringSearches by shipping_address.id
shipping_address
    .first_name		QuerySearchStringSearches by shipping_address.first_name (0-50 characters)
shipping_address
    .last_name		QuerySearchStringSearches by shipping_address.last_name (0-50 characters)
shipping_address
    .company		QuerySearchStringSearches by shipping_address.company (0-50 characters)
shipping_address
    .address_line_1		QuerySearchStringSearches by shipping_address.address_line_1 (0-100 characters)
shipping_address
    .address_line_2		QuerySearchStringSearches by shipping_address.address_line_2 (0-100 characters)
shipping_address
    .city		QuerySearchStringSearches by shipping_address.city (0-50 characters)
shipping_address
    .state		QuerySearchStringSearches by shipping_address.state (2 Character)
shipping_address
    .postal_code		QuerySearchStringSearches by shipping_address.postal_code (0-6 Characters)
shipping_address
    .country		QuerySearchStringSearches by shipping_address.country (2 Characters)
shipping_address
    .email		QuerySearchStringSearches by shipping_address.email
shipping_address
    .phone		QuerySearchStringSearches by shipping_address.phone (0-14 digits only)
shipping_address
    .fax		QuerySearchStringSearches by shipping_address.fax (0-14 digits only)
limitintegerMaximum records to return (0-100)
offsetintegerNumber of records to offset the return by