Create a stripe payment

How to create a stripe payment via API

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

Request

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

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.stripe_id	string	Required, created if null
attributes.client_secret	string	Required, created if null
attributes.options	object	Optional
attributes.return_url	string	Optional
attributes.receipt_email	string	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.order	object	Required

Example

Request

The following request creates a new stripe payment:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/stripe_payments' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "stripe_payments",
    "attributes": {
      "stripe_id": "pi_1234XXX",
      "client_secret": "pi_1234XXX_secret_5678YYY"
    },
    "relationships": {
      "order": {
        "data": {
          "type": "orders",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response