Show Transaction entity.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.transactions.get({
  id: 0,
});

Responses

200404

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "processed": true,
  "cancelable": true,
  "refundable": true,
  "removable": true,
  "type": "payment",
  "status": "open",
  "amount": "-1581.00",
  "datetime": "datetime",
  "description": "description",
  "transactionId": "tr_7UhSN1zuXS",
  "paymentUrl": "paymentUrl",
  "created": "created",
  "modified": "modified"
}

Response 404

Not found

application/json

Example 1

{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}

Path parameters

• idnumberrequired

Returns

Schema shown for 200 · application/json

• idnumber
• typestringoptional
  Allowed values: payment, refund, chargeback
• statusstringoptional
  Allowed values: open, cancelled, pending, authorized, expired, failed, paid, refunding, reclaimed, refunded, unknown
• amountstringoptional
• processedboolean

  Indicates whether the transaction has reached an end-state

• cancelableboolean
• refundableboolean
• removableboolean
• datetimestringoptional
• descriptionstringoptional
• transactionIdstringoptional
• paymentUrlstringoptional

  URL of the checkout/payment page for this transaction

• createdstringoptional
• modifiedstringoptional