Comment on page
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.Field | Type | Description |
|---|---|---|
type | string | checkout_com_gateways |
id | string | The checkout.com gateway unique identifier |
links.self | string | The checkout.com gateway endpoint URL |
attributes.name | string | The payment gateway's internal name. |
attributes.created_at | datetime | Time at which the resource was created. |
attributes.updated_at | datetime | Time at which the resource was last updated. |
attributes.reference | string | 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 | string | Any identifier of the third party system that defines the reference code |
attributes.metadata | object | 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 | string | The gateway secret key. |
attributes.public_key | string | The gateway public key. |
attributes.webhook_endpoint_id | string | The gateway webhook endpoint ID, generated automatically. |
attributes.webhook_endpoint_secret | string | The gateway webhook endpoint secret, generated automatically. |
attributes.webhook_endpoint_url | string | The gateway webhook URL, generated automatically. |
relationships.payment_methods | array | The associated payment methods. |
relationships.versions | array | The associated changes. |
relationships.checkout_com_payments | array | The associated payments. |
meta.mode | string | The resource environment (can be one of test or live) |
Last modified 3mo ago