O relatório de transações permite visualizar as operações realizadas em um período determinado, incluindo cobranças e devoluções. Ele é solicitado pelo portal de pagamentos e recebido como arquivo .CSV por e-mail.
Para gerá-lo, iniciar sessão, filtrar pelo período desejado e clicar no botão de exportar. O arquivo será enviado por e-mail ao usuário com a sessão iniciada.
O relatório inclui três tipos de operações que são identificadas no campo transaction_type:
- Payment: cobrança realizada do comprador.
- Refund: devolução total de uma cobrança anterior.
- Partial Refund: devolução parcial de uma cobrança anterior.
Cada operação aparece como uma linha independente no relatório. A seguir é apresentado um exemplo com uma cobrança realizada em 01/08 e sua devolução realizada em 10/08:
| Período | O que aparece no relatório |
|---|
| 01/08 a 30/08 | 2 linhas: 1 cobrança + 1 devolução |
| 05/09 a 15/08 | 1 linha: apenas a devolução |
Se a cobrança foi realizada fora do período selecionado, apenas a devolução aparecerá no relatório. A cobrança não é incluída porque está fora do período filtrado.
| Coluna | Descrição |
|---|
store | Código da loja do comércio na Koin |
account | Conta à qual a transação pertence |
| Coluna | Descrição |
|---|
store_reference_id | Identificador único da transação informado pelo comércio |
store_business_id | Identificador opcional informado pelo comércio |
store_transaction_id | Identificador auxiliar informado pelo comércio (caso VTEX) |
order_id | Identificador do pedido da Koin |
transaction_id | Identificador da transação da Koin |
| Coluna | Descrição |
|---|
payment_method | Meio de pagamento (CARD, PIX, BNPL, etc.) |
channel | Canal de origem da transação (link de pagamento, API, checkout ou SDK) |
transaction_type | Tipo de operação (Payment, Refund, Partial Refund) |
country | País da transação |
currency | Moeda da transação |
| Coluna | Descrição |
|---|
original_amount | Valor da transação informado pelo comércio |
discount_amount | Valor do desconto aplicado |
interest_amount | Valor do juro aplicado |
amount | Valor final da transação |
| Coluna | Descrição |
|---|
creation_date | Data de criação da transação |
notification_date | Data em que a transação chegou ao seu status final (ex.: cobrada via PIX, Debin, link de pagamento, etc.) |
| Coluna | Descrição |
|---|
installments | Quantidade de parcelas |
installments_type | Plano de parcelamento da transação |
| Coluna | Descrição |
|---|
transaction_status | Status da transação |
transaction_status_reason | Razão do status quando a transação foi rejeitada |
| Coluna | Descrição |
|---|
provider_name | Instituição de pagamento responsável por liquidar fundos (adquirente, banco, APM, etc.) |
provider_reference | Identificador gerado pelo provedor |
provider_store_account | Identificador do comércio no provedor |
provider_confirmation_id | Identificador de confirmação de cobrança gerado pelo provedor |
provider_additional_reference_1 | Referência única informada pelo adquirente ou provedor |
provider_additional_reference_2 | Referência adicional do adquirente ou provedor (em AR: identificador de lote; em BR: TID) |
provider_additional_reference_3 | Referência adicional informada pelo adquirente ou provedor (em AR: identificador de cupom; em BR: NSU) |
provider_error_code | Código de erro recebido do provedor |
provider_error_message | Mensagem de erro recebida do provedor |
| Coluna | Descrição |
|---|
koin_services | Comissão que a Koin cobra do comércio pela transação, conforme o acordo comercial |
| Coluna | Descrição |
|---|
card_bin | BIN do cartão utilizado |
card_last_digits | Últimos 4 dígitos do cartão utilizado |
card_brand | Bandeira do cartão utilizado |
card_type | Tipo do cartão: crédito ou débito |
| Coluna | Descrição |
|---|
bank_account_type | Tipo de conta (CA, CC, conforme o mercado) |
bank_account_agency | Agência da conta bancária (conforme o mercado) |
bank_account_number | Número da conta bancária |
bank_account_alias | Alias da conta bancária (conforme o mercado) |
bank_name | Nome do banco associado à conta |
| Coluna | Descrição |
|---|
payer_document_type | Tipo de documento do pagador |
payer_document | Documento do pagador |
payer_email | E-mail do pagador |
payer_phone | Telefone do pagador |
Por que alguns campos vêm vazios?
Os campos que não se aplicam à transação serão exibidos vazios. Por exemplo, os dados do cartão (card_bin, card_last_digits, card_brand, card_type) aparecem apenas em transações com cartão. Os dados bancários aparecem apenas em meios de pagamento que exigem conta bancária.
Como solicitar o relatório?
Pelo portal de pagamentos, iniciar sessão, filtrar pelo período desejado e clicar no botão de exportar. O arquivo .CSV será enviado por e-mail ao usuário com a sessão iniciada.
Qual a diferença entre uma cobrança e uma devolução?
A cobrança (transaction_type: Payment) é a transação original. A devolução (transaction_type: Refund ou Partial Refund) é a devolução total ou parcial de uma cobrança anterior. Ambas aparecem como linhas independentes no relatório.
Por que uma devolução aparece sem sua cobrança?
Se a cobrança foi realizada fora do período selecionado, apenas a devolução aparecerá no relatório. A cobrança não é incluída porque está fora do período filtrado.
