Stripe

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.

GitHub OpenAPI

Operations 31

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/test_helpers/customers/{customer}/fund_cash_balance Simulate a bank transfer into a customer's cash balance · Post test helpers customers customer fund cash balance #
Ask an LLM
“How do I fund a customer's cash balance in test mode without a real bank transfer?”
“Can I simulate an incoming bank transfer with my own reference string?”
Tell an agent
Fund test customer {customer} with a simulated bank transfer of {amount} {currency}.
Simulate an incoming bank transfer of {amount} {currency} to customer {customer} with reference {reference}.
POST /v1/test_helpers/issuing/authorizations Create a test card authorization · Post test helpers issuing authorizations #
Ask an LLM
“How do I simulate a card authorization on an issued card in test mode?”
“Can a test authorization come from a digital wallet instead of a physical card swipe?”
Tell an agent
Create a test authorization of {amount} {currency} on issued card {card}.
Simulate a {authorization_method} authorization for {amount} on test card {card}.
POST /v1/test_helpers/issuing/authorizations/{authorization}/capture Capture a test card authorization · Post test helpers issuing authorizations authorization capture #
Ask an LLM
“How do I capture a test-mode issuing authorization to turn it into a transaction?”
“Can I capture less than the authorized amount and close the authorization in test mode?”
Tell an agent
Capture test authorization {authorization}.
Capture {capture_amount} on test authorization {authorization} and close it afterwards.
POST /v1/test_helpers/issuing/authorizations/{authorization}/expire Expire a test card authorization · Post test helpers issuing authorizations authorization expire #
Ask an LLM
“How do I make a test issuing authorization expire so I can test that outcome?”
“What happens to a test authorization that is never captured?”
Tell an agent destructive · confirm first
Expire test authorization {authorization}.
Force issuing authorization {authorization} to expire in test mode.
POST /v1/test_helpers/issuing/authorizations/{authorization}/increment Increase a test card authorization amount · Post test helpers issuing authorizations authorization increment #
Ask an LLM
“How do I simulate a merchant raising the amount on a test card authorization?”
“Can I test an incremental authorization on an issued card, like a hotel adding charges?”
Tell an agent
Increase test authorization {authorization} by {increment_amount}.
Add {increment_amount} to the held amount on issuing authorization {authorization}.
POST /v1/test_helpers/issuing/authorizations/{authorization}/reverse Reverse a test card authorization · Post test helpers issuing authorizations authorization reverse #
Ask an LLM
“How do I simulate a merchant reversing a test card authorization?”
“Can I reverse only part of a test authorization?”
Tell an agent destructive · confirm first
Reverse test authorization {authorization} in full.
Reverse {reverse_amount} of issuing authorization {authorization}.
POST /v1/test_helpers/issuing/cards/{card}/shipping/deliver Mark a test physical card as delivered · Post test helpers issuing cards card shipping deliver #
Ask an LLM
“How do I simulate a physical issued card arriving at the cardholder in test mode?”
“Can I move a test card's shipping status to delivered?”
Tell an agent
Mark test card {card} as delivered.
Simulate delivery of the physical card {card}.
POST /v1/test_helpers/issuing/cards/{card}/shipping/fail Mark a test card shipment as failed · Post test helpers issuing cards card shipping fail #
Ask an LLM
“How do I test what happens when a physical card shipment fails?”
“Can I set a test card's shipping status to failure?”
Tell an agent
Mark the shipment of test card {card} as failed.
Simulate a failed shipment for physical card {card}.
POST /v1/test_helpers/issuing/cards/{card}/shipping/return Mark a test card shipment as returned · Post test helpers issuing cards card shipping return #
Ask an LLM
“How do I simulate a physical card being returned to sender in test mode?”
“Can I test the returned shipping status on an issued card?”
Tell an agent
Mark test card {card} as returned to sender.
Simulate the return of the physical card {card} in shipping.
POST /v1/test_helpers/issuing/cards/{card}/shipping/ship Mark a test physical card as shipped · Post test helpers issuing cards card shipping ship #
Ask an LLM
“How do I simulate a physical issued card being shipped in test mode?”
“Can I move a test card's shipping status to shipped before it is delivered?”
Tell an agent
Mark test card {card} as shipped.
Simulate the physical card {card} leaving for the cardholder.
POST /v1/test_helpers/issuing/transactions/create_force_capture Simulate a forced capture on an issued card · Post test helpers issuing transactions create force capture #
Ask an LLM
“How do I test a forced capture where a merchant charges a card without an authorization?”
“Can I simulate a force capture of an arbitrary amount on a test issued card?”
Tell an agent
Create a forced capture of {amount} {currency} on test card {card}.
Simulate a merchant capturing {amount} on card {card} with no prior authorization.
POST /v1/test_helpers/issuing/transactions/create_unlinked_refund Simulate an unlinked refund on an issued card · Post test helpers issuing transactions create unlinked refund #
Ask an LLM
“How do I test a refund to an issued card that isn't tied to an earlier transaction?”
“Can I simulate an unlinked refund of any amount in test mode?”
Tell an agent
Create an unlinked refund of {amount} {currency} to test card {card}.
Simulate a merchant refunding {amount} to card {card} without an original transaction.
POST /v1/test_helpers/issuing/transactions/{transaction}/refund Refund a test issuing transaction · Post test helpers issuing transactions transaction refund #
Ask an LLM
“How do I simulate a merchant refunding an existing test issuing transaction?”
“Can I refund only part of a test card transaction?”
Tell an agent
Refund test issuing transaction {transaction}.
Refund {refund_amount} of card transaction {transaction} in test mode.
POST /v1/test_helpers/refunds/{refund}/expire Expire a test refund awaiting action · Post test helpers refunds refund expire #
Ask an LLM
“How do I test what happens when a refund that needs customer action expires?”
“Can I expire a refund that isn't in the requires_action status?”
Tell an agent destructive · confirm first
Expire test refund {refund}.
Force refund {refund}, which is waiting on action, to expire.
POST /v1/test_helpers/terminal/readers/{reader}/present_payment_method Present a payment method on a simulated reader · Post test helpers terminal readers reader present payment method #
Ask an LLM
“How do I simulate a customer tapping a card on a test Terminal reader?”
“Can I add a tip when presenting a payment method on a simulated reader?”
Tell an agent
Present a test card on simulated reader {reader}.
Present a {type} payment method on reader {reader} with a tip of {amount_tip}.
GET /v1/test_helpers/test_clocks List test clocks · Get test helpers test clocks #
Ask an LLM
“Which test clocks have I set up for simulating billing over time?”
“How do I see all my test clocks?”
Tell an agent
List my test clocks.
Show the first {limit} test clocks.
POST /v1/test_helpers/test_clocks Create a test clock · Post test helpers test clocks #
Ask an LLM
“How do I simulate time passing for subscriptions without waiting weeks?”
“Can I start a test clock frozen at a specific date?”
Tell an agent
Create a test clock frozen at {frozen_time}.
Create a test clock named {name} starting at {frozen_time}.
DELETE /v1/test_helpers/test_clocks/{test_clock} Delete a test clock · Delete test helpers test clocks test clock #
Ask an LLM
“How do I delete a test clock I no longer need?”
“Can I clean up an old billing simulation clock?”
Tell an agent destructive · confirm first
Delete test clock {test_clock}.
Remove the test clock {test_clock} and end that simulation.
GET /v1/test_helpers/test_clocks/{test_clock} Get a test clock · Get test helpers test clocks test clock #
Ask an LLM
“How do I check what time a test clock is frozen at?”
“Is my test clock still advancing or is it ready?”
Tell an agent
Show test clock {test_clock}.
Check the status and current time of test clock {test_clock}.
POST /v1/test_helpers/test_clocks/{test_clock}/advance Advance a test clock to a future time · Post test helpers test clocks test clock advance #
Ask an LLM
“How do I fast-forward a test clock to trigger renewals and invoices?”
“How do I know when a test clock has finished advancing?”
Tell an agent
Advance test clock {test_clock} to {frozen_time}.
Move the simulation on clock {test_clock} forward to {frozen_time} so billing runs.
POST /v1/test_helpers/treasury/inbound_transfers/{id}/fail Fail a test inbound transfer · Post test helpers treasury inbound transfers id fail #
Ask an LLM
“How do I test a failed inbound transfer into a financial account?”
“Can I fail an inbound transfer that has already succeeded?”
Tell an agent
Fail test inbound transfer {id}.
Move processing inbound transfer {id} to failed with details {failure_details}.
POST /v1/test_helpers/treasury/inbound_transfers/{id}/return Return a test inbound transfer · Post test helpers treasury inbound transfers id return #
Ask an LLM
“How do I simulate an inbound transfer being returned after it succeeded?”
“What status must an inbound transfer be in before I can mark it returned?”
Tell an agent
Mark test inbound transfer {id} as returned.
Simulate a return on succeeded inbound transfer {id}.
POST /v1/test_helpers/treasury/inbound_transfers/{id}/succeed Succeed a test inbound transfer · Post test helpers treasury inbound transfers id succeed #
Ask an LLM
“How do I make a test inbound transfer succeed right away?”
“Can I complete an inbound transfer that is still processing in test mode?”
Tell an agent
Mark test inbound transfer {id} as succeeded.
Complete processing inbound transfer {id} successfully.
POST /v1/test_helpers/treasury/outbound_payments/{id}/fail Fail a test outbound payment · Post test helpers treasury outbound payments id fail #
Ask an LLM
“How do I test an outbound payment from a financial account failing?”
“Can I fail an outbound payment that is no longer processing?”
Tell an agent
Fail test outbound payment {id}.
Move processing outbound payment {id} to the failed status.
POST /v1/test_helpers/treasury/outbound_payments/{id}/post Post a test outbound payment · Post test helpers treasury outbound payments id post #
Ask an LLM
“How do I simulate an outbound payment posting to the recipient in test mode?”
“What does moving a test outbound payment to posted require?”
Tell an agent
Mark test outbound payment {id} as posted.
Settle processing outbound payment {id} to posted.
POST /v1/test_helpers/treasury/outbound_payments/{id}/return Return a test outbound payment · Post test helpers treasury outbound payments id return #
Ask an LLM
“How do I simulate an outbound payment bouncing back to the financial account?”
“Can I give a return reason when returning a test outbound payment?”
Tell an agent
Mark test outbound payment {id} as returned.
Return outbound payment {id} with details {returned_details}.
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail Fail a test outbound transfer · Post test helpers treasury outbound transfers outbound transfer fail #
Ask an LLM
“How do I test an outbound transfer to my own bank account failing?”
“Can I fail a test outbound transfer that is still processing?”
Tell an agent
Fail test outbound transfer {outbound_transfer}.
Move processing outbound transfer {outbound_transfer} to failed.
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post Post a test outbound transfer · Post test helpers treasury outbound transfers outbound transfer post #
Ask an LLM
“How do I simulate an outbound transfer landing in the destination bank account?”
“Can I move a test outbound transfer straight to posted?”
Tell an agent
Mark test outbound transfer {outbound_transfer} as posted.
Settle processing outbound transfer {outbound_transfer} to posted.
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return Return a test outbound transfer · Post test helpers treasury outbound transfers outbound transfer return #
Ask an LLM
“How do I simulate an outbound transfer being returned by the receiving bank?”
“Can I include return details on a test outbound transfer?”
Tell an agent
Mark test outbound transfer {outbound_transfer} as returned.
Return outbound transfer {outbound_transfer} with details {returned_details}.
POST /v1/test_helpers/treasury/received_credits Simulate money arriving in a financial account · Post test helpers treasury received credits #
Ask an LLM
“How do I simulate a third party sending money into my financial account in test mode?”
“Can I choose the network, like ACH or wire, for a test received credit?”
Tell an agent
Simulate a received credit of {amount} {currency} into financial account {financial_account}.
Send a test {network} credit of {amount} to financial account {financial_account}.
POST /v1/test_helpers/treasury/received_debits Simulate a third-party debit on a financial account · Post test helpers treasury received debits #
Ask an LLM
“How do I simulate a third party pulling money out of my financial account in test mode?”
“Can I pick the network for a test received debit?”
Tell an agent
Simulate a received debit of {amount} {currency} from financial account {financial_account}.
Pull a test {network} debit of {amount} from financial account {financial_account}.

Documentation

📖
Documentation
https://stripe.com/docs/implementation-guides/billing/testing

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-test-helpers-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/overlays/stripe-test-helpers-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/stripe-test-helpers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

stripe-test-helpers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stripe Test Helpers API
  description: Needs description.
  contact:
    email: dev-platform@stripe.com
    name: Stripe Dev Platform Team
    url: https://stripe.com
  termsOfService: https://stripe.com/us/terms/
  version: '2023-10-16'
  x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:


# --- truncated at 32 KB (174 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-test-helpers-api-openapi.yml