Checkout.com gateways Create a checkout.com gateway How to create a checkout.com gateway via API
To create a new checkout.com gateway, send a POST
request to the /api/checkout_com_gateways
endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/checkout_com_gateways
Arguments
Body Parameter
Type
Required
attributes.reference_origin
relationships.checkout_com_payments
Example
Request Response
The following request creates a new checkout.com gateway:
Copy curl -g -X POST \
'https://yourdomain.commercelayer.io/api/checkout_com_gateways' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "checkout_com_gateways",
"attributes": {
"name": "US payment gateway",
"secret_key": "sk_test_xxxx-yyyy-zzzz",
"public_key": "pk_test_xxxx-yyyy-zzzz"
}
}
}'
On success, the API responds with a 201 Created
status code, returning the created resource object:
Copy {
"data": {
"id": "xYZkjABcde",
"type": "checkout_com_gateways",
"links": {
"self": "https://yourdomain.commercelayer.io/api/checkout_com_gateways/xYZkjABcde"
},
"attributes": {
"name": "US payment gateway",
"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"
},
"webhook_endpoint_id": "xxxx-yyyy-zzzz",
"webhook_endpoint_secret": "xxxx-yyyy-zzzz",
"webhook_endpoint_url": "https://core.commercelayer.co/webhook_callbacks/checkout_com_gateways/xxxxx"
},
"relationships": {
"payment_methods": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/checkout_com_gateways/xYZkjABcde/relationships/payment_methods",
"related": "https://yourdomain.commercelayer.io/api/checkout_com_gateways/xYZkjABcde/payment_methods"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/checkout_com_gateways/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/checkout_com_gateways/xYZkjABcde/versions"
}
},
"checkout_com_payments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/checkout_com_gateways/xYZkjABcde/relationships/checkout_com_payments",
"related": "https://yourdomain.commercelayer.io/api/checkout_com_gateways/xYZkjABcde/checkout_com_payments"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}
Last updated 3 months ago