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

Create a CreditReversal 

Reverses a ReceivedCredit and creates a CreditReversal object.

Parameters

  • received_creditstringRequired

    The ReceivedCredit to reverse.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns a CreditReversal object.

POST /v1/treasury/credit_reversals
curl https://api.stripe.com/v1/treasury/credit_reversals \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d received_credit=rc_1MtkGJLkdIwHu7ixWPuY9DGn
Response
{
  "id": "credrev_1Mtklw2eZvKYlo2CJG2MWJM7",
  "object": "treasury.credit_reversal",
  "amount": 1000,
  "created": 1680756608,
  "currency": "usd",
  "financial_account": "fa_1Mtklw2eZvKYlo2CNHscZzs2",
  "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKICfuaEGMgYv0T_PcXU6NpP_n6wAfI9LKta3LkDRNQT8oLGdQf7JcXsskGjrq1LICpYVy5a3oOBI5gaVvTy8MtwpT1PTpQ",
  "livemode": false,
  "metadata": {},
  "network": "ach",
  "received_credit": "rc_1Mtklw2eZvKYlo2CxuluQFPR",
  "status": "processing",
  "status_transitions": {
    "posted_at": null
  },
  "transaction": "trxn_1Mtklw2eZvKYlo2CKkbNA2TS"
}

Retrieve a CreditReversal 

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

Parameters

No parameters.

Returns

Returns a CreditReversal object.

GET /v1/treasury/credit_reversals/:id
curl https://api.stripe.com/v1/treasury/credit_reversals/credrev_1Mtklw2eZvKYlo2CJG2MWJM7 \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "credrev_1Mtklw2eZvKYlo2CJG2MWJM7",
  "object": "treasury.credit_reversal",
  "amount": 1000,
  "created": 1680756608,
  "currency": "usd",
  "financial_account": "fa_1Mtklw2eZvKYlo2CNHscZzs2",
  "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKICfuaEGMgYv0T_PcXU6NpP_n6wAfI9LKta3LkDRNQT8oLGdQf7JcXsskGjrq1LICpYVy5a3oOBI5gaVvTy8MtwpT1PTpQ",
  "livemode": false,
  "metadata": {},
  "network": "ach",
  "received_credit": "rc_1Mtklw2eZvKYlo2CxuluQFPR",
  "status": "processing",
  "status_transitions": {
    "posted_at": null
  },
  "transaction": "trxn_1Mtklw2eZvKYlo2CKkbNA2TS"
}

List all CreditReversals 

Returns a list of CreditReversals.

Parameters

  • financial_accountstring

    Returns objects associated with this FinancialAccount.

  • received_creditstring

    Only return CreditReversals for the ReceivedCredit ID.

  • statusenum

    Only return CreditReversals for a given status.

    Possible enum values
    canceled

    The CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).

    posted

    The CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)

    processing

    The CreditReversal starting state. Funds are “held” by a pending Transaction (but they are still part of the current balance).

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit CreditReversals, starting after CreditReversal starting_after. Each entry in the array is a separate CreditReversal object. If no more CreditReversal are available, the resulting array will be empty.

GET /v1/treasury/credit_reversals
curl -G https://api.stripe.com/v1/treasury/credit_reversals \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d financial_account=fa_1MtkGJLkdIwHu7ix6FAcfxof \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/treasury/credit_reversals",
  "has_more": false,
  "data": [
    {
      "id": "credrev_1Mtklw2eZvKYlo2CJG2MWJM7",
      "object": "treasury.credit_reversal",
      "amount": 1000,
      "created": 1680756608,
      "currency": "usd",
      "financial_account": "fa_1Mtklw2eZvKYlo2CNHscZzs2",
      "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKICfuaEGMgYv0T_PcXU6NpP_n6wAfI9LKta3LkDRNQT8oLGdQf7JcXsskGjrq1LICpYVy5a3oOBI5gaVvTy8MtwpT1PTpQ",
      "livemode": false,
      "metadata": {},
      "network": "ach",
      "received_credit": "rc_1Mtklw2eZvKYlo2CxuluQFPR",
      "status": "processing",
      "status_transitions": {
        "posted_at": null
      },
      "transaction": "trxn_1Mtklw2eZvKYlo2CKkbNA2TS"
    }
  ]
}

Debit Reversals 

You can reverse some ReceivedDebits depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.

Endpoints

Payment Records 

A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe. For example, you can create a Payment Record to model a payment made on a different payment processor, in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or more Payment Attempt Records, which represent individual attempts made on a payment network.

Endpoints