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

# Models

## The MerchantTransactionsReport object

````json
{"openapi":"3.1.0","info":{"title":"Merchant API","version":"1.0.0"},"components":{"schemas":{"MerchantTransactionsReport":{"type":"object","description":"Report of merchant transactions\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"$id\": \"https://store.onside.io/schema/transactions-report.json\",\n  \"title\": \"Merchant Transactions Report\",\n  \"description\": \"Report of merchant transactions\",\n  \"type\": \"object\",\n  \"required\": [\n    \"created_at\",\n    \"transactions\"\n  ],\n  \"properties\": {\n    \"created_at\": {\n      \"description\": \"Date and time when the report was generated in RFC 3339 format\",\n      \"examples\": [\n        \"2025-06-30T16:01:25Z\",\n        \"2025-06-30T03:01:01+02:00\"\n      ],\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"transactions\": {\n      \"description\": \"List of transactions\",\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"currency\",\n          \"full_amount\",\n          \"id\",\n          \"payer_country\",\n          \"settled_at\",\n          \"tax_amount\"\n        ],\n        \"properties\": {\n          \"currency\": {\n            \"description\": \"Alpha-3 code of the original currency (ISO 4027) of the transaction\",\n            \"examples\": [\n              \"EUR\",\n              \"USD\"\n            ],\n            \"type\": \"string\",\n            \"pattern\": \"^[A-Z]{3}$\"\n          },\n          \"full_amount\": {\n            \"description\": \"Amount of the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units.\",\n            \"examples\": [\n              \"12357\",\n              \"99\"\n            ],\n            \"type\": \"integer\"\n          },\n          \"id\": {\n            \"description\": \"Unique transaction identifier\",\n            \"type\": \"string\"\n          },\n          \"payer_country\": {\n            \"description\": \"Alpha-3 code of the country (ISO 3166) of the payer\",\n            \"examples\": [\n              \"FRA\",\n              \"ESP\"\n            ],\n            \"type\": \"string\",\n            \"pattern\": \"^[A-Z]{3}$\"\n          },\n          \"settled_at\": {\n            \"description\": \"Date and time when the transaction was settled in RFC 3339 format\",\n            \"examples\": [\n              \"2025-06-12T12:14:25Z\",\n              \"2025-06-01T03:01:01+02:00\"\n            ],\n            \"type\": \"string\",\n            \"format\": \"date-time\"\n          },\n          \"tax_amount\": {\n            \"description\": \"Amount of the taxes included in the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units.\",\n            \"examples\": [\n              \"12357\",\n              \"99\"\n            ],\n            \"type\": \"integer\"\n          }\n        }\n      },\n      \"minItems\": 1\n    }\n  }\n}\n ```\n </details>","required":["created_at","transactions"],"properties":{"created_at":{"type":"string","format":"date-time","description":"Date and time when the report was generated in RFC 3339 format"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/MerchantTransactionsReportTransactionsItem"},"description":"List of transactions"}}},"MerchantTransactionsReportTransactionsItem":{"type":"object","description":"`MerchantTransactionsReportTransactionsItem`\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"currency\",\n    \"full_amount\",\n    \"id\",\n    \"payer_country\",\n    \"settled_at\",\n    \"tax_amount\"\n  ],\n  \"properties\": {\n    \"currency\": {\n      \"description\": \"Alpha-3 code of the original currency (ISO 4027) of the transaction\",\n      \"examples\": [\n        \"EUR\",\n        \"USD\"\n      ],\n      \"type\": \"string\",\n      \"pattern\": \"^[A-Z]{3}$\"\n    },\n    \"full_amount\": {\n      \"description\": \"Amount of the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units.\",\n      \"examples\": [\n        \"12357\",\n        \"99\"\n      ],\n      \"type\": \"integer\"\n    },\n    \"id\": {\n      \"description\": \"Unique transaction identifier\",\n      \"type\": \"string\"\n    },\n    \"payer_country\": {\n      \"description\": \"Alpha-3 code of the country (ISO 3166) of the payer\",\n      \"examples\": [\n        \"FRA\",\n        \"ESP\"\n      ],\n      \"type\": \"string\",\n      \"pattern\": \"^[A-Z]{3}$\"\n    },\n    \"settled_at\": {\n      \"description\": \"Date and time when the transaction was settled in RFC 3339 format\",\n      \"examples\": [\n        \"2025-06-12T12:14:25Z\",\n        \"2025-06-01T03:01:01+02:00\"\n      ],\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"tax_amount\": {\n      \"description\": \"Amount of the taxes included in the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units.\",\n      \"examples\": [\n        \"12357\",\n        \"99\"\n      ],\n      \"type\": \"integer\"\n    }\n  }\n}\n ```\n </details>","required":["currency","full_amount","id","payer_country","settled_at","tax_amount"],"properties":{"currency":{"$ref":"#/components/schemas/MerchantTransactionsReportTransactionsItemCurrency","description":"Alpha-3 code of the original currency (ISO 4027) of the transaction"},"full_amount":{"type":"integer","format":"int64","description":"Amount of the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units."},"id":{"type":"string","description":"Unique transaction identifier"},"payer_country":{"$ref":"#/components/schemas/MerchantTransactionsReportTransactionsItemPayerCountry","description":"Alpha-3 code of the country (ISO 3166) of the payer"},"settled_at":{"type":"string","format":"date-time","description":"Date and time when the transaction was settled in RFC 3339 format"},"tax_amount":{"type":"integer","format":"int64","description":"Amount of the taxes included in the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units."}}},"MerchantTransactionsReportTransactionsItemCurrency":{"type":"string","description":"Alpha-3 code of the original currency (ISO 4027) of the transaction\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"description\": \"Alpha-3 code of the original currency (ISO 4027) of the transaction\",\n  \"examples\": [\n    \"EUR\",\n    \"USD\"\n  ],\n  \"type\": \"string\",\n  \"pattern\": \"^[A-Z]{3}$\"\n}\n ```\n </details>"},"MerchantTransactionsReportTransactionsItemPayerCountry":{"type":"string","description":"Alpha-3 code of the country (ISO 3166) of the payer\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"description\": \"Alpha-3 code of the country (ISO 3166) of the payer\",\n  \"examples\": [\n    \"FRA\",\n    \"ESP\"\n  ],\n  \"type\": \"string\",\n  \"pattern\": \"^[A-Z]{3}$\"\n}\n ```\n </details>"}}}}
````

## The MerchantTransactionsReportTransactionsItem object

````json
{"openapi":"3.1.0","info":{"title":"Merchant API","version":"1.0.0"},"components":{"schemas":{"MerchantTransactionsReportTransactionsItem":{"type":"object","description":"`MerchantTransactionsReportTransactionsItem`\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"currency\",\n    \"full_amount\",\n    \"id\",\n    \"payer_country\",\n    \"settled_at\",\n    \"tax_amount\"\n  ],\n  \"properties\": {\n    \"currency\": {\n      \"description\": \"Alpha-3 code of the original currency (ISO 4027) of the transaction\",\n      \"examples\": [\n        \"EUR\",\n        \"USD\"\n      ],\n      \"type\": \"string\",\n      \"pattern\": \"^[A-Z]{3}$\"\n    },\n    \"full_amount\": {\n      \"description\": \"Amount of the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units.\",\n      \"examples\": [\n        \"12357\",\n        \"99\"\n      ],\n      \"type\": \"integer\"\n    },\n    \"id\": {\n      \"description\": \"Unique transaction identifier\",\n      \"type\": \"string\"\n    },\n    \"payer_country\": {\n      \"description\": \"Alpha-3 code of the country (ISO 3166) of the payer\",\n      \"examples\": [\n        \"FRA\",\n        \"ESP\"\n      ],\n      \"type\": \"string\",\n      \"pattern\": \"^[A-Z]{3}$\"\n    },\n    \"settled_at\": {\n      \"description\": \"Date and time when the transaction was settled in RFC 3339 format\",\n      \"examples\": [\n        \"2025-06-12T12:14:25Z\",\n        \"2025-06-01T03:01:01+02:00\"\n      ],\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"tax_amount\": {\n      \"description\": \"Amount of the taxes included in the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units.\",\n      \"examples\": [\n        \"12357\",\n        \"99\"\n      ],\n      \"type\": \"integer\"\n    }\n  }\n}\n ```\n </details>","required":["currency","full_amount","id","payer_country","settled_at","tax_amount"],"properties":{"currency":{"$ref":"#/components/schemas/MerchantTransactionsReportTransactionsItemCurrency","description":"Alpha-3 code of the original currency (ISO 4027) of the transaction"},"full_amount":{"type":"integer","format":"int64","description":"Amount of the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units."},"id":{"type":"string","description":"Unique transaction identifier"},"payer_country":{"$ref":"#/components/schemas/MerchantTransactionsReportTransactionsItemPayerCountry","description":"Alpha-3 code of the country (ISO 3166) of the payer"},"settled_at":{"type":"string","format":"date-time","description":"Date and time when the transaction was settled in RFC 3339 format"},"tax_amount":{"type":"integer","format":"int64","description":"Amount of the taxes included in the transaction in the original currency in minor units: the smallest unit of a currency, depending on the number of decimals. For example, $12.34 (12 USD and 34 cents) is 1234 in minor units."}}},"MerchantTransactionsReportTransactionsItemCurrency":{"type":"string","description":"Alpha-3 code of the original currency (ISO 4027) of the transaction\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"description\": \"Alpha-3 code of the original currency (ISO 4027) of the transaction\",\n  \"examples\": [\n    \"EUR\",\n    \"USD\"\n  ],\n  \"type\": \"string\",\n  \"pattern\": \"^[A-Z]{3}$\"\n}\n ```\n </details>"},"MerchantTransactionsReportTransactionsItemPayerCountry":{"type":"string","description":"Alpha-3 code of the country (ISO 3166) of the payer\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"description\": \"Alpha-3 code of the country (ISO 3166) of the payer\",\n  \"examples\": [\n    \"FRA\",\n    \"ESP\"\n  ],\n  \"type\": \"string\",\n  \"pattern\": \"^[A-Z]{3}$\"\n}\n ```\n </details>"}}}}
````

## The MerchantTransactionsReportTransactionsItemCurrency object

````json
{"openapi":"3.1.0","info":{"title":"Merchant API","version":"1.0.0"},"components":{"schemas":{"MerchantTransactionsReportTransactionsItemCurrency":{"type":"string","description":"Alpha-3 code of the original currency (ISO 4027) of the transaction\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"description\": \"Alpha-3 code of the original currency (ISO 4027) of the transaction\",\n  \"examples\": [\n    \"EUR\",\n    \"USD\"\n  ],\n  \"type\": \"string\",\n  \"pattern\": \"^[A-Z]{3}$\"\n}\n ```\n </details>"}}}}
````

## The MerchantTransactionsReportTransactionsItemPayerCountry object

````json
{"openapi":"3.1.0","info":{"title":"Merchant API","version":"1.0.0"},"components":{"schemas":{"MerchantTransactionsReportTransactionsItemPayerCountry":{"type":"string","description":"Alpha-3 code of the country (ISO 3166) of the payer\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"description\": \"Alpha-3 code of the country (ISO 3166) of the payer\",\n  \"examples\": [\n    \"FRA\",\n    \"ESP\"\n  ],\n  \"type\": \"string\",\n  \"pattern\": \"^[A-Z]{3}$\"\n}\n ```\n </details>"}}}}
````

## The ReportIdResponse object

```json
{"openapi":"3.1.0","info":{"title":"Merchant API","version":"1.0.0"},"components":{"schemas":{"ReportIdResponse":{"type":"object","required":["reportId"],"properties":{"reportId":{"type":"integer","format":"int64","description":"Unique identifier of Merchant Transactions report.","minimum":1}}}}}}
```

## The ResultOfMerchantTransactionsReportProcessing object

````json
{"openapi":"3.1.0","info":{"title":"Merchant API","version":"1.0.0"},"components":{"schemas":{"ResultOfMerchantTransactionsReportProcessing":{"type":"object","description":"Result of processing of transactions report\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"$id\": \"https://store.onside.io/schema/transactions-report-result.json\",\n  \"title\": \"Result of Merchant Transactions Report processing\",\n  \"description\": \"Result of processing of transactions report\",\n  \"type\": \"object\",\n  \"required\": [\n    \"accepted_at\",\n    \"report_id\",\n    \"transactions\"\n  ],\n  \"properties\": {\n    \"accepted_at\": {\n      \"description\": \"Date and time when the report was accepted\",\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"completed_at\": {\n      \"description\": \"Date and time when the report was completed\",\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"processing_at\": {\n      \"description\": \"Date and time when the report processing has started\",\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"report_id\": {\n      \"description\": \"Unique report identifier\",\n      \"type\": \"string\"\n    },\n    \"transactions\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"invalid\": {\n          \"description\": \"List of invalid transactions\",\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"required\": [\n              \"id\",\n              \"reason\"\n            ],\n            \"properties\": {\n              \"id\": {\n                \"description\": \"Unique transaction identifier\",\n                \"type\": \"string\"\n              },\n              \"reason\": {\n                \"description\": \"Reason why the transaction is invalid\",\n                \"type\": \"string\"\n              }\n            }\n          }\n        },\n        \"valid\": {\n          \"description\": \"List of identifiers of valid transactions\",\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}\n ```\n </details>","required":["accepted_at","report_id","transactions"],"properties":{"accepted_at":{"type":"string","format":"date-time","description":"Date and time when the report was accepted"},"completed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the report was completed"},"processing_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the report processing has started"},"report_id":{"type":"string","description":"Unique report identifier"},"transactions":{"$ref":"#/components/schemas/ResultOfMerchantTransactionsReportProcessingTransactions"}}},"ResultOfMerchantTransactionsReportProcessingTransactions":{"type":"object","description":"`ResultOfMerchantTransactionsReportProcessingTransactions`\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"invalid\": {\n      \"description\": \"List of invalid transactions\",\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"id\",\n          \"reason\"\n        ],\n        \"properties\": {\n          \"id\": {\n            \"description\": \"Unique transaction identifier\",\n            \"type\": \"string\"\n          },\n          \"reason\": {\n            \"description\": \"Reason why the transaction is invalid\",\n            \"type\": \"string\"\n          }\n        }\n      }\n    },\n    \"valid\": {\n      \"description\": \"List of identifiers of valid transactions\",\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    }\n  }\n}\n ```\n </details>","properties":{"invalid":{"type":"array","items":{"$ref":"#/components/schemas/ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem"},"description":"List of invalid transactions"},"valid":{"type":"array","items":{"type":"string"},"description":"List of identifiers of valid transactions"}}},"ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem":{"type":"object","description":"`ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem`\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"id\",\n    \"reason\"\n  ],\n  \"properties\": {\n    \"id\": {\n      \"description\": \"Unique transaction identifier\",\n      \"type\": \"string\"\n    },\n    \"reason\": {\n      \"description\": \"Reason why the transaction is invalid\",\n      \"type\": \"string\"\n    }\n  }\n}\n ```\n </details>","required":["id","reason"],"properties":{"id":{"type":"string","description":"Unique transaction identifier"},"reason":{"type":"string","description":"Reason why the transaction is invalid"}}}}}}
````

## The ResultOfMerchantTransactionsReportProcessingTransactions object

````json
{"openapi":"3.1.0","info":{"title":"Merchant API","version":"1.0.0"},"components":{"schemas":{"ResultOfMerchantTransactionsReportProcessingTransactions":{"type":"object","description":"`ResultOfMerchantTransactionsReportProcessingTransactions`\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"invalid\": {\n      \"description\": \"List of invalid transactions\",\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"id\",\n          \"reason\"\n        ],\n        \"properties\": {\n          \"id\": {\n            \"description\": \"Unique transaction identifier\",\n            \"type\": \"string\"\n          },\n          \"reason\": {\n            \"description\": \"Reason why the transaction is invalid\",\n            \"type\": \"string\"\n          }\n        }\n      }\n    },\n    \"valid\": {\n      \"description\": \"List of identifiers of valid transactions\",\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    }\n  }\n}\n ```\n </details>","properties":{"invalid":{"type":"array","items":{"$ref":"#/components/schemas/ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem"},"description":"List of invalid transactions"},"valid":{"type":"array","items":{"type":"string"},"description":"List of identifiers of valid transactions"}}},"ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem":{"type":"object","description":"`ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem`\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"id\",\n    \"reason\"\n  ],\n  \"properties\": {\n    \"id\": {\n      \"description\": \"Unique transaction identifier\",\n      \"type\": \"string\"\n    },\n    \"reason\": {\n      \"description\": \"Reason why the transaction is invalid\",\n      \"type\": \"string\"\n    }\n  }\n}\n ```\n </details>","required":["id","reason"],"properties":{"id":{"type":"string","description":"Unique transaction identifier"},"reason":{"type":"string","description":"Reason why the transaction is invalid"}}}}}}
````

## The ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem object

````json
{"openapi":"3.1.0","info":{"title":"Merchant API","version":"1.0.0"},"components":{"schemas":{"ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem":{"type":"object","description":"`ResultOfMerchantTransactionsReportProcessingTransactionsInvalidItem`\n\n <details><summary>JSON schema</summary>\n\n ```json\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"id\",\n    \"reason\"\n  ],\n  \"properties\": {\n    \"id\": {\n      \"description\": \"Unique transaction identifier\",\n      \"type\": \"string\"\n    },\n    \"reason\": {\n      \"description\": \"Reason why the transaction is invalid\",\n      \"type\": \"string\"\n    }\n  }\n}\n ```\n </details>","required":["id","reason"],"properties":{"id":{"type":"string","description":"Unique transaction identifier"},"reason":{"type":"string","description":"Reason why the transaction is invalid"}}}}}}
````


---

# 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.onside.io/api/transactions-reporting-api/models.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.