API Reference

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.

PropriedadeTipoDescrição
idintID da transação.
statusstringStatus da transação. Valores possíveis: processing, authorized, paid, refunded, waiting_payment, refused, chargedback, canceled, in_protest, partially_paid
amountstringValor da transação em centavos. Exemplo: R$ 5,00 = 500
paidAmountintValor pago em centavos.
refundedAmountintValor estornado em centavos.
paymentMethodstringMeio de pagamento utilizado na transação. Valores possíveis: CARD, PIX, BOLETO
installmentsintQuantidade de parcelas da transação.
customerobjectDados do cliente. Consulte o objeto customer
shippingobjectDados referente ao endereço de entrega. Consulte o objeto shipping
cardobjectDados do cartão de crédito. Consulte o objeto card
pixobjectDados do PIX. Consulte o objeto pix
boletoobjectDados do boleto bancário. Consulte o objeto boleto
companyIdintID da empresa que criou a transação.
postbackUrlstringURL de postback que receberá as atualizações de status da transação.
metadataobjectObjeto com dados adicionais informados na criação da transação.
createdAtdatetimeData de criação da transação.
updatedAtdatetimeData da última atualização da transação.
ipstringIP 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.
refusedReasonobjectQuando uma transação no cartão de crédito for recusada, esse campo estará preenchido com o motivo da recusa. Consulte o objeto refusedReason
itemsarrayDados sobre os produtos comprados. Consulte o objeto item
splitsobjectRegras de divisão da transação. Consulte o objeto splits