Core Resources
Payment Methods
Money Management
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Adjustments v2

Learn more about calling API v2 endpoints.

Adjustments represent Stripe-initiated credits or debits to a user balance. They might be used to amend balances due to technical or operational error.

Endpoints

The Adjustment object 

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring, value is "v2.money_management.adjustment"

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

  • adjusted_flownullable object

    If applicable, contains information about the original flow linked to this Adjustment.

  • amountobject

    The amount of the Adjustment.

  • createdtimestamp

    Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

  • descriptionnullable string

    Description of the Adjustment and what it was used for.

  • financial_accountstring

    The FinancialAccount that this adjustment is for.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • receipt_urlnullable string

    A link to the Stripe-hosted receipt that is provided when money movement is considered regulated under Stripe’s money transmission licenses. The receipt link remains active for 60 days from the Adjustment creation date. After this period, the link will expire and the receipt url value will be null.

The Adjustment object
{
  "id": "adj_65Pj770ytFhPwgkQg0116Pj6mS0dSQaN2JL1S0NhRweDjE",
  "object": "v2.money_management.adjustment",
  "amount": {
    "value": 100,
    "currency": "usd"
  },
  "created": "2024-01-18T00:08:23.488Z",
  "description": "Stripe credit",
  "financial_account": "fa_65Pj6mdWMT1K5pw0kSK16Pj6mS0dSQaN2JL1S0NhRweTZY",
  "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMaIwohd2tzcF90ZXN0XzZQT1FKUzdSU1FzMnFGVDFJektXSXlHKJOXtLYGMgZkVRf7VbI6SJRp7IPsVDBFSlQo5pcqfVA-rhUM1vwykiziz5767yzBhMdFWTHS31y9b_jVoQGdDDSkdFA0I4n9rtJL0tv1zeOu5hRHAW76vP",
  "adjusted_flow": {
    "outbound_payment": "obp_65OAfT9tVl3u223h0he16NybHIZ4SQ3LORe4rpuNGDIKCO",
    "type": "outbound_payment"
  }
}

Retrieve an Adjustment object v2

Learn more about calling API v2 endpoints.

Retrieves the details of an Adjustment by ID.

Parameters

  • idstringRequired

    The ID of the Adjustment to retrieve.

Returns

Response attributes

  • idstring

    Unique identifier for the object.

  • objectstring, value is "v2.money_management.adjustment"

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

  • adjusted_flownullable object

    If applicable, contains information about the original flow linked to this Adjustment.

  • amountobject

    The amount of the Adjustment.

  • createdtimestamp

    Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

  • descriptionnullable string

    Description of the Adjustment and what it was used for.

  • financial_accountstring

    The FinancialAccount that this adjustment is for.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • receipt_urlnullable string

    A link to the Stripe-hosted receipt that is provided when money movement is considered regulated under Stripe’s money transmission licenses. The receipt link remains active for 60 days from the Adjustment creation date. After this period, the link will expire and the receipt url value will be null.

Error Codes
404not_found

The resource wasn’t found.

GET /v2/money_management/adjustments/:id
curl https://api.stripe.com/v2/money_management/adjustments/adj_65Pj770ytFhPwgkQg0116Pj6mS0dSQaN2JL1S0NhRweDjE \
  -H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
  -H "Stripe-Version: 2025-04-30.preview"
Response
{
  "id": "adj_65Pj770ytFhPwgkQg0116Pj6mS0dSQaN2JL1S0NhRweDjE",
  "object": "v2.money_management.adjustment",
  "amount": {
    "value": 100,
    "currency": "usd"
  },
  "created": "2024-01-18T00:08:23.488Z",
  "description": "Stripe credit",
  "financial_account": "fa_65Pj6mdWMT1K5pw0kSK16Pj6mS0dSQaN2JL1S0NhRweTZY",
  "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMaIwohd2tzcF90ZXN0XzZQT1FKUzdSU1FzMnFGVDFJektXSXlHKJOXtLYGMgZkVRf7VbI6SJRp7IPsVDBFSlQo5pcqfVA-rhUM1vwykiziz5767yzBhMdFWTHS31y9b_jVoQGdDDSkdFA0I4n9rtJL0tv1zeOu5hRHAW76vP",
  "adjusted_flow": {
    "outbound_payment": "obp_65OAfT9tVl3u223h0he16NybHIZ4SQ3LORe4rpuNGDIKCO",
    "type": "outbound_payment"
  }
}

List all Adjustment objects v2

Learn more about calling API v2 endpoints.

Returns a list of Adjustments that match the provided filters.

Parameters

  • adjusted_flowstring

    Filter for Adjustments linked to a Flow.

  • createdtimestamp

    Filter for objects created at the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • created_gttimestamp

    Filter for objects created after the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • created_gtetimestamp

    Filter for objects created on or after the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • created_lttimestamp

    Filter for objects created before the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • created_ltetimestamp

    Filter for objects created on or before the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • limitinteger

    The page limit.

  • pagestring

    The page token.

Returns

Response attributes

  • dataarray of objects

    List of Adjustment objects.

  • next_page_urlnullable string

    The next page URL.

  • previous_page_urlnullable string

    The previous page URL.

Error Codes
404not_found

The resource wasn’t found.

GET /v2/money_management/adjustments
curl https://api.stripe.com/v2/money_management/adjustments \
  -H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
  -H "Stripe-Version: 2025-04-30.preview"
Response
{
  "data": [
    {
      "id": "adj_65Pj770ytFhPwgkQg0116Pj6mS0dSQaN2JL1S0NhRweDjE",
      "object": "v2.money_management.adjustment",
      "amount": {
        "value": 100,
        "currency": "usd"
      },
      "created": "2024-01-18T00:08:23.488Z",
      "description": "Stripe credit",
      "financial_account": "fa_65Pj6mdWMT1K5pw0kSK16Pj6mS0dSQaN2JL1S0NhRweTZY",
      "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMaIwohd2tzcF90ZXN0XzZQT1FKUzdSU1FzMnFGVDFJektXSXlHKJOXtLYGMgZkVRf7VbI6SJRp7IPsVDBFSlQo5pcqfVA-rhUM1vwykiziz5767yzBhMdFWTHS31y9b_jVoQGdDDSkdFA0I4n9rtJL0tv1zeOu5hRHAW76vP",
      "adjusted_flow": {
        "outbound_payment": "obp_65OAfT9tVl3u223h0he16NybHIZ4SQ3LORe4rpuNGDIKCO",
        "type": "outbound_payment"
      }
    },
    {
      "id": "adj_65PlYXryTmMdhykXmsV16PlJT00CSQOY87ottjLI5jUDbk",
      "object": "adjustment",
      "amount": {
        "value": -225,
        "currency": "usd"
      },
      "created": "2024-01-14T17:50:12.707Z",
      "description": "Stripe debit",
      "financial_account": "fa_65Pj6mdWMT1K5pw0kSK16Pj6mS0dSQaN2JL1S0NhRweTZY",
      "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMaIwohd2tzcF90ZXN0XzZQT1FKUzdSU1FzMnFGVDFJektXSXlHKJOXtLYGMgY1rQ-bJNM6SJRUrOplKjRLGucVqBUamJmezkcPTNYB-quiy7FlWZeHb02zbzhb00Ticm7zPLN7klTNzZ1ZPc5ImTanyhIYt5Xn_xXihPpFJP"
    }
  ]
}

Adjustment event types v2

Learn more about calling API v2 endpoints.

This is a list of all public thin events we currently send for updates to Adjustment, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Filter events by type

Attributes

  • idstring

    Unique identifier for the event.

  • objectstring, value is "v2.core.event"

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

  • contextnullable string

    Authentication context needed to fetch the event or related object.

  • createdtimestamp

    Time at which the object was created.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • reasonnullable object

    Reason for the event.

  • related_objectnullable object

    Object containing the reference to API resource relevant to the event.

  • typestring, value is "v2.money_management.adjustment.created"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
  "context": null,
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
  "object": "v2.core.event",
  "reason": {
    "type": "request",
    "request": {
      "id": "req_v24sUK2aV6o01RdVU",
      "idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
    }
  },
  "related_object": {
    "id": "adj_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
    "type": "v2.money_management.adjustment",
    "url": "/v2/money_management/adjustments/adj_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
  },
  "type": "v2.money_management.adjustment.created",
  "livemode": true
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
  "context": null,
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
  "object": "v2.core.event",
  "reason": {
    "type": "request",
    "request": {
      "id": "req_v24sUK2aV6o01RdVU",
      "idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
    }
  },
  "related_object": {
    "id": "adj_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
    "type": "v2.money_management.adjustment",
    "url": "/v2/money_management/adjustments/adj_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
  },
  "type": "v2.money_management.adjustment.created",
  "livemode": true,
  "changes": {},
  "data": {}
}