Transações

Consultar uma transação

Este endpoint retorna os detalhes completos de uma transação: status atual, dados de pagamento, cliente, itens, recebíveis, splits, reembolsos, disputas e a timeline de eventos. É essencial para acomp

Visão Geral

Este endpoint retorna os detalhes completos de uma transação: status atual, dados de pagamento, cliente, itens, recebíveis, splits, reembolsos, disputas e a timeline de eventos. É essencial para acompanhar o ciclo de vida da transação, reconciliar pagamentos e dar suporte ao cliente.

Precauções

  • O ID da transação é sensível a maiúsculas e minúsculas. São aceitos os prefixos tra_ e trx_.
  • Apenas os primeiros e últimos dígitos do cartão são retornados; o CVV nunca é armazenado nem retornado.

Requisição

GET /v1/transactions/{transactionId}

Parâmetros de URL

ParâmetroTipoObrigatórioDescrição
transactionIdstringSimIdentificador da transação (tra_... ou trx_...)

Resposta

Sucesso (HTTP 200 OK)

{
  "id": "tra_987654321",
  "customId": "E5D4C3B2A1",
  "amount": 10000,
  "originalAmount": 10000,
  "status": "approved",
  "method": "credit",
  "currency": "BRL",
  "payment": {
    "provider": "selectwin",
    "version": "1.1",
    "refused": null,
    "reusable": false,
    "billetUrl": null,
    "billetBarcode": null,
    "billetSequence": null,
    "billetDocumentNumber": null,
    "billetReferenceNumber": null,
    "pixQrCodeEmv": null,
    "pixQrCodeUrl": null,
    "pixQrCodeImage": null,
    "acquirerTransactionNumber": "9876543210987654321098765432",
    "cardFirstDigits": "553121",
    "cardLastDigits": "4567",
    "cardBrand": "Mastercard",
    "cardRegistered": true,
    "installments": 3,
    "expirationDate": null,
    "paidAt": "2026-06-15T14:30:50.000Z",
    "allowRenewPayment": false,
    "invoiceLink": "https://selectwin.io/invoices/tra_987654321"
  },
  "discount": null,
  "discounts": null,
  "customer": {
    "id": "cus_123456789",
    "firstName": "João",
    "lastName": "Silva",
    "email": "[email protected]",
    "birthdate": "1980-01-15",
    "gender": "male",
    "document": { "type": "cpf", "number": "12345678900" },
    "telephone": {
      "countryCode": "55",
      "areaCode": "11",
      "number": "987654321",
      "line": "5511987654321"
    },
    "available": true,
    "delinquent": false,
    "externalReference": "CUS_REF_123",
    "additionalEmails": ["[email protected]"],
    "metadata": { "segment": "regular" },
    "updatedAt": "2026-06-15T14:00:30.000Z",
    "createdAt": "2026-06-10T09:15:25.000Z"
  },
  "billing": {
    "address": {
      "id": "addr_123456789",
      "ownerId": "cus_123456789",
      "ownerType": "customer",
      "street": "Rua Exemplo",
      "number": "123",
      "complement": "Apto 45",
      "district": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "postcode": "01234567",
      "country": "BR",
      "latitude": null,
      "longitude": null,
      "line": "Rua Exemplo, 123 - Apto 45, Centro, São Paulo - SP, 01234567, BR",
      "line1": "Rua Exemplo, 123",
      "line2": "Apto 45",
      "line3": "Centro",
      "updatedAt": "2026-06-15T14:00:30.745Z",
      "createdAt": "2026-06-15T14:00:30.000Z"
    }
  },
  "shipping": null,
  "externalReference": "PEDIDO-123",
  "shippable": true,
  "spplited": false,
  "items": [
    {
      "id": "item_123456789",
      "name": "Produto A",
      "unitPrice": 5000,
      "quantity": 2,
      "currency": "BRL",
      "description": "Descrição detalhada do produto A",
      "images": ["https://selectwin.io/assets/product_a_1.png"],
      "isUpsell": false,
      "isOrderbump": false,
      "metadata": { "sku": "PROD-A-001" },
      "variantId": null,
      "externalReference": null,
      "updatedAt": "2026-06-15T14:30:45.000Z",
      "createdAt": "2026-06-15T14:30:45.000Z"
    }
  ],
  "receivables": [
    {
      "id": "rec_123456781",
      "recipient": "bus_123456789",
      "split": null,
      "status": "paid",
      "amount": 3334,
      "grossAmount": 3334,
      "anticipationFee": 0,
      "installmentNumber": 1,
      "description": null,
      "currency": "BRL",
      "authorizationCode": "AUTH123456",
      "paidAt": "2026-06-15T14:30:50.000Z",
      "refundedAt": null,
      "canceledAt": null,
      "expectedOn": "2026-07-15T14:30:50.000Z",
      "liable": true,
      "chargeProcessingFee": true,
      "updatedAt": "2026-06-15T14:30:50.000Z",
      "createdAt": "2026-06-15T14:30:45.000Z"
    }
  ],
  "splits": null,
  "refunds": null,
  "disputes": null,
  "timeline": [
    {
      "id": "tl_123",
      "message": "Transaction approved",
      "details": null,
      "type": "status_change",
      "updatedAt": "2026-06-15T14:23:45.000Z",
      "createdAt": "2026-06-15T14:23:45.000Z"
    }
  ],
  "callback": {
    "webhookUrl": "https://meucomercio.com.br/webhook/notifications",
    "active": true
  },
  "metadata": { "source": "web_store", "campaign": "promo_inverno" },
  "processingTimeMs": 5523,
  "updatedAt": "2026-06-15T14:31:15.000Z",
  "createdAt": "2026-06-15T14:30:45.000Z",
  "merchant": {
    "name": "Seller Name",
    "merchantId": "bus_1234567890",
    "isSubAccount": false
  },
  "_links": {
    "self": {
      "href": "https://api.selectwin.io/v1/transactions/tra_987654321",
      "method": "GET",
      "description": "Read a transaction."
    },
    "refund": {
      "href": "https://api.selectwin.io/v1/transactions/tra_987654321/refund",
      "method": "POST",
      "description": "Refund the transaction."
    },
    "capture": {
      "href": "https://api.selectwin.io/v1/transactions/tra_987654321/capture",
      "method": "POST",
      "description": "Capture the transaction."
    }
  }
}

Atributos da Resposta

Atributos Principais

AtributoTipoDescrição
idstringIdentificador da transação (tra_* / trx_*)
customIdstring | nullIdentificador personalizado
amountintegerValor cobrado em centavos (após descontos)
originalAmountintegerValor original em centavos (antes de descontos)
statusstringStatus atual (ver Visão Geral)
methodstringMétodo: credit, pix ou billet
currencystringMoeda (BRL)

Objeto payment

Um único objeto que consolida os dados de cartão, boleto, PIX e adquirente. Campos não aplicáveis ao método vêm como null.

AtributoTipoDescrição
payment.providerstringSempre selectwin
payment.versionstringSempre 1.1
payment.cardFirstDigits / cardLastDigitsstring | nullBIN e últimos dígitos do cartão
payment.cardBrandstring | nullBandeira
payment.cardRegisteredbooleantrue quando a cobrança usou um cartão salvo
payment.installmentsinteger | nullNúmero de parcelas
payment.billetUrl / billetBarcode / billetSequence / billetDocumentNumber / billetReferenceNumberstring | nullDados do boleto
payment.pixQrCodeEmvstring | nullPayload EMV do QR Code PIX (use para renderizar o QR)
payment.pixQrCodeUrlstring | nullURL do PIX
payment.pixQrCodeImagenullSempre null (a API não gera imagem)
payment.acquirerTransactionNumberstring | nullIdentificador da transação no adquirente
payment.expirationDatestring | nullVencimento (boleto/pré-autorização)
payment.paidAtstring | nullData/hora da liquidação
payment.allowRenewPaymentbooleanPermite gerar novo pagamento (PIX/boleto)
payment.invoiceLinkstringLink da fatura
payment.reusablebooleanSempre false
payment.refusedobject | nullDetalhes de recusa, quando houver

Outros objetos

AtributoTipoDescrição
discountobject | nullBloco consolidado de desconto (value, type, percentageOfAmount)
discountsarray | nullCupons aplicados (source, couponId, code, type, value, appliedAmount)
customerobject | nullDados do comprador (sem as listas addresses/cards — use GET /v1/customers/:id)
billing.addressobjectEndereço de cobrança aninhado
itemsarray | nullItens da transação
receivablesarray | nullRecebíveis gerados
splitsarray | nullSplits de marketplace
refundsarray | nullReembolsos emitidos
disputesarray | nullDisputas e evidências
timelinearrayHistórico de eventos (id, message, details, type, createdAt, updatedAt)
callbackobject | nullwebhookUrl + active
metadataobject | nullMetadados
processingTimeMsinteger | nullTempo de processamento do nosso backend para esta cobrança, em milissegundos: de createdAt até o primeiro resultado do adquirente ser registrado (fila + cobrança no provedor + reconciliação). null enquanto o resultado não chega. Carimbado uma única vez, no primeiro resultado
merchantobjectname, merchantId, isSubAccount
_linksobjectself, refund, capture

Melhores Práticas

  1. Reaja a webhooks para mudanças de status em vez de consultar repetidamente este endpoint.
  2. Use a timeline para rastrear o progresso da transação.
  3. Armazene os _links para navegar entre as operações relacionadas.
  4. Trate adequadamente os diferentes estados que uma transação pode assumir.

How is this guide?

On this page