{
  "id": "txn_bSsDNBnFBsJti",
  "account_id": "acc_xHg4lkzbfw8tj",
  "merchant": {
    "name": "Starbucks",
    "category_code": "5812",
    "city": "Seattle",
    "state": "WA",
    "country": "USA",
    "acquirer_bin": "401858",
    "acquirer_card_acceptor_id": "QDFAPZYMMRTS"
  },
  "network": "visa",
  "network_data": {
    "visa_merchant_id": "967543210987",
    "visa_merchant_name": "Starbucks Store 042",
    "visa_store_id": "0042",
    "visa_store_name": "Starbucks Pike Place"
  },
  "amount": 1499,
  "currency": "USD",
  "billing_amount": 1499,
  "billing_currency": "USD",
  "status": "cleared",
  "created_at": "2024-05-07T15:30:25.467Z",
  "updated_at": "2024-05-07T15:30:25.467Z"
}

The Transactions endpoint retrieves real-time transaction (authorization, clearing, etc) notifications for Credit Card Accounts directly from the card networks.

Subscription to Transactions is required before receiving transactional data for an account

The Transactions endpoint is available as a:

TypeUse-Case
SubscriptionReal-time transaction (authorization, purchases, etc) notifications for Credit Card Accounts

​
Transaction Objects

id
string

Unique identifier for the Transaction.

account_id
string

The ID of the associated Account.

merchant
object

The merchant object associated with the Transaction.

network
string

The payment network through which the Transaction was processed

network_data
object | null

Additional data specific to the payment network

amount
number

The amount of the Transaction in the currency specified by the currency field

currency
string

The currency in which the Transaction was made

billing_amount
number

The amount billed to the cardholder, in the currency specified by thebilling_currency field

billing_currency
string

The currency in which the billing amount is denominated

status
string

The current status of the Transaction

created_at
string

Timestamp of when the Transaction was created.

updated_at
string

Timestamp of when the Transaction was last updated.

​
Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "transaction.create" | "transaction.update",
  "path": "/accounts/<acc_id>/transactions/<txn_id>",
}

{
  "id": "txn_bSsDNBnFBsJti",
  "account_id": "acc_xHg4lkzbfw8tj",
  "merchant": {
    "name": "Starbucks",
    "category_code": "5812",
    "city": "Seattle",
    "state": "WA",
    "country": "USA",
    "acquirer_bin": "401858",
    "acquirer_card_acceptor_id": "QDFAPZYMMRTS"
  },
  "network": "visa",
  "network_data": {
    "visa_merchant_id": "967543210987",
    "visa_merchant_name": "Starbucks Store 042",
    "visa_store_id": "0042",
    "visa_store_name": "Starbucks Pike Place"
  },
  "amount": 1499,
  "currency": "USD",
  "billing_amount": 1499,
  "billing_currency": "USD",
  "status": "cleared",
  "created_at": "2024-05-07T15:30:25.467Z",
  "updated_at": "2024-05-07T15:30:25.467Z"
}
Retrieve an UpdateList all Transactions