Merchant::reports::transaction
Retrieves the processing result of a previously submitted Merchant Transactions Report.
The response will be in JSON format, conforming to the schema.
Unique identifier of Merchant Transactions report.
Bearer token for authentication
GET //merchant-api/v1/reports/transactions HTTP/1.1
Host: store.onside.io
Authorization: text
Accept: */*
{
"accepted_at": "2025-07-17T01:32:51.487Z",
"completed_at": null,
"processing_at": null,
"report_id": "text",
"transactions": {
"invalid": [
{
"id": "text",
"reason": "text"
}
],
"valid": [
"text"
]
}
}
Uploads a Merchant Transaction report.
The report must conform to the schema and the payload size must not exceed 5 Megabytes.
Report processing is asynchronous. To check the status of a submitted report, make a GET request to this same endpoint using the report_id
returned in the response of this POST request.
This endpoint is idempotent; submitting the same report content multiple times will result in the same outcome without reprocessing.
Bearer token for authentication
Report of merchant transactions
{
"$id": "https://store.onside.io/schema/transactions-report.json",
"title": "Merchant Transactions Report",
"description": "Report of merchant transactions",
"type": "object",
"required": [
"created_at",
"transactions"
],
"properties": {
"created_at": {
"description": "Date and time when the report was generated in RFC 3339 format",
"examples": [
"2025-06-30T16:01:25Z",
"2025-06-30T03:01:01+02:00"
],
"type": "string",
"format": "date-time"
},
"transactions": {
"description": "List of transactions",
"type": "array",
"items": {
"type": "object",
"required": [
"currency",
"full_amount",
"id",
"payer_country",
"settled_at",
"tax_amount"
],
"properties": {
"currency": {
"description": "Alpha-3 code of the original currency (ISO 4027) of the transaction",
"examples": [
"EUR",
"USD"
],
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"full_amount": {
"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.",
"examples": [
"12357",
"99"
],
"type": "integer"
},
"id": {
"description": "Unique transaction identifier",
"type": "string"
},
"payer_country": {
"description": "Alpha-3 code of the country (ISO 3166) of the payer",
"examples": [
"FRA",
"ESP"
],
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"settled_at": {
"description": "Date and time when the transaction was settled in RFC 3339 format",
"examples": [
"2025-06-12T12:14:25Z",
"2025-06-01T03:01:01+02:00"
],
"type": "string",
"format": "date-time"
},
"tax_amount": {
"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.",
"examples": [
"12357",
"99"
],
"type": "integer"
}
}
},
"minItems": 1
}
}
}
Date and time when the report was generated in RFC 3339 format
POST //merchant-api/v1/reports/transactions HTTP/1.1
Host: store.onside.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 184
{
"created_at": "2025-07-17T01:32:51.487Z",
"transactions": [
{
"currency": "text",
"full_amount": 1,
"id": "text",
"payer_country": "text",
"settled_at": "2025-07-17T01:32:51.487Z",
"tax_amount": 1
}
]
}
{
"reportId": "756330474"
}
Was this helpful?