How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Stripe Test Helpers API

Stripe provides a number of resources for testing your integration. Make sure to test the following use cases before launch, and use our Postman collection to make the testing process simpler.

Stripe Test Helpers API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Synthetic, Testing, and Virtualization. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 31 operations across 29 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

Requests are made against a single base URL, https://api.stripe.com/.

31 operations 29 paths 36 schemas 1 DELETE2 GET28 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Test Helpers API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 31

Across 29 paths, the API surfaces 31 operations — 1 DELETE, 2 GET, 28 POST. Each is listed below with its method, path, parameters, and response codes.

Test Helpers 31
GET
/v1/test_helpers/test_clocks
Stripe List Test Clocks
GetTestHelpersTestClocks 3 params → 200default
POST
/v1/test_helpers/test_clocks
Stripe Create Test Clock
PostTestHelpersTestClocks body → 200default
GET
/v1/test_helpers/test_clocks/{test_clock}
Stripe Retrieve Test Clock
GetTestHelpersTestClocksTestClock 1 param → 200default
DELETE
/v1/test_helpers/test_clocks/{test_clock}
Stripe Delete Test Clock
DeleteTestHelpersTestClocksTestClock 1 param → 200default
POST
/v1/test_helpers/test_clocks/{test_clock}/advance
Stripe Advance Test Clock
PostTestHelpersTestClocksTestClockAdvance 1 param body → 200default
POST
/v1/test_helpers/refunds/{refund}/expire
Stripe Expire Refund
PostTestHelpersRefundsRefundExpire 1 param → 200default
POST
/v1/test_helpers/customers/{customer}/fund_cash_balance
Stripe Fund Customer Cash Balance
PostTestHelpersCustomersCustomerFundCashBalance 1 param body → 200default
POST
/v1/test_helpers/issuing/authorizations
Create a test-mode authorization.
PostTestHelpersIssuingAuthorizations body → 200default
POST
/v1/test_helpers/issuing/authorizations/{authorization}/capture
Capture a test-mode authorization.
PostTestHelpersIssuingAuthorizationsAuthorizationCapture 1 param body → 200default
POST
/v1/test_helpers/issuing/authorizations/{authorization}/expire
Expire a test-mode Authorization.
PostTestHelpersIssuingAuthorizationsAuthorizationExpire 1 param body → 200default
POST
/v1/test_helpers/issuing/authorizations/{authorization}/increment
Increment a test-mode Authorization.
PostTestHelpersIssuingAuthorizationsAuthorizationIncrement 1 param body → 200default
POST
/v1/test_helpers/issuing/authorizations/{authorization}/reverse
Reverse a test-mode Authorization.
PostTestHelpersIssuingAuthorizationsAuthorizationReverse 1 param body → 200default
POST
/v1/test_helpers/issuing/cards/{card}/shipping/deliver
Updates the shipping status of the specified Issuing Card object to delivered .
PostTestHelpersIssuingCardsCardShippingDeliver 1 param body → 200default
POST
/v1/test_helpers/issuing/cards/{card}/shipping/fail
Updates the shipping status of the specified Issuing Card object to failure .
PostTestHelpersIssuingCardsCardShippingFail 1 param body → 200default
POST
/v1/test_helpers/issuing/cards/{card}/shipping/return
Updates the shipping status of the specified Issuing Card object to returned .
PostTestHelpersIssuingCardsCardShippingReturn 1 param body → 200default
POST
/v1/test_helpers/issuing/cards/{card}/shipping/ship
Updates the shipping status of the specified Issuing Card object to shipped .
PostTestHelpersIssuingCardsCardShippingShip 1 param body → 200default
POST
/v1/test_helpers/issuing/transactions/create_force_capture
Allows the user to capture an arbitrary amount, also known as a forced capture.
PostTestHelpersIssuingTransactionsCreateForceCapture body → 200default
POST
/v1/test_helpers/issuing/transactions/create_unlinked_refund
Allows the user to refund an arbitrary amount, also known as a unlinked refund.
PostTestHelpersIssuingTransactionsCreateUnlinkedRefund body → 200default
POST
/v1/test_helpers/issuing/transactions/{transaction}/refund
Refund a test-mode Transaction.
PostTestHelpersIssuingTransactionsTransactionRefund 1 param body → 200default
POST
/v1/test_helpers/terminal/readers/{reader}/present_payment_method
Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
PostTestHelpersTerminalReadersReaderPresentPaymentMethod 1 param body → 200default
POST
/v1/test_helpers/treasury/inbound_transfers/{id}/fail
Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
PostTestHelpersTreasuryInboundTransfersIdFail 1 param body → 200default
POST
/v1/test_helpers/treasury/inbound_transfers/{id}/return
Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
PostTestHelpersTreasuryInboundTransfersIdReturn 1 param body → 200default
POST
/v1/test_helpers/treasury/inbound_transfers/{id}/succeed
Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
PostTestHelpersTreasuryInboundTransfersIdSucceed 1 param body → 200default
POST
/v1/test_helpers/treasury/outbound_payments/{id}/fail
Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
PostTestHelpersTreasuryOutboundPaymentsIdFail 1 param body → 200default
POST
/v1/test_helpers/treasury/outbound_payments/{id}/post
Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
PostTestHelpersTreasuryOutboundPaymentsIdPost 1 param body → 200default
POST
/v1/test_helpers/treasury/outbound_payments/{id}/return
Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
PostTestHelpersTreasuryOutboundPaymentsIdReturn 1 param body → 200default
POST
/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail
Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail 1 param body → 200default
POST
/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post
Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost 1 param body → 200default
POST
/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return
Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn 1 param body → 200default
POST
/v1/test_helpers/treasury/received_credits
Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.
PostTestHelpersTreasuryReceivedCredits body → 200default
POST
/v1/test_helpers/treasury/received_debits
Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.
PostTestHelpersTreasuryReceivedDebits body → 200default

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are issuing.authorization (25 properties), issuing.card (23 properties), issuing.transaction (22 properties), treasury.outbound_payment (21 properties). Each schema is shown below with its type and property counts.

PostTestHelpersIssuingTransactionsCreateUnlinkedRefundRequest
object
6 properties 2 required
PostTestHelpersIssuingAuthorizationsAuthorizationCaptureRequest
object
4 properties
issuing.transaction
object
Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or ref…
22 properties 12 required
PostTestHelpersIssuingCardsCardShippingReturnRequest
object
1 property
PostTestHelpersIssuingAuthorizationsAuthorizationExpireRequest
object
1 property
issuing.authorization
object
When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing Authorization object is created. [Authorizations](https://stripe.…
25 properties 18 required
treasury.received_credit
object
ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/apifinancialaccounts) (for example, via ACH or wire). These money movement…
16 properties 11 required
PostTestHelpersTreasuryReceivedDebitsRequest
object
7 properties 4 required
treasury.received_debit
object
ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/apifinancialaccounts). These are not initiated from the FinancialAccoun…
16 properties 10 required
PostTestHelpersTreasuryOutboundTransfersOutboundTransferFailRequest
object
1 property
PostTestHelpersTreasuryInboundTransfersIdSucceedRequest
object
1 property
terminal.reader
object
A Reader represents a physical device for accepting payment details. Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-…
12 properties 7 required
error_2
object
An error response from the Stripe API
1 property 1 required
treasury.outbound_transfer
object
Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/apifinancialaccounts) to a PaymentMethod belonging to the same entity…
19 properties 15 required
PostTestHelpersTreasuryOutboundTransfersOutboundTransferPostRequest
object
1 property
PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturnRequest
object
2 properties
PostTestHelpersIssuingCardsCardShippingFailRequest
object
1 property
PostTestHelpersIssuingAuthorizationsAuthorizationReverseRequest
object
2 properties
PostTestHelpersTreasuryOutboundPaymentsIdReturnRequest
object
2 properties
PostTestHelpersTreasuryInboundTransfersIdReturnRequest
object
1 property
PostTestHelpersIssuingCardsCardShippingShipRequest
object
1 property
PostTestHelpersIssuingAuthorizationsAuthorizationIncrementRequest
object
3 properties 1 required
PostTestHelpersTerminalReadersReaderPresentPaymentMethodRequest
object
5 properties
test_helpers.test_clock
object
8 properties 7 required
PostTestHelpersIssuingTransactionsTransactionRefundRequest
object
2 properties
treasury.outbound_payment
object
Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/apifinancialaccounts). To send money…
21 properties 14 required
error
object
1 property
PostTestHelpersTreasuryOutboundPaymentsIdFailRequest
object
1 property
issuing.card
object
You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders.
23 properties 14 required
PostTestHelpersIssuingTransactionsCreateForceCaptureRequest
object
6 properties 2 required
PostTestHelpersIssuingAuthorizationsRequest
object
11 properties 2 required
PostTestHelpersTreasuryInboundTransfersIdFailRequest
object
2 properties
treasury.inbound_transfer
object
Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https:/…
20 properties 14 required
PostTestHelpersTreasuryReceivedCreditsRequest
object
7 properties 4 required
PostTestHelpersTreasuryOutboundPaymentsIdPostRequest
object
1 property
PostTestHelpersIssuingCardsCardShippingDeliverRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-test-helpers-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Balance API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Where this information came from

This is an independent, third-party profile of Stripe Test Helpers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.