---
title: "Create a Report"
method: POST
path: "/reports"
---

# Create a Report

`POST /reports`

## Headers

- `X-Organization-Code` string, required

## Request body

- object
  - `type` 'PAYOUTS' | 'PAYMENTS' | 'TRANSACTIONS' | 'SETTLEMENT_FEES' | 'RECONCILIATION_OVERVIEW' | 'COMMUNICATIONS', required — The type of the report to run (MAX 255; MIN 3).
  - `user_code` string — The user identifier to associate with the report request.
  - `start_date` string, date-time, required — Starting timestamp of data to be included in the report run (MAX 24; MIN 24; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
  - `end_date` string, date-time, required — Ending timestamp of data to be included in the report run (MAX 24; MIN 24; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
  - `merchant_reference_id` string — The unique identifier of the report at the merchant side (MAX 255; MIN 3).
  - `account_id` string — Account identifier(s). Omit to include all accounts. For multiple accounts, send a comma-separated list. <br> Example: `19d28762-c714-4fb0-9ef6-4e1953ed33tf, 91d82267-c714-4fb0-9ef6-4e1953ed33tf`.
  - `acquirer` string — Filters the Settlements report by acquirer. Accepts a single value (case-insensitive; conventionally uppercase). <br> Example: `BAC_CREDOMATIC`
  - `payment_status` string — The status of the payment (MAX 255; MIN 3; [Payment status](/reference/payment#payments-status)). Don't send this parameter to request the creation of a report for all payment status. Otherwise, indicate all the status you want to include. <br> Example: `CREATED,READY_TO_PAY,DECLINED`
  - `payment_sub_status` string — The substatus of the payment (MAX 255; MIN 3; [Payment substatus](/reference/payment#payments-status)). Don't send this parameter to request the creation of a report for all payment sub status. Otherwise, indicate all the sub status you want to include. <br> Example: `READY_TO_PAY,PENDING_FRAUD_REVIEW,EXPIRED`
  - `payment_method` string — The type of payment method selected by the customer (MAX 255; MIN 3; [Payment methods](/reference/payment-type-list)). Don't send this parameter to request the creation of a report for all payment methods. Otherwise, indicate all the methods you want to include. <br> Example: `ADDI,ACUOTAZ,PIX`
  - `currency` string — The currency used to make the payment (MAX 3; MIN 3; [ISO 4217](/reference/country-reference)). Don't send this parameter to request the creation of a report for all currencies. Otherwise, indicate all currencies you want to include. <br> Example: `ARS,BRL,COP`
  - `country` string — The country where the transaction must be processed (MAX 2; MIN 2; [ISO 3166-1](/reference/country-reference)). Don't send this parameter to request the creation of a report for all countries. Otherwise, indicate all countries you want to include. <br> Example: `AR,BR,CO`
  - `transaction_type` string — The transaction type (MAX 255; MIN 3; [Transaction types](/reference/transaction#types-of-transactions)). Don't send this parameter to request the creation of a report for all transaction types. Otherwise, indicate all transaction types you want to include. <br> Example: `PURCHASE,REFUND,VERIFY`
  - `transaction_status` string — The status of the transaction (MAX 255; MIN 3; [Transaction status](/reference/payment#payments-status)). Don't send this parameter to request the creation of a report for all transaction status. Otherwise, indicate all transaction status you want to include. <br> Example: `SUCCEEDED,CREATED,EXPIRED`
  - `updated_at_start` string, date-time — Starting timestamp of data to be included in the report run by updated date of operation (MAX 27; MIN 27; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
  - `updated_at_end` string, date-time — Ending timestamp of data to be included in the report run by updated date of operation (MAX 27; MIN 27; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
  - `columns` string — Columns to include (only for Payment or Transaction reports). See available fields in [Report Fields](/reference/reports-fields). <br> Example: `account_code,amount_value,card_category`
  - `metadata_fields` string — Columns to include (only if the merchant is exporting metadata fields). This option is exclusive to Transaction and Settlement reports.

## Response `201`

201

- object
  - `id` string
  - `type` string
  - `start_date` string
  - `end_date` string
  - `merchant_reference_id` string
  - `created_at` string
  - `updated_at` string
  - `expires_at` string
  - `status` string

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403

---

[API](https://skmtc.net/y/apis/ai-caller.md) · [All operations](https://skmtc.net/y/apis/ai-caller/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/y/ai-caller/revisions/05b629819b49/schema)