# The adyen payment object

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

## Fields

| Field                                    | Type      | Description                                                                                                                                                                                         |
| ---------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                 | `string`  | `adyen_payments`                                                                                                                                                                                    |
| **id**                                   | `string`  | The adyen payment unique identifier                                                                                                                                                                 |
| links.**self**                           | `string`  | The adyen payment endpoint URL                                                                                                                                                                      |
| attributes.**public\_key**               | `string`  | The public key linked to your API credential.                                                                                                                                                       |
| attributes.**payment\_methods**          | `object`  | The merchant available payment methods for the assoiated order (i.e. country and amount). Required by the Adyen JS SDK.                                                                             |
| attributes.**payment\_request\_data**    | `object`  | The Adyen payment request data, collected by client.                                                                                                                                                |
| attributes.**payment\_request\_details** | `object`  | The Adyen additional details request data, collected by client.                                                                                                                                     |
| attributes.**payment\_response**         | `object`  | The Adyen payment response, used by client (includes 'resultCode' and 'action').                                                                                                                    |
| attributes.**mismatched\_amounts**       | `boolean` | Indicates if the order current amount differs form the one of the associated authorization.                                                                                                         |
| attributes.**balance**                   | `integer` | The balance remaining on a shopper's gift card, must be computed by using its related trigger attribute.                                                                                            |
| attributes.**\_authorize**               | `boolean` | Send this attribute if you want to authorize the payment.                                                                                                                                           |
| attributes.**\_details**                 | `boolean` | Send this attribute if you want to send additional details the payment request.                                                                                                                     |
| attributes.**\_balance**                 | `boolean` | Send this attribute if you want retrieve the balance remaining on a shopper's gift card.                                                                                                            |
| attributes.**expires\_at**               | `string`  | The expiration date/time of this Adyen payment (valid for partial payments only).                                                                                                                   |
| attributes.**payment\_instrument**       | `object`  | Information about the payment instrument used in the transaction.                                                                                                                                   |
| attributes.**created\_at**               | `string`  | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**               | `string`  | 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.                                        |
| relationships.**order**                  | `object`  | The order associated to the Adyen payment, that is set as its payment source.                                                                                                                       |
| relationships.**payment\_gateway**       | `object`  | The associated payment gateway, inherited by the order payment\_method.                                                                                                                             |
| relationships.**event\_stores**          | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                            | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.commercelayer.io/core-api-reference/adyen_payments/object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.