Skip to content

Reference

Stripe (API Key)

Connect Stripe to Alter Vault using an API key for secure API access

Use Stripe credentials to make authenticated API calls through Alter Vault without exposing API keys in code.

PropertyValue
Provider IDstripe
CategoryPayments
Credential TypeBearer Token

Log in to the Stripe Dashboard

Log in to the Stripe Dashboard at dashboard.stripe.com.

Open the API keys page

From the Developers menu open Workbench and click Manage on the API keys widget, or go directly to dashboard.stripe.com/apikeys.

Create a restricted key

Under Restricted keys, click Create restricted key, name it, and grant the resources the integration needs plus Read on Balance. Stripe recommends restricted keys over secret keys, especially for a key handed to an agent. Alternatively, under Standard keys reveal and copy the existing secret key, or click Create secret key where the page offers it.

Copy the key

Copy the key. A key you create in live mode is shown once; sandbox keys and Stripe’s default secret key can be revealed again. Restricted keys start with rk_, secret keys with sk_.

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Stripe

Go to Managed Secrets > Add Provider > Stripe.

Enter credentials

Paste the API key into the credential field.

Save

Click Save. You’ll receive a grant_id to use with the SDK.

response = await alter_app.request(
HttpMethod.GET,
"https://api.stripe.com/v1/charges",
grant_id="YOUR_GRANT_ID",
)
  • Sandbox keys start with rk_test_ or sk_test_; live keys with rk_live_ or sk_live_.
  • The save-time check reads the account balance. A restricted key without Read on Balance is still saved, but the portal reports that Stripe could not confirm the credential (Stripe answers HTTP 403, which the check treats as inconclusive); grant the permission or verify the key with a test request.

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation IDFamiliesMethodProvider path
PostInvoicesInvoiceSendpayment, sendPOST/v1/invoices/{invoice}/send
DeleteCouponsCoupondelete, paymentDELETE/v1/coupons/{coupon}
DeleteInvoiceitemsInvoiceitemdelete, paymentDELETE/v1/invoiceitems/{invoiceitem}
DeleteInvoicesInvoicedelete, paymentDELETE/v1/invoices/{invoice}
PostApplicationFeesFeeRefundsIdpaymentPOST/v1/application_fees/{fee}/refunds/{id}
PostApplicationFeesIdRefundpaymentPOST/v1/application_fees/{id}/refund
PostApplicationFeesIdRefundspaymentPOST/v1/application_fees/{id}/refunds
PostChargesChargepaymentPOST/v1/charges/{charge}
PostChargesChargeCapturepaymentPOST/v1/charges/{charge}/capture
PostChargesChargeDisputepaymentPOST/v1/charges/{charge}/dispute
PostChargesChargeDisputeClosedelete, paymentPOST/v1/charges/{charge}/dispute/close
DeleteAccountsAccountdeleteDELETE/v1/accounts/{account}
DeleteAccountsAccountBankAccountsIddeleteDELETE/v1/accounts/{account}/bank_accounts/{id}
DeleteAccountsAccountExternalAccountsIddeleteDELETE/v1/accounts/{account}/external_accounts/{id}
DeleteAccountsAccountPeoplePersondeleteDELETE/v1/accounts/{account}/people/{person}
DeleteAccountsAccountPersonsPersondeleteDELETE/v1/accounts/{account}/persons/{person}
DeleteApplePayDomainsDomaindeleteDELETE/v1/apple_pay/domains/{domain}
DeleteCustomersCustomerdeleteDELETE/v1/customers/{customer}
DeleteCustomersCustomerBankAccountsIddeleteDELETE/v1/customers/{customer}/bank_accounts/{id}
DeleteCustomersCustomerCardsIddeleteDELETE/v1/customers/{customer}/cards/{id}
DeleteCustomersCustomerDiscountdeleteDELETE/v1/customers/{customer}/discount
PostAccountsadmin, writePOST/v1/accounts
PostCustomersCustomerCashBalanceadmin, writePOST/v1/customers/{customer}/cash_balance
PostEphemeralKeysadmin, writePOST/v1/ephemeral_keys
PostTerminalConnectionTokensadmin, writePOST/v1/terminal/connection_tokens
PostTestHelpersConfirmationTokensadmin, writePOST/v1/test_helpers/confirmation_tokens
PostAccountsAccountBankAccountswritePOST/v1/accounts/{account}/bank_accounts
PostAccountsAccountExternalAccountswritePOST/v1/accounts/{account}/external_accounts
PostAccountsAccountLoginLinkswritePOST/v1/accounts/{account}/login_links
PostAccountsAccountPeoplewritePOST/v1/accounts/{account}/people
PostAccountsAccountPersonswritePOST/v1/accounts/{account}/persons
PostCustomersCustomerwritePOST/v1/customers/{customer}
PostCustomersCustomerBalanceTransactionswritePOST/v1/customers/{customer}/balance_transactions
PostCustomersCustomerBalanceTransactionsTransactionwritePOST/v1/customers/{customer}/balance_transactions/{transaction}
GetApplicationFeesFeeRefundsIdreadGET/v1/application_fees/{fee}/refunds/{id}
GetApplicationFeesIdRefundsreadGET/v1/application_fees/{id}/refunds
GetChargesChargereadGET/v1/charges/{charge}
GetChargesChargeDisputereadGET/v1/charges/{charge}/dispute
GetChargesChargeRefundsreadGET/v1/charges/{charge}/refunds
GetChargesChargeRefundsRefundreadGET/v1/charges/{charge}/refunds/{refund}

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.