Links

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
Response
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"
}
}
}
}
}'
On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "xYZkjABcde",
"type": "stripe_payments",
"links": {
"self": "https://yourdomain.commercelayer.io/api/stripe_payments/xYZkjABcde"
},
"attributes": {
"stripe_id": "pi_1234XXX",
"client_secret": "pi_1234XXX_secret_5678YYY",
"publishable_key": "pk_live_xxxx-yyyy-zzzz",
"options": {
"customer": "cus_xxx",
"payment_method": "pm_xxx"
},
"payment_method": {
"id": "pm_xxx"
},
"mismatched_amounts": false,
"intent_amount_cents": 1000,
"intent_amount_float": 10.0,
"formatted_intent_amount": "€10,00",
"return_url": "https://yourdomain.com/thankyou",
"receipt_email": "[email protected]",
"payment_instrument": {
"issuer": "cl bank",
"card_type": "visa"
},
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stripe_payments/xYZkjABcde/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/stripe_payments/xYZkjABcde/order"
}
},
"payment_gateway": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stripe_payments/xYZkjABcde/relationships/payment_gateway",
"related": "https://yourdomain.commercelayer.io/api/stripe_payments/xYZkjABcde/payment_gateway"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stripe_payments/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/stripe_payments/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}