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 | Tipo | 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 |
paidAmount | int | Valor pago em centavos. |
refundedAmount | int | Valor estornado em centavos. |
paymentMethod | string | Meio de pagamento utilizado na transação. Valores possíveis: CARD, PIX, BOLETO |
installments | int | Quantidade de parcelas da transação. |
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 |
companyId | int | ID da empresa que criou a transação. |
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. |
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 |
splits | object | Regras de divisão da transação. Consulte o objeto splits |