Create a stripe gateway

How to create a stripe gateway via API

To create a new stripe gateway, send a POST request to the /api/stripe_gateways endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/stripe_gateways

Arguments

Body ParameterTypeRequired

type

string

Required

attributes.name

string

Required

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

attributes.login

string

Required

attributes.publishable_key

string

Optional

attributes.connected_account

string

Optional

attributes.auto_payments

boolean

Optional, default is 'false'

Example

The following request creates a new stripe gateway:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/stripe_gateways' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "stripe_gateways",
    "attributes": {
      "name": "US payment gateway",
      "login": "sk_live_xxxx-yyyy-zzzz"
    }
  }
}'

Last updated