Objeto transaction (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 é o objeto que você recebe 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. A cada atualização no processamento da transação, esta propriedade é alterada e, caso você esteja usando uma postback_url, os seus servidores são notificados desses 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 da adquirente responsável pelo processamento da transação.
acquirer_response_code
String
Mensagem de resposta da 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 na adquirente.
nsu
String
Código que identifica a transação na 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
Integer
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 recebe 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.
customer
Object
Dados do cliente. Obrigatório com o antifraude habilitado. O objetocustomer é descrito aqui
billing
Object
Dados de cobrança da transação. Obrigatório com o antifraude habilitado. O objetobilling é descrito aqui
shipping
Object
Dados de envio do que foi comprado. Deve ser preenchido no caso de venda de bem físico. O objetoshipping é descrito aqui
items
Object
Dados sobre os produtos comprados. Obrigatório com o antifraude habilitado. O objetoitems é descrito aqui
address
Object
Dados de endereço, presente em shipping e billing. Obrigatório com o antifraude habilitado. O objetoaddress é descrito aqui
documents
Array of objects
Informações de documentos do comprador. Obrigatório com o antifraude habilitado. O objetodocuments é descrito aqui
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.
session
String
Valor único que identifica a sessão do usuário acessando o site
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.

Segue abaixo um exemplo de objeto de resposta.

{
    "object": "transaction",
    "status": "paid",
    "refuse_reason": null,
    "status_reason": "acquirer",
    "acquirer_response_code": "0000",
    "acquirer_name": "pagarme",
    "acquirer_id": "5969170917bce0470c8bf099",
    "authorization_code": "65208",
    "soft_descriptor": null,
    "tid": 1830855,
    "nsu": 1830855,
    "date_created": "2017-08-14T20:35:46.046Z",
    "date_updated": "2017-08-14T20:35:46.455Z",
    "amount": 10000,
    "authorized_amount": 10000,
    "paid_amount": 10000,
    "refunded_amount": 0,
    "installments": 1,
    "id": 1830855,
    "cost": 50,
    "card_holder_name": "Morpheus Fishburne",
    "card_last_digits": "1111",
    "card_first_digits": "411111",
    "card_brand": "visa",
    "card_pin_mode": null,
    "postback_url": null,
    "payment_method": "credit_card",
    "capture_method": "ecommerce",
    "antifraud_score": null,
    "boleto_url": null,
    "boleto_barcode": null,
    "boleto_expiration_date": null,
    "referer": "api_key",
    "ip": "10.2.11.17",
    "subscription_id": null,
    "phone": null,
    "address": null,
    "customer": {
        "object": "customer",
        "id": 233238,
        "external_id": "#3311",
        "type": "individual",
        "country": "br",
        "document_number": null,
        "document_type": "cpf",
        "name": "Morpheus Fishburne",
        "email": "[email protected]",
        "phone_numbers": [
            "+5511999998888",
            "+5511888889999"
        ],
        "born_at": null,
        "birthday": "1965-01-01",
        "gender": null,
        "date_created": "2017-08-14T20:35:45.963Z",
        "documents": [
            {
                "object": "document",
                "id": "doc_cj6cmcm2l01z5696dyamemdnf",
                "type": "cpf",
                "number": "00000000000"
            }
        ]
    },
    "billing": {
        "address": {
            "object": "address",
            "street": "Rua Matrix",
            "complementary": null,
            "street_number": "9999",
            "neighborhood": "Rio Cotia",
            "city": "Cotia",
            "state": "sp",
            "zipcode": "06714360",
            "country": "br",
            "id": 145818
        },
        "object": "billing",
        "id": 30,
        "name": "Trinity Moss"
    },
    "shipping": {
        "address": {
            "object": "address",
            "street": "Rua Matrix",
            "complementary": null,
            "street_number": "9999",
            "neighborhood": "Rio Cotia",
            "city": "Cotia",
            "state": "sp",
            "zipcode": "06714360",
            "country": "br",
            "id": 145819
        },
        "object": "shipping",
        "id": 25,
        "name": "Neo Reeves",
        "fee": 1000,
        "delivery_date": "2000-12-21",
        "expedited": true
    },
    "items": [
        {
            "object": "item",
            "id": "r123",
            "title": "Red pill",
            "unit_price": 10000,
            "quantity": 1,
            "category": null,
            "tangible": true,
            "venue": null,
            "date": null
        },
        {
            "object": "item",
            "id": "b123",
            "title": "Blue pill",
            "unit_price": 10000,
            "quantity": 1,
            "category": null,
            "tangible": true,
            "venue": null,
            "date": null
        }
    ],
    "card": {
        "object": "card",
        "id": "card_cj6cmcm4301z6696dt3wypskk",
        "date_created": "2017-08-14T20:35:46.036Z",
        "date_updated": "2017-08-14T20:35:46.524Z",
        "brand": "visa",
        "holder_name": "Morpheus Fishburne",
        "first_digits": "411111",
        "last_digits": "1111",
        "country": "UNITED STATES",
        "fingerprint": "3ace8040fba3f5c3a0690ea7964ea87d97123437",
        "valid": true,
        "expiration_date": "0922"
    },
    "split_rules": null,
    "metadata": {},
    "antifraud_metadata": {},
    "reference_key": null
}