> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/axerve_payments/object.md).

# The axerve payment object

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

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

## Fields

| Field                                 | Type      | Description                                                                                                                                                                                         |
| ------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                              | `string`  | `axerve_payments`                                                                                                                                                                                   |
| **id**                                | `string`  | The axerve payment unique identifier                                                                                                                                                                |
| links.**self**                        | `string`  | The axerve payment endpoint URL                                                                                                                                                                     |
| attributes.**login**                  | `string`  | The merchant login code.                                                                                                                                                                            |
| attributes.**return\_url**            | `string`  | The URL where the payer is redirected after they approve the payment.                                                                                                                               |
| attributes.**payment\_request\_data** | `object`  | The Axerve payment request data, collected by client.                                                                                                                                               |
| attributes.**client\_ip**             | `string`  | The IP adress of the client creating the payment.                                                                                                                                                   |
| attributes.**buyer\_details**         | `object`  | The details of the buyer creating the payment.                                                                                                                                                      |
| attributes.**request\_token**         | `boolean` | Requires the creation of a token to represent this payment, mandatory to use customer's wallet and order subscriptions.                                                                             |
| attributes.**mismatched\_amounts**    | `boolean` | Indicates if the order current amount differs form the one of the associated authorization.                                                                                                         |
| attributes.**\_update**               | `boolean` | Send this attribute if you want to update the payment with fresh order data.                                                                                                                        |
| 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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.