Objeto transaction

Ao criar uma transação, este é o objeto que você recebe como resposta. Você também receberá esse objeto quando ocorrer uma atualização de status da transação no seu postbackUrl.

Propriedade	Descrição
id int	ID da transação.
status string	Status da transação. Valores possíveis: processing, authorized, paid, refunded, waiting_payment, refused, chargedback, canceled, in_protest, partially_paid
amount string	Valor da transação em centavos. Exemplo: R$ 5,00 = 500
paymentMethod string	Meio de pagamento utilizado na transação. Valores possíveis: credit_card, pix, boleto
installments int	Quantidade de parcelas da transação.
acquirerType string	Adquirente responsável pelo processamento da transação.
externalId string	ID da transação na adquirente.
customer object	Dados do cliente. Consulte o objeto customer
shipping object	Dados referente ao endereço de entrega. Consulte o objeto shipping
card object	Dados do cartão de crédito. Consulte o objeto card
pix object	Dados do PIX. Consulte o objeto pix
boleto object	Dados do boleto bancário. Consulte o objeto boleto
sendEmail boolean	Se será enviado um e-mail pela plataforma.
companyId int	ID da empresa que criou a transação.
subscriptionId int	Quando uma transação for criada a partir de uma assinatura da plataforma, esse campo estará preenchido com o ID dessa assinatura.
billingId int	Quando uma transação for criada a partir de uma cobrança interna do painel de cobrança da plataforma, esse campo estará preenchido com o ID dessa cobrança.
postbackUrl string	URL de postback que receberá as atualizações de status da transação.
metadata object	Objeto com dados adicionais informados na criação da transação.
traceable boolean	Se o status de entrega do pedido será gerenciado pela plataforma.
secureId string	ID seguro da transação, para visualizá-la no próprio checkout da plataforma sem precisar de autenticação.
secureUrl string	URL pós compra, para acessar os detalhes da transação sem autenticação.
createdAt datetime	Data de criação da transação.
updatedAt datetime	Data da última atualização da transação.
ip string	IP de origem que criou a transação, podendo ser diretamente de seu cliente, caso a requisição venha diretamente do client-side, ou de seus servidores, caso tudo esteja centralizando em sua aplicação no server-side.
refusedReason object	Quando uma transação no cartão de crédito for recusada, esse campo estará preenchido com o motivo da recusa. Consulte o objeto refusedReason
items array	Dados sobre os produtos comprados. Consulte o objeto item
refunds array	Caso seja realizado um estorno de uma transação, esse estorno estará contido nesse array. Consulte o objeto refund
delivery object	Caso a propriedade traceable seja true, esse objeto estará preenchido com o status da entrega e código de rastreio. Consulte o objeto delivery
fee object	Dados sobre as taxas cobradas na transação. Consulte o objeto fee
splits object	Regras de divisão da transação. Consulte o objeto splits