POST
/
v1
/
reports

Authorizations

​
X-Client-Id
string
headerrequired
​
X-Api-Key
string
headerrequired

Headers

​
accept-language
enum<string>
default: en

Idioma da exportação

Available options:
en,
pt
​
X-User-Timezone
string
default: America/Sao_Paulo

Timezone local do cliente no formato tz database

Body

application/json

Possuí somente o ultimo status de transação

​
sendTo
string
required

E-mail para qual a exportação será enviada

​
type
enum<string>
required

Tipo de relatório

Available options:
transactions
​
fields
required

Exportando todos os campos

Available options:
all
​
filters
object
required

Filtros que serão aplicados aos dados para a exportação

Response

201 - application/json
​
id
string

Id da exportação

​
clientId
string

Identificador do cliente na Malga

​
email
string

E-mail para qual a exportação foi enviada

​
language
enum<string>

Idioma usado na exportação

Available options:
pt,
en
​
type
enum<string>

Tipo de relatório

Available options:
transactions,
transactionsHistory
​
status
any[]
​
pagesCount
number

Número de arquivos gerados

​
files
any[]

Lista do nome dos arquivos gerados

​
fields
enum<string>[]
Available options:
card_brand__brand,
card__holder_name,
customer__client_id,
customer__name,
customer__email,
customer__phone_number,
customer__document_number,
customer__customer_adress_id,
customer_address__complement,
customer_address__zip_code,
customer_address__street,
customer_address__street_number,
customer_address__state,
customer_address__city,
customer_address__district,
customer_address__country,
nupay__payment_type,
transaction__id,
transaction__amount,
transaction__original_amount,
transaction__created_at,
transaction__currency,
transaction__description,
transaction__order_id,
transaction__merchant_id,
transaction_request__created_at,
transaction_request__payment_method,
transaction_request__provider_id,
transaction__installments,
transaction__status,
transaction_source__card_id,
transaction__statement_descriptor,
provider__name,
session__id
​
createdAt
string

Data da criação

​
updatedAt
string

Data da atualização

​
expiredAt
string

Data de expiração dos links para download dos arquivos

​
timezone
string

Timezone utilizado para as datas

​
filters
object

Filtros que foram aplicados aos dados para a exportação

Was this page helpful?

Atualizar webhook pelo idRecuperar detalhes de uma exportação