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