Get a specific transaction

GET 
/api/v3/transaction/:transaction_id

Getting a transaction (a payment, refund, credit, etc.) gives you the full transaction details.

A couple of notes about some specific attributes returned:

• applied_to - if the payment is applied to any invoices, a list of invoices and the amount of the payment applied will be listed here
• refunds - for payments, if any portion of the payment was refunded, a list of related refund transaction_id values will be here
• payments - for refunds, the original payment transaction_id value will be here

Request

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": "",
  "details": {},
  "response": {
    "transaction_id": 43,
    "gateway_id": 201,
    "currency_id": 1,
    "external_key": null,
    "token": "185g5984n91k",
    "transaction_date": "2019-07-24",
    "gateway_status": 1,
    "gateway_transid": "1563978556",
    "gateway_msg": "",
    "gateway_err_code": 0,
    "gateway_err_detail": null,
    "gateway_opts": {
      "time_stamp": "Wed, 24 Jul 2019 09:29:16 -0500",
      "auth_code": "ABC123"
    },
    "gateway_method": "visa",
    "amount": 75,
    "fee": 0,
    "transaction_type": "pay",
    "transaction_method": "Visa",
    "transaction_detail": "x1111",
    "transaction_datetime": "2019-07-24 09:29:16",
    "transaction_ipaddr": "10.80.1.1",
    "void_datetime": null,
    "transaction_status_name": "Success",
    "transaction_status_str": "ok-successful",
    "transaction_status_state": "o",
    "transaction_type_name": "Payment",
    "applied": 75,
    "brand_id": 1,
    "currency_symbol": "$",
    "currency_iso4217": "USD",
    "url_self": "https://dev1.chargeover.com/admin/r/transaction/view/43",
    "customer_id": 48,
    "unapplied": 0,
    "applied_to": [
      {
        "invoice_id": 1027,
        "applied": 75
      }
    ],
    "refunds": [
      {
        "transaction_id": 44
      }
    ]
  }
}

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
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

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

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...