> 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/satispay_payments/object.md).

# The satispay payment object

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

## Fields

| Field                              | Type      | Description                                                                                                                                                                                         |
| ---------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                           | `string`  | `satispay_payments`                                                                                                                                                                                 |
| **id**                             | `string`  | The satispay payment unique identifier                                                                                                                                                              |
| links.**self**                     | `string`  | The satispay payment endpoint URL                                                                                                                                                                   |
| attributes.**payment\_id**         | `string`  | The payment unique identifier.                                                                                                                                                                      |
| attributes.**flow**                | `string`  | The Satispay payment flow, inspect gateway API details for more information.                                                                                                                        |
| attributes.**status**              | `string`  | The Satispay payment status.                                                                                                                                                                        |
| attributes.**redirect\_url**       | `string`  | The url to redirect the customer after the payment flow is completed.                                                                                                                               |
| attributes.**payment\_url**        | `string`  | Redirect url to the payment page.                                                                                                                                                                   |
| attributes.**payment\_response**   | `object`  | The Satispay payment response, used to fetch internal data.                                                                                                                                         |
| attributes.**\_refresh**           | `boolean` | Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.                                                                                    |
| 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 Satispay 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 dynamically by asking a question.

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

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.