Composable Frontend 2.0 Learn more 

  • Payments/
    Payment Gateways API/
    Configure Elastic Path Payments Powered by Stripe

    Configure Elastic Path Payments Powered by Stripe

    PUT Update Elastic Path Payments Powered by Stripe settings

    https://useast.api.elasticpath.com/v2/gateways/elastic_path_payments_stripe
    

    Use the /gateways/elastic_path_payments_stripe endpoint to configure Elastic Path Payments Powered by Stripe in Commerce.

    You can contact Elastic Path sales or customer success team to get more information about Elastic Path Payments Powered by Stripe and to check whether it will work for you.

    Parameters

    Headers

    NameRequiredTypeDescription
    AuthorizationRequiredstringThe Bearer token required to get access to the API.

    Body

    AttributeRequiredTypeDescription
    stripe_accountRequiredstringSpecifies the Stripe account ID.
    enabledOptionalbooleanSpecifies whether the gateway is enabled. Set true to enable the gateway and false to disable the gateway. Default is false.
    testOptionalbooleanSpecifies whether the test mode is enabled. Set true to enable test mode and false to disable the test mode. Default is false.

    Request Example

    curl -X PUT https://useast.api.elasticpath.com/v2/gateways/elastic_path_payments_stripe \
         -H "Authorization: Bearer XXX" \
         -H "Content-Type: application/json" \
         -d $ {
           "data": {
             "enabled": true,
             "stripe_account": "acct_xxx"
             "test": true,
           }
         }
    

    Response Example

    200 OK

    {
      "data": {
        "enabled": true,
        "test": true,
        "stripe_account": "acct_xxx",
        "name": "Elastic Path Payments powered by Stripe",
        "slug": "elastic_path_payments_stripe",
        "type": "gateway"
      }
    }
    
    Previous
    Configure Stripe Payment Intents