v2

latestOpenAPI 3.0.0Commercial2026-07-2649110209.4 KB

Transactions

Get a transaction by ID

Retrieve a single transaction by ID. View payment details, status, and associated order information.

get/v1/transactions

Query parameters

transaction_idstring required

Example:txn_1234567890

The unique identifier of the transaction.

Response

Successfully retrieved transaction

idstring required

Unique identifier for the object.

mode'test' | 'prod' | 'sandbox' required

String representing the environment.

objectstring required

String representing the object's type. Objects of the same type share the same value.

amountnumber required

The transaction amount in cents. 1000 = $10.00

amount_paidnumber nullable

The amount the customer paid in cents. 1000 = $10.00

discount_amountnumber nullable

The discount amount in cents. 1000 = $10.00

currencystring required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

type'payment' | 'invoice' required

The type of transaction. payment(one time payments) and invoice(subscription)

tax_countrystring nullable

The ISO alpha-2 country code where tax is collected.

tax_amountnumber nullable

The sale tax amount in cents. 1000 = $10.00

Status of the transaction.

refunded_amountnumber nullable

The amount that has been refunded in cents. 1000 = $10.00

orderstring nullable

The order associated with the transaction.

subscriptionstring nullable

The subscription associated with the transaction.

customerstring nullable

The customer associated with the transaction.

descriptionstring

The description of the transaction.

period_startnumber

Start period for the invoice as timestamp

period_endnumber

End period for the invoice as timestamp

created_atnumber required

Creation date of the order as timestamp

Example response

{
  "object": "transaction",
  "amount": 2000,
  "amount_paid": 2000,
  "discount_amount": 2000,
  "currency": "USD",
  "tax_country": "US",
  "tax_amount": 2000,
  "refunded_amount": 2000
}