Create a Report

POST /reports

Create a Report

cURL

curl --request POST \
  --url https://api-sandbox.y.uno/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-Code: <x-organization-code>' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "type": "PAYMENTS",
  "start_date": "2023-07-28T21:09:03.327Z",
  "end_date": "2023-07-28T21:09:03.327Z",
  "merchant_reference_id": "test_id",
  "account_id": "19d28762-c714-4fb0-9ef6-4e1953ed33tf, 91d82267-c714-4fb0-9ef6-4e1953ed33tf",
  "payment_status": "CREATED,READY_TO_PAY,DECLINED",
  "payment_sub_status": "READY_TO_PAY,PENDING_FRAUD_REVIEW,EXPIRED",
  "payment_method": "ADDI,ACUOTAZ,PIX",
  "currency": "ARS,BRL,COP",
  "country": "AR,BR,CO",
  "transaction_type": "PURCHASE,REFUND,VERIFY",
  "transaction_status": "SUCCEEDED,CREATED,EXPIRED",
  "updated_at_start": "2023-07-28T21:09:03.327Z",
  "updated_at_end": "2023-07-28T21:09:03.327Z",
  "columns": "account_code,amount_value,card_category"
}
'

201

{
  "id": "6d905149-b388-4522-8c0a-759fed1f39da",
  "type": "PAYMENTS",
  "start_date": "2023-07-01 00:00:00 +0000 UTC",
  "end_date": "2023-07-12 00:00:00 +0000 UTC",
  "merchant_reference_id": "payments_1",
  "created_at": "2023-07-12 20:10:30.311048496 +0000 UTC",
  "updated_at": "2023-07-12 20:10:30.311048496 +0000 UTC",
  "expires_at": "",
  "status": "IN_PROCESS"
}

This endpoint allows you to request the generation of specific report types. The response from this endpoint provides an object containing:

• The status of the report generation.
• A report id.

Use the report id to download the report using the Download a Report endpoint after it is generated.

Authorizations

public-api-key · string · header · default: <Your public-api-key> · required

private-secret-key · string · header · default: <Your private-secret-key> · required

Headers

X-Organization-Code · string · required

Organization code associated to the request.

Body

application/json

type · enum<string> · required

The type of the report to run (MAX 255; MIN 3).

Available options: PAYOUTS, PAYMENTS, TRANSACTIONS, SETTLEMENTS, TRANSACTION_RECONCILIATION, COMMUNICATIONS

start_date · string<date-time> · required

Starting timestamp of data to be included in the report run (MAX 24; MIN 24; 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).

user_code · string

The user identifier to associate with the report request.

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.
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).
Example: BAC_CREDOMATIC

payment_status · string

The status of the payment (MAX 255; MIN 3; Payment 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.
Example: CREATED,READY_TO_PAY,DECLINED

payment_sub_status · string

The substatus of the payment (MAX 255; MIN 3; Payment substatus). 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.
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). 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.
Example: ADDI,ACUOTAZ,PIX

currency · string

The currency used to make the payment (MAX 3; MIN 3; ISO 4217). Don't send this parameter to request the creation of a report for all currencies. Otherwise, indicate all currencies you want to include.
Example: ARS,BRL,COP

country · string

The country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1). Don't send this parameter to request the creation of a report for all countries. Otherwise, indicate all countries you want to include.
Example: AR,BR,CO

transaction_type · string

The transaction type (MAX 255; MIN 3; Transaction types). 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.
Example: PURCHASE,REFUND,VERIFY

transaction_status · string

The status of the transaction (MAX 255; MIN 3; Transaction 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.
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).

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).

columns · string

Columns to include (only for Payment or Transaction reports). See available fields in Report Fields.
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

application/json

201

id · string

Example:

"6d905149-b388-4522-8c0a-759fed1f39da"

type · string

Example:

"PAYMENTS"

start_date · string

Example:

"2023-07-01 00:00:00 +0000 UTC"

end_date · string

Example:

"2023-07-12 00:00:00 +0000 UTC"

merchant_reference_id · string

Example:

"payments_1"

created_at · string

Example:

"2023-07-12 20:10:30.311048496 +0000 UTC"

updated_at · string

Example:

"2023-07-12 20:10:30.311048496 +0000 UTC"

expires_at · string

Example:

""

status · string

Example:

"IN_PROCESS"