The axerve gateway object

A comprehensive list of the axerve gateway resource's attributes and relationships

An axerve gateway object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/axerve_gateways endpoint.

Fields

Field	Type	Description
type	string	axerve_gateways
id	string	The axerve gateway unique identifier
links.self	string	The axerve gateway endpoint URL
attributes.api_key	string	The gateway API key.
attributes.created_at	datetime	Time at which the resource was created.
attributes.login	string	The merchant login 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.name	string	The payment gateway's internal name.
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.updated_at	datetime	Time at which the resource was last updated.
attributes.webhook_endpoint_url	string	The gateway webhook URL, generated automatically.
relationships.axerve_payments	array	The associated payments.
relationships.payment_methods	array	The associated payment methods.
relationships.versions	array	The associated changes.
meta.mode	string	The resource environment (can be one of test or live)