> ## Documentation Index
> Fetch the complete documentation index at: https://docs.methodfi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The transactions endpoint

export const get_common_parameters = (resource_name = 'resource') => {
  return {
    id: {
      name: 'id',
      type: "string",
      required: false,
      description: `Unique identifier for the ${resource_name}.`
    },
    entity_id: {
      name: 'entity_id',
      type: 'string',
      required: false,
      description: 'The ID of the associated Entity.'
    },
    account_id: {
      name: 'account_id',
      type: 'string',
      required: false,
      description: 'The ID of the associated Account.'
    },
    error: {
      name: 'error',
      type: 'object | null',
      required: false,
      description: <>
          An object representing an error that occurred while processing
          this {resource_name}. See <a href={`/reference/errors/${resource_name.replace(/^([A-Z])/, function (match) {
        return match.toLowerCase();
      }).replace(/([A-Z])/g, function (match) {
        return "-" + match.toLowerCase();
      })}-errors`}>{resource_name} errors</a>.
        </>
    },
    status_error: {
      name: 'status_error',
      type: 'object | null',
      required: false,
      description: <>
          An object representing an error that occurred while processing
          this {resource_name}. See <a href="/reference/errors/product-errors#status-errors">{resource_name} errors</a>.
        </>
    },
    metadata: {
      name: 'metadata',
      type: 'object | null',
      required: false,
      description: <>
          Additional data provided during creation.
          See <a href="/reference/metadata">metadata</a>
        </>
    },
    created_at: {
      name: 'created_at',
      type: 'string',
      required: false,
      description: `Timestamp of when the ${resource_name} was created.`
    },
    updated_at: {
      name: 'updated_at',
      type: 'string',
      required: false,
      description: `Timestamp of when the ${resource_name} was last updated.`
    },
    status: (enums = []) => ({
      name: 'status',
      type: 'enum',
      required: false,
      description: `Status of the ${resource_name}.`,
      enums
    }),
    type: (enums = []) => ({
      name: 'type',
      type: 'enum',
      required: false,
      description: `The type of ${resource_name}.`,
      enums
    })
  };
};

export const ParamList = ({items = [], is_child = false}) => {
  return items.map(item => {
    const field_props = {
      id: Math.random().toString(),
      body: item.name,
      name: item.name,
      type: item.type,
      required: item.required
    };
    const enums = item.enums || [];
    const items = item.items || [];
    const has_items = items?.length > 0;
    const has_enums = enums?.length > 0;
    const should_default_open = item.defaultOpen || false;
    const render_child_item = () => {
      const child_props = {
        title: has_enums ? "Possible enum values" : "properties"
      };
      if (should_default_open) child_props.defaultOpen = true;
      const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
        const is_last = idx === enums.length - 1;
        const is_2nd_to_last = idx === enums.length - 2;
        return <>
            <code>{enum_item}</code>
            {is_last && ''}
            {is_2nd_to_last && ' or '}
            {!is_last && !is_2nd_to_last && ', '}
          </>;
      });
      const enum_list = has_enums && !has_inline_enums && <Accordion {...child_props}>
          {enums.map((enum_item, index) => <div key={`enum-${index}`}>
              <code>{enum_item.name}</code>
              <br />
              <p>{enum_item.description}</p>
            </div>)}
        </Accordion>;
      const item_list = has_items && <Expandable {...child_props}>
          <ParamList items={items || []} is_child />
        </Expandable>;
      return <>
          <p>
            {item.description}
            {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
          </p>

          {enum_list}
          {item_list}
        </>;
    };
    return is_child ? <ResponseField {...field_props}>{render_child_item()}</ResponseField> : <ParamField {...field_props}>{render_child_item()}</ParamField>;
  });
};

The Transactions endpoint retrieves near real-time transaction notifications for Credit Card and Debit Card Accounts directly from the card networks.

<Info>Subscription to Transactions is required before receiving transactional data for an account. Contact your Method CSM for access.</Info>

**The Transactions endpoint is available as a:**

| Type           | Use-Case                                                                  |
| -------------- | ------------------------------------------------------------------------- |
| `Subscription` | Near real-time transaction notifications for Credit / Debit Card Accounts |

## Transaction Objects

<ParamList
  items={[
get_common_parameters('Transaction').id,
get_common_parameters('Transaction').account_id,
{
name: 'descriptor',
type: 'string',
description: 'The statement descriptor for the transaction. This field may change across webhook events and is fully accurate only when the transaction reaches a final state (Posted or Voided).',
},
{
name: 'merchant_category_code',
type: 'string',
description: 'The 4 digit MCC associated with this transaction.',
},
{
name: 'merchant',
type: 'object | null',
description: 'Enriched merchant information. This is not enabled by default, contact your Method CSM for access.',
items: [
  {
      name: 'name',
      type: 'string',
      description: 'Enriched merchant name.',
  },
  {
      name: 'logo',
      type: 'string | null',
      description: 'Merchant logo image URL.',
  }
]
},
{
name: 'amount',
type: 'number',
description: 'The amount that was charged in USD cents.',
},
{
name: 'auth_amount',
type: 'number',
description: 'The authorization amount that was charged in USD cents.',
},
{
name: 'currency_code',
type: 'string',
description: 'The ISO 4217 currency code for the amount and auth_amount.',
},
{
name: 'transaction_amount',
type: 'number',
description: 'The amount that was charged in the local currency of the transaction in cents.',
},
{
name: 'transaction_auth_amount',
type: 'number',
description: 'The authorization amount that was charged in the local currency of the transaction in cents.',
},
{
name: 'transaction_currency_code',
type: 'string',
description: 'The ISO 4217 currency code for the transaction_amount and transaction_auth_amount.',
},
{
name: 'status',
type: 'enum',
description: 'The current status of the Transaction. Returns have the status posted with a negative value for amount and transaction_amount.',
enums: ['pending', 'posted', 'voided'],
},
{
name: 'transacted_at',
type: 'string',
description: 'Timestamp when the transaction took place.',
},
{
name: 'posted_at',
type: 'string | null',
description: 'Timestamp when the transaction was posted, null if it never posted',
},
{
name: 'voided_at',
type: 'string | null',
description: 'Timestamp when the transaction was voided, null if it never voided.',
},
{
name: 'original_txn_id',
type: 'string | null',
description: 'If this transaction is a return (posted with a negative value for amount), this field contains the ID of the original transaction. Otherwise, it is null.',
},
get_common_parameters('Transaction').created_at,
get_common_parameters('Transaction').updated_at,
]}
/>

## Webhook Payload

The [Webhook](/2026-03-30/reference/webhooks/overview) payload will contain the following information:

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

<RequestExample>
  ```json THE TRANSACTION OBJECT theme={null}
  {
    "id": "txn_t73AdHRFYwhT9",
    "account_id": "acc_XtKTpHLGhD9Qn",
    "status": "posted",
    "descriptor": "SQ *BENNU COFFEE",
    "merchant": {
      "name": "Bennu Coffee",
      "logo": null
    },
    "merchant_category_code": "5441",
    "amount": 3764,
    "auth_amount": 3764,
    "currency_code": "USD",
    "transaction_amount": 3764,
    "transaction_auth_amount": 3764,
    "transaction_currency_code": "USD",
    "transacted_at": "2025-03-05T07:48:06.000Z",
    "posted_at": "2025-03-06T05:00:00.000Z",
    "voided_at": null,
    "original_txn_id": null,
    "created_at": "2025-03-24T03:54:29.283Z",
    "updated_at": "2025-03-24T04:04:39.200Z"
  }
  ```
</RequestExample>