The adyen gateway object

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

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

Fields

Field	Type	Description
type	string	adyen_gateways
id	string	The adyen gateway unique identifier
links.self	string	The adyen 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.merchant_account	string	The gateway merchant account.
attributes.api_key	string	The gateway API key.
attributes.public_key	string	The public key linked to your API credential.
attributes.live_url_prefix	string	The prefix of the endpoint used for live transactions.
attributes.api_version	integer	The checkout API version, supported range is from 66 to 71, default is 71.
attributes.async_api	boolean	Indicates if the gateway will leverage on the Adyen notification webhooks, using latest API version.
attributes.partial_payments	boolean	Send this attribute if you want to enable partial payments for the order.
attributes.native_customer_payment_sources	boolean	Indicates if the gateway will use the native customer payment sources.
attributes.webhook_endpoint_secret	string	The gateway webhook endpoint secret, generated by Adyen customer area.
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.adyen_payments	array	The associated payments.
meta.mode	string	The resource environment (can be one of test or live)