Transaction

Get Transaction Details by Either order_id or external_id

get

https://test.api.us.sanctuspay.comhttps://live.api.us.sanctuspay.com

/transaction

Retrieves the details of a specific transaction by using either the external_id or the order_id. You must indicate which identifier type you are passing.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typeundefined · enumRequired

Indicates whether the provided id is the external_id or the order_id.

Possible values:

idstringRequired

The value of the external_id or the order_id being used.

Responses

200

The requested transaction details.

application/json

get

/transaction

HTTPcURLJavaScriptPython

GET /transaction?type=external_id&id=text HTTP/1.1
Host: test.api.us.sanctuspay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The requested transaction details.

{
  "id": "trx_01J5XCMDXCFXCAQ1BV8HVG6644",
  "type": "PAYMENT",
  "status": "AUTHORIZED",
  "order_amount": 10000,
  "order_currency": "USD",
  "amount_authorized": 10000,
  "amount_captured": 1,
  "amount_voided": 1,
  "amount_refunded": 1,
  "external_id": "496de72d-d4a4-45eb-b426-3d04d2078a85",
  "updated_at": "2024-09-05T05:05:25Z"
}