Custom payment methods

Custom payment methods allow you to extend your payment and billing integrations with payment methods processed outside of Stripe. For a list of payment methods offered by Stripe, see the payment method overview page.

While you process custom payment method transactions outside of Stripe, you can still record the transaction details to your Stripe account to unify reporting and build back office workflows.

Configure custom payment method types

In the Dashboard, create the custom payment method type your customers will pay with. Custom payment method types allow you to specify branding for the custom payment methods you define for each customer. For example, if youre using SamplePay as another processor, you might want to create a SamplePayCard to represent cards that you process with SamplePay.

Go to Custom payment method types in the Dashboard. At the end of these steps, youll have one or more custom payment method types defined that you can offer your customers when they checkout.

1. Create a custom payment method type.
2. Set the display name and logo for the custom payment method type. Alternatively, use one of over 50 preset methods for common payment methods processed outside of Stripe.

1. Click Create to make a new payment method type, SamplePayCard, which you can then use to set up a custom payment method.
2. You can see the created custom payment method type details in the Dashboard.
3. Custom payment method types arent retrievable through the API. We recommend storing the ID in your database and retrieving it during payment method creation.

Payment Methods

Create and retrieve custom payment methods with the Payment Methods API. When creating them, pass the ID of the custom payment method type you configured in the Stripe Dashboard as custom[type].

curl https://api.stripe.com/v1/payment_methods \
  -u "sk_test_wU7nrJCZspk1NPDxiQgAF05q:" \
  -d type=custom \
  -d "custom[type]={{CUSTOM_PAYMENT_METHOD_TYPE_ID}}"

{
  "id": "pm_123456789",
  "object": "payment_method",
  "billing_details": {
    "address": {...},
    "email": "jenny@example.com",
    "name": "Jenny Rosen",
    "phone": "+335555555555"
  },
  "custom": {
    "display_name": "SamplePayCard",
    "logo": {
      "content_type": "image/jpeg",
      "url": "https://files.stripe.com/files/..."
    },
    "type": "cpmt_..."
  },
  "type": "custom",
  (...)
}

Integrations

Payment Element

The Payment Element can display custom payment methods so you can provide your customers with unified checkout. See Custom payment methods in Payment Element to learn more.

Express Checkout Element

The Express Checkout Element can display custom payment method buttons alongside wallets, such as Apple Pay and Google Pay. To learn more, see Custom payment methods in Express Checkout Element.

Subscription Billing

Integrate Stripe Billing with your third-party payment service processors to create subscriptions that automatically charge payment methods not stored on Stripe, manage subscription states, and track payment success for external payments. See Integrate with third-party payment processors to learn more.

Connect

Your platform account can create custom payment methods in its connected accounts using its own custom payment method types, as well as the connected accounts custom payment method types.

curl https://api.stripe.com/v1/payment_methods \
  -u "sk_test_wU7nrJCZspk1NPDxiQgAF05q:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d type=custom \
  -d "custom[type]={{CUSTOM_PAYMENT_METHOD_TYPE_ID}}"

Compliance

Ongoing availability of custom payment methods and PSP integrations

Stripe might at any time decide to remove or block the availability of any payment method as a custom payment method (for example, if required to do so by a governmental authority). Stripe notifies you of any removal of a custom payment method that youre using, and you must immediately remove the custom payment method in your code. Failure to do so results in the custom payment method not rendering to your customers.

Restricted custom payment methods

The following payment methods or types of payment methods are prohibited from being used with custom payment methods and third-party payment processors:

• In Indonesia and Thailand:
  • The crypto payment methods provided by the operators
  • Any other crypto-related payment methods

Marks requirements

The use of name, logo, icon, design element or anything else that can identify a payment method (Marks) must adhere to the following guidance:

• Follow any Marks guidelines of that payment method provider (for example, terms for use of Stripe Marks).
• Dont alter or modify the payment method Marks, unless you have permission to do so.
• Dont use the payment method Marks in violation of your obligations to that payment method provider.
• Dont use Marks of one payment method provider for another payment method provider.
• Dont use methods, devices or designs to obfuscate or mislead as to the true underlying payment method.
• Dont use the payment method Marks in violation of any laws or regulations.

Disclaimer

By using custom payment methods (CPM) and third-party payment processors, you acknowledge that:

• The third-party payment services provider (PSP) provides operation and support of CPMs and your third-party payment processors integration.
• Your chosen PSP complies with applicable laws, including anti-money laundering (AML) and sanctions laws.
• Youre responsible for maintaining a direct integration with the PSP.
• You must maintain an agreement with the PSP and must comply with your agreements with each PSP.
• Youre responsible for obtaining all necessary rights to use the PSPs marks and logos within your checkout.
• Stripe isnt responsible for the processing of any transactions with any PSP including, for example, any charges, refunds, disputes, settlements, or funds flows.
• You or the PSP are responsible for the completion of the purchase flow after a customer has selected a CPM, including, for example, the order confirmation and reconciliation of orders.
• Youre responsible for properly configuring the CPM and third-party payment processor integration, which might include configuring a redirect URL.
• You must immediately remove any CPM and disable your PSP integration in the event your agreement with any PSP terminates or Stripe, at its sole discretion, gives you notices or documents its prohibition of use of that type of custom payment method.
• You cant integrate with restricted PSPs.
• Youre solely responsible for correctly presenting customers with their chosen CPM.
• You wont misrepresent that Stripe processes payments for the CPMs you present to your customers.
• As a third-party payment processor user, youve obtained the requisite permission to enable Stripe to collect, use, retain, and disclose the data provided through the integration (PSP Data).
• You authorize Stripe to access and use the PSP Data to provide and update the Stripe services, comply with legal and financial partner requirements, and prevent and mitigate fraud, financial loss, and other harm.
• To the extent permitted by law, upon Stripes written request, you agree to provide Stripe with information about transactions with PSPs using the services so that Stripe can comply with any investigations, administrative inquiries, legal requirements, audits, and demands or inquiries from consumers, businesses, or PSPs.