Transactions

Find one Transaction

Retrieve a Transaction by its ID

get/transactions/{id}

Path parameters

idstring required

Response

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The unique identifier of the transaction

status'pending' | 'confirmation_requested' | 'authorized' | 'failed' required

Current status of the transaction

authentication'not_requested' | 'pending' | 'succeeded' | 'failed' required

How far the transaction got through customer authentication — 3-D Secure for a card, the equivalent payer-action step for a redirect-based method. not_requested when the gateway never asked for it, so an absent challenge is distinguishable from a failed one.

amountnumber required

Transaction amount in minor currency units (e.g., 1500 for $15.00)

initiator'customer' | 'merchant' required

The initiator of the transaction

statementDescriptorstring nullable

The statement descriptor that will appear on the customer's statement. Only available from the dashboard or the API using a secret key.

amountReversednumber required

The amount that has been reversed by refunds or voids

amountCapturednumber required

The amount that has been captured

isReversedboolean required

Whether the transaction has been reversed

isFullyReversedboolean required

Whether the transaction has been fully reversed

isCaptureFailedboolean required

Whether the capture operation failed

isReverseFailedboolean required

Whether the reverse operation failed

isRefundFailedboolean required

Whether the refund operation failed

isVoidFailedboolean required

Whether the void operation failed

isCapturedboolean required

Whether the transaction has been captured

isChargebackedboolean required

Whether the transaction has a chargeback recorded

chargebackRecordedAtstring date-time nullable

The timestamp when a chargeback was recorded for this transaction

captureMethod'automatic' | 'automaticDelayed' | 'manual' required

Capture method used for this transaction

captureDelaynumber nullable required

Delay in days before capture occurs. Only applicable for 'automaticDelayed' capture method.

currency'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk' required

Currency of the transaction

processorIdstring nullable

The external transaction ID from the payment processor. Only available from the dashboard or the API using a secret key.

paymentstring required

The ID of the payment this transaction belongs to

executionstring nullable

The cascade execution associated with this transaction. Only available from the dashboard or the API using a secret key.

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "status": "authorized",
  "authentication": "not_requested",
  "amount": 1500,
  "initiator": "customer",
  "statementDescriptor": "Hello World",
  "amountCaptured": 1500,
  "isCaptured": true,
  "chargebackRecordedAt": "2026-01-15T10:30:00.000Z",
  "captureMethod": "automatic",
  "currency": "usd",
  "processorId": "ch_1J8lZpJ9j1bSv2Jr6sVjXZ1N",
  "gatewayProfile": {
    "createdAt": "2024-02-18T12:00:00Z",
    "updatedAt": "2024-02-21T12:15:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "id": "gwp_2QC7PqoUeOxQEWscJJt6B3PkvyL",
    "active": true,
    "title": "Profile #1",
    "integration": "stripe",
    "environment": "test"
  },
  "paymentMethod": {
    "createdAt": "2024-02-18T12:00:00Z",
    "updatedAt": "2024-02-21T12:15:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "id": "pm_2QC7PqoUeOxQEWscJJt6B3PkvyL",
    "type": "card",
    "customer": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
    "card": {
      "brand": "amex",
      "lastFour": "1234",
      "bin": "123456",
      "expMonth": "12",
      "expYear": "2025",
      "cardholderName": "John Doe"
    },
    "applePay": {
      "displayName": "MasterCard 1234"
    }
  },
  "customer": {
    "createdAt": "2024-02-18T12:00:00Z",
    "updatedAt": "2024-02-21T12:15:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "id": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
    "email": "user@gmail.com",
    "name": "John Doe",
    "phoneNumber": "+1234567890",
    "dateOfBirth": "2020-01-01",
    "gender": "male",
    "restrictReason": "Customer restricted due to suspicious activity",
    "isRestricted": true
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.