Transaction

Todas as informações referentes à transação. Este objeto não está presente em todos os eventos, já que existem eventos que não possuem transação - como por exemplo Carrinho abandonado.

Transaction

{
    //...
    "transaction": {
        "id": "d9784ad3-abcd-abcd-abcd-8b03999fe687",
        "project": {
            "name": "Product Explorer",
            "id": "e3255bd0-abcd-abcd-abcd-5502bfc68ae7",
            "organization": {
                "name": "Assiny",
                "id": "723a0f0a-abcd-abcd-abcd-3c949b1d94df"
            }
        },
        "amount": 10000,
        "fee_amount": 588,
        "net_amount": 9412,
        "commissions": [
            {
              "amount": 9502,
              "user": "Nome do vendedor"
            }
          ],
        "installments": 1,
        "currency": "BRL",
        "cycle": 1,
        "created_at": "2025-01-14T13:29:10.296151Z",
        "updated_at": "2025-01-14T13:29:16.844953Z",
        "status": "paid",
        "payment_type": "CREDIT",
        "additional_data": {
            "PIX": {
                "qr_code": null
            },
            "BANK_SLIP": {
                "url": null,
                "barcode": null
            }
        },
        "smart_installment": null
    }
    //...
}

Nome	Tipo	Descrição
`id`	UUID	Id da transação na Assiny
`project.name`	string	Nome do seu projeto na Assiny em que aconteceu a transação em questão
`project.id`	UUID	Id do seu projeto na Assiny em que aconteceu a transação em questão
`project.organization.id`	UUID	Id da sua organização na Assiny que é dona do projeto em questão
`project.organization.name`	string	Nome da sua organização na Assiny que é dona do projeto em questão
`amount`	integer	Soma dos amounts de todos os produtos na transação (produto principal + orderbumps)
`fee_amount`	integer	Valor da taxa da Assiny cobrada na transação
`net_amount`	integer	Valor líquido da transação
`commissions`	Array	Produtores que receberam valores da transação. Quando há uma co-produção, há mais de um item
`installments`	integer	Número de parcelas da transação. Em casos à vista o valor vem 1
`currency`	string	Moeda em que a transação foi feita. Segue o padrão ISO 4217
`cycle`	integer	Qual o ciclo da assinatura a transação se refere. Quando não for assinatura retorna 1
`created_at`	string	Data de criação da transação
`updated_at`	string	Data da última atualização da transação
`status`	string	Status da transação
`payment_type`	string	Tipo de pagamento na transação. Ex.: PIX, CREDIT_CARD, BANK_SLIP
`smart_installments`	Object	Informações relativa ao parcelamento inteligente. Caso null, não se aplica
`additional_data.PIX`	string	Código copia cola para pagamento do PIX
`additional_data.BANK_SLIP.url`	string	Link de download do PDF do boleto
`additional_data.BANK_SLIP.barcode`	string	Código de barras do boleto

Estrutura Smart Installments

Quando uma transação acontece utilizando o Smart Installment (Parcelamento inteligente), nós enviamos um objeto com informações relevantes. Caso não se aplique, o retorno será null

Quando uma transação for de parcelamento inteligente, o número de parcelas real estará no campo smart_installment.total_installments e não no installments da transaction acima.

No installment da transação, ficará "installment": 1 pois o parcelamento inteligente não usa o limite do cartão do cliente, e por isso funciona de forma parecida com uma assinatura.

Smart installment

{
    //...
    "transaction": {
        //...
        "smart_installment": {
            "smart_installment_id": "e3255bd0-abcd-abcd-abcd-5502bfc68ae7",
            "total_installments": 8,
            "next_charge": "2025-01-14T13:29:10.296151Z",
            "current_installment": 2
        }
        //...
    }
    //...
}

Nome	Tipo	Descrição
`smart_installment_id`	UUID	Id do smart installment na Assiny
`total_installments`	integer	Numero de parcelas escolhida pelo cliente na hora da compra
`next_charge`	string	Data da próxima cobrança
`current_installment`	integer	Parcela atual do cliente

Client

Dados de quem comprou, incluindo endereço.

Tabela completa

Todos os campos do payload em uma página.

Webhooks

Estrutura dos dados

Payloads por evento

Estrutura Smart Installments

Client

Tabela completa

​Estrutura Smart Installments

Client

Tabela completa

Estrutura Smart Installments