API Reference
GuidesSuporteAPI Reference

Objeto Transação

❗️

Você está na versão correta da documentação?

Verifique na sua Dashboard a versão da API que você está usando. Você deve usar a documentação correspondente. Para saber mais, veja: Versionamento.

Ao criar ou atualizar uma transação, este será o objeto que você irá receber como resposta em cada etapa do processo de efetivação da transação.

PropriedadeDescrição
object
String		Nome do tipo do objeto criado/modificado.
Valor retornado: transaction
status
String		Representa o estado da transação. Para cada atualização no processamento da transação, esta propriedade será alterada, e caso esteja usando uma postback_url, seus servidores serão notificados de tais updates.
Valores possíveis: processing, authorized, paid, refunded, waiting_payment, pending_refund, refused, chargedback .
refuse_reason
String		Motivo pelo qual a transação foi recusada.
Valores possíveis: acquirer, antifraud, internal_error, no_acquirer, acquirer_timeout
status_reason
String		Agente responsável pela validação ou anulação da transação.
Valores possíveis: acquirer, antifraud, internal_error, no_acquirer, acquirer_timeout
acquirer_name
String		Adquirente responsável pelo processamento da transação.
Valores possíveis: development (em ambiente de testes), pagarme (adquirente Pagar.me), stone, cielo, rede.
acquirer_id
String		ID do adquirente responsável pelo processamento da transação.
acquirer_response_code
String		Mensagem de resposta do adquirente referente ao status da transação.
authorization_code
String		Código de autorização retornado pela bandeira.
soft_descriptor
String		Texto que irá aparecer na fatura do cliente depois do nome da loja.
OBS: Limite de 13 caracteres.
tid
String		Código que identifica a transação no adquirente.
nsu
String		Código que identifica a transação no adquirente.
date_created
String		Data de criação da transação no formato ISODate
date_updated
String		Data de atualização da transação no formato ISODate
amount
Integer		Valor, em centavos, da transação.
Exemplo: R$100,00 = 10000
authorized_amount
Integer		Valor em centavos autorizado na transação, sempre menor ou igual a amount.
paid_amount
Integer		Valor em centavos capturado na transação, sempre menor ou igual a authorized_amount.
refunded_amount
Integer		Valor em centavos estornado até o momento na transação, sempre menor ou igual a paidamount
installments
Integer		Número de parcelas a serem cobradas.
OBS: Mínimo 1 e Máximo 12.
id
Numeric		Número identificador da transação
cost
Float		Custo da transação para o lojista, envolvendo processamento e antifraude.
card_holder_name
String		Nome do portador do cartão.
card_last_digits
String		Últimos 4 dígitos do cartão.
card_first_digits
String		Primeiros 5 dígitos do cartão
card_brand
String		Bandeira do cartão.
card_pin_mode
String		Usado em transações EMV, define se a validação do cartão aconteceu online(com banco emissor), ou offline( através do chip).
postback_url
String		URL (endpoint) de seu sistema que receberá notificações a cada mudança no status da transação.
payment_method
String		Método de pagamento, com os possíveis valores: credit_card e boleto.
capture_method
String		Define qual foi a forma de captura dos dados de pagamento. Valores possíveis: magstripe, emv, ecommerce.
antifraud_score
String		Define qual foi a nota de antifraude atribuída a transação. Lembrando que por padrão, transações com score >= 95 são recusadas.
boleto_url
String		URL do boleto para impressão
boleto_barcode
String		Código de barras do boleto gerado na transação
boleto_expiration_date
String		Data de expiração do boleto (em ISODate)
referer
String		Mostra se a transação foi criada utilizando a API Key ou Encryption Key
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.
subscription_id
Integer		Caso essa transação tenha sido originada na cobrança de uma assinatura, o id desta será o valor dessa propriedade.
phone
Object		Objeto com dados do telefone do cliente
address
Object		Objeto com dados do endereço do cliente
customer
Object		Objeto com dados do cliente
card
Object		Objeto com dados do cartão do cliente
metadata
Object		Objeto com dados adicionais informados na criação da transação.
split_rules
Object		Objeto com as regras de split definidas para essa transação.
antifraud_metadata
Object		Objeto com dados usados na integração com antifraude.
reference_key
String		Valor único que identifica a transação para permitir uma nova tentativa de requisição com a segurança de que a mesma operação não será executada duas vezes acidentalmente.
{
    "object": "transaction",
    "status": "paid",
    "refuse_reason": null,
    "status_reason": "acquirer",
    "acquirer_response_code": "0000",
    "acquirer_name": "pagarme",
    "acquirer_id": "56f9d019decf72cc70055d58",
    "authorization_code": "415515",
    "soft_descriptor": null,
    "tid": 1627803,
    "nsu": 1627803,
    "date_created": "2017-06-17T20:01:52.955Z",
    "date_updated": "2017-06-17T20:01:53.535Z",
    "amount": 1000,
    "authorized_amount": 1000,
    "paid_amount": 1000,
    "refunded_amount": 0,
    "installments": 1,
    "id": 1627803,
    "cost": 50,
    "card_holder_name": "Aardvark da Silva",
    "card_last_digits": "2122",
    "card_first_digits": "455636",
    "card_brand": "visa",
    "card_pin_mode": null,
    "postback_url": "https://api.aardvark.com/handlepostback/pagarme",
    "payment_method": "credit_card",
    "capture_method": "ecommerce",
    "antifraud_score": null,
    "boleto_url": null,
    "boleto_barcode": null,
    "boleto_expiration_date": null,
    "referer": "api_key",
    "ip": "189.8.94.42",
    "subscription_id": null,
    "phone": null,
    "address": null,
    "customer": null,
    "billing": null,
    "shipping": null,
    "items": [],
    "card": {
      "object": "card",
      "id": "card_cj41mpuhc01bb3f6d8exeo072",
      "date_created": "2017-06-17T18:41:10.801Z",
      "date_updated": "2017-06-17T18:41:11.257Z",
      "brand": "visa",
      "holder_name": "Aardvark da Silva",
      "first_digits": "424242",
      "last_digits": "4242",
      "country": "AR",
      "fingerprint": "SK+CuBxPYsE7",
      "valid": true,
      "expiration_date": "1220"
    },
    "split_rules": null,
    "antifraud_metadata": {},
    "metadata": {
      "idPedido": 123
    }
  }