The checkout.com gateway object
A comprehensive list of the checkout.com gateway resource's attributes and relationships
A checkout.com gateway object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/checkout_com_gateways
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The checkout.com gateway unique identifier |
links.self |
| The checkout.com gateway endpoint URL |
attributes.name |
| The payment gateway's internal name. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
attributes.secret_key |
| The gateway secret key. |
attributes.public_key |
| The gateway public key. |
attributes.webhook_endpoint_id |
| The gateway webhook endpoint ID, generated automatically. |
attributes.webhook_endpoint_secret |
| The gateway webhook endpoint secret, generated automatically. |
attributes.webhook_endpoint_url |
| The gateway webhook URL, generated automatically. |
relationships.payment_methods |
| The associated payment methods. |
relationships.versions |
| The associated changes. |
relationships.checkout_com_payments |
| The associated payments. |
meta.mode |
| The resource environment (can be one of |
Last updated