Retrieve a stripe gateway How to fetch a specific stripe gateway via API
To fetch a single stripe gateway, send a GET
request to the /api/stripe_gateways/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/stripe_gateways/:id
Example
Request Response
The following request fetches the stripe gateway identified by the id "xYZkjABcde":
Copy curl -g -X GET \
'https://yourdomain.commercelayer.io/api/stripe_gateways/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK
status code, returning a single resource object:
Copy {
"data" : {
"id" : "xYZkjABcde" ,
"type" : "stripe_gateways" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stripe_gateways/xYZkjABcde"
} ,
"attributes" : {
"auto_payments" : true ,
"created_at" : "2018-01-01T12:00:00.000Z" ,
"metadata" : {
"foo" : "bar"
} ,
"name" : "US payment gateway" ,
"reference" : "ANY-EXTERNAL-REFEFERNCE" ,
"reference_origin" : "ANY-EXTERNAL-REFEFERNCE-ORIGIN" ,
"updated_at" : "2018-01-01T12:00:00.000Z" ,
"webhook_endpoint_id" : "xxxx-yyyy-zzzz" ,
"webhook_endpoint_secret" : "xxxx-yyyy-zzzz" ,
"webhook_endpoint_url" : "https://core.commercelayer.co/webhook_callbacks/stripe_gateways/xxxxx"
} ,
"relationships" : {
"payment_methods" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stripe_gateways/xYZkjABcde/relationships/payment_methods" ,
"related" : "https://yourdomain.commercelayer.io/api/stripe_gateways/xYZkjABcde/payment_methods"
}
} ,
"stripe_payments" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stripe_gateways/xYZkjABcde/relationships/stripe_payments" ,
"related" : "https://yourdomain.commercelayer.io/api/stripe_gateways/xYZkjABcde/stripe_payments"
}
} ,
"versions" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stripe_gateways/xYZkjABcde/relationships/versions" ,
"related" : "https://yourdomain.commercelayer.io/api/stripe_gateways/xYZkjABcde/versions"
}
}
} ,
"meta" : {
"mode" : "test"
}
}
}