SelectwinSelectwin

Consulta uma transação

GET/v1/transactions/{transactionId}

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros do caminho

  • transactionIdstringobrigatório

    Identificador público (tra_/trx_…)

Respostas

200Sucesso
  • idstringobrigatório

    Identificador público (tra_/trx_…)

  • netintegerobrigatório

    O que você recebe: amount − fees, em centavos.

  • utmobjectobrigatóriopode ser nulo

    Atribuição de marketing da venda; null quando não há.

    +5 campos de utm
    • termstring

      utm_term.

    • mediumstring

      utm_medium.

    • sourcestring

      utm_source.

    • contentstring

      utm_content.

    • campaignstring

      utm_campaign.

  • feesintegerobrigatório

    Total de taxas retidas, em centavos.

  • itemsobject[]obrigatóriopode ser nulo

    Itens do carrinho; null quando a cobrança não teve itens.

    +14 campos de items
    • idstringobrigatório

      Identificador público (item_/tri_…)

    • namestringobrigatório

      Nome do item.

    • imagesstring[]obrigatóriopode ser nulo

      URLs das imagens do item; null quando não há.

    • currencystringobrigatóriopode ser nulo

      Moeda (ISO 4217).

    • isUpsellbooleanobrigatóriopode ser nulo

      Se o item foi adicionado por uma oferta de upsell.

    • metadataanypode ser nulo

      Os seus metadados chave-valor do item; null quando não há.

    • quantityintegerobrigatório

      Quantidade.

    • createdAtstringobrigatóriopode ser nulo

      Quando o recurso foi criado (ISO 8601, UTC).

    • unitPriceintegerobrigatório

      Preço unitário, em centavos.

    • updatedAtstringobrigatóriopode ser nulo

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • variantIdstringobrigatóriopode ser nulo

      A variante do catálogo; null num item avulso.

    • descriptionstringobrigatóriopode ser nulo

      Descrição do item.

    • isOrderbumpbooleanobrigatóriopode ser nulo

      Se o item foi adicionado por um order bump.

    • externalReferencestringobrigatóriopode ser nulo

      O seu próprio identificador do item; null quando não há.

  • _linksobject

    Links para operações relacionadas, por ação (self, create, update, delete, list…).

  • amountintegerobrigatório

    Valor cobrado, em centavos (depois dos descontos).

  • methodstringobrigatório

    Meio de pagamento.

    Valores:creditpixbilletnupay
  • splitsobject[]obrigatóriopode ser nulo

    As fatias desta cobrança destinadas a outras contas; null quando não há split.

    +10 campos de splits
    • idstringobrigatóriopode ser nulo

      Id do split.

    • amountintegerobrigatório

      Fatia líquida, em centavos.

    • createdAtstringobrigatóriopode ser nulo

      Quando o recurso foi criado (ISO 8601, UTC).

    • recipientstringobrigatóriopode ser nulo

      A conta que recebe a fatia.

    • updatedAtstringobrigatóriopode ser nulo

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • percentageum deobrigatóriopode ser nulo

      A fatia como percentual, quando foi definida assim.

      string
      number
    • receivablestringobrigatóriopode ser nulo

      O recebível criado para a fatia.

    • descriptionstringobrigatóriopode ser nulo

      Descrição.

    • grossAmountintegerobrigatório

      Fatia bruta, em centavos.

    • chargeProcessingFeebooleanobrigatóriopode ser nulo

      Se o recebedor paga a taxa de processamento da fatia.

  • statusstringobrigatório

    Status da cobrança. A criação é assíncrona: o desfecho chega por webhook.

    Valores:pendingpre-authorizedapprovedfailedrefusedcanceledrefundedchargebackdisputefraud-reviewanalyzingawaiting
  • billingobjectobrigatório

    Bloco de cobrança.

    +1 campo de billing
    • addressobjectobrigatório

      O endereço do pagador.

      +19 campos de address
      • idstringobrigatóriopode ser nulo

        Id do endereço; null quando o endereço não foi salvo.

      • citystringobrigatóriopode ser nulo

        Cidade.

      • linestringobrigatóriopode ser nulo

        O endereço inteiro numa linha.

      • line1stringobrigatóriopode ser nulo

        Primeira linha: logradouro e número.

      • line2stringobrigatóriopode ser nulo

        Segunda linha: bairro.

      • line3stringobrigatóriopode ser nulo

        Terceira linha: cidade, estado e CEP.

      • statestringobrigatóriopode ser nulo

        Estado (sigla de duas letras).

      • numberstringobrigatóriopode ser nulo

        Número.

      • streetstringobrigatóriopode ser nulo

        Logradouro.

      • countrystringobrigatóriopode ser nulo

        Código do país (ISO 3166-1).

      • ownerIdstringobrigatóriopode ser nulo

        Id público do dono do endereço.

      • districtstringobrigatóriopode ser nulo

        Bairro.

      • latitudeum deobrigatóriopode ser nulo

        Latitude; null quando desconhecida.

        string
        number
      • postcodestringobrigatóriopode ser nulo

        CEP, só dígitos.

      • createdAtstringobrigatóriopode ser nulo

        Quando o recurso foi criado (ISO 8601, UTC).

      • longitudeum deobrigatóriopode ser nulo

        Longitude; null quando desconhecida.

        string
        number
      • ownerTypestringobrigatóriopode ser nulo

        Quem é dono do endereço (customer, company…).

      • updatedAtstringobrigatóriopode ser nulo

        Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

      • complementstringobrigatóriopode ser nulo

        Complemento (apartamento, sala, bloco…).

  • paymentobjectobrigatório

    Como a cobrança é paga: o código Pix, o boleto, o cartão usado, a recusa.

    +25 campos de payment
    • cardIdstringobrigatóriopode ser nulo

      Id público (card_…) do cartão que esta cobrança usou, quando ficou salvo no cliente — o mesmo que GET /v1/cards lista. Use-o para cobrar renovações com payment.card.id. null sem cartão.

    • paidAtstringobrigatóriopode ser nulo

      Quando a cobrança foi paga; null até lá.

    • refusedobjectobrigatóriopode ser nulo

      Por que a cobrança foi recusada; null quando não foi.

      +6 campos de refused
      • codestringobrigatório

        Código estável da recusa — o valor para tratar no seu sistema.

        Valores:insufficientFundsErrorexpiredCardErrorinvalidCardNumberinvalidExpiryMonthinvalidExpiryYearinvalidSecurityCodeinvalidPinCodeinvalidPaymentInformationcardDeclinedauthorizationRefusedcardCustomerNotAssociatedinvalidParameterssellerAuthorizationRefusedpaymentMethodUnavailablepixAutomaticNotDebitedcardValidationUnavailablepaymentProcessingError
      • typestringobrigatório

        Família do erro: cardError, invalidRequestError ou processingError.

        Valores:cardErrorinvalidRequestErrorprocessingError
      • messagestringobrigatório

        Mensagem técnica (em inglês).

      • categorystringobrigatório

        payment, validation, businessRule ou processing.

        Valores:paymentvalidationbusinessRuleprocessing
      • reversiblebooleanobrigatório

        Se o comprador pode tentar de novo (ex.: com outro cartão).

      • displayMessagestringobrigatório

        Mensagem segura para mostrar ao comprador (pt-BR).

    • versionstringobrigatório

      Versão do objeto de pagamento.

      Valores:1.1
    • providerstringobrigatório

      Sempre selectwin.

      Valores:selectwin
    • reusablebooleanobrigatório

      Se o pagamento pode ser reutilizado (hoje sempre false).

    • billetUrlstringobrigatóriopode ser nulo

      URL do boleto (PDF); null nos outros meios e até ser emitido.

    • cardBrandstringobrigatóriopode ser nulo

      Bandeira do cartão.

    • invoiceLinkstringobrigatóriopode ser nulo

      URL do comprovante hospedado desta cobrança (pay.selectwin.io/r/…). null na resposta da criação — preenchido na leitura e nos webhooks.

    • installmentsintegerobrigatóriopode ser nulo

      Número de parcelas.

    • pixQrCodeEmvstringobrigatóriopode ser nulo

      Código copia e cola do Pix (EMV); null até ser emitido.

    • pixQrCodeUrlstringobrigatóriopode ser nulo

      URL da imagem do QR code do Pix.

    • billetBarcodestringobrigatóriopode ser nulo

      Linha digitável do boleto.

    • billetSequencestringobrigatóriopode ser nulo

      Número sequencial do boleto.

    • cardLastDigitsstringobrigatóriopode ser nulo

      Quatro últimos dígitos do cartão.

    • cardRegisteredbooleanobrigatório

      Se o cartão foi salvo no cliente.

    • expirationDatestringobrigatóriopode ser nulo

      Quando o Pix ou o boleto expira; null em cartão.

    • pixQrCodeImagestringobrigatóriopode ser nulo

      Imagem do QR code do Pix (base64); null quando não disponível.

    • cardFirstDigitsstringobrigatóriopode ser nulo

      Seis primeiros dígitos do cartão; null nos outros meios.

    • invoicePathLinkstringobrigatóriopode ser nulo

      O mesmo comprovante, como caminho (/r/{env}/{token}) para renderizar no seu próprio domínio. null exatamente quando invoiceLink é.

    • nupayPaymentUrlstringpode ser nulo

      NuPay: o link de aprovação no app do Nubank, para onde o comprador é enviado. null nos outros meios.

    • allowRenewPaymentbooleanobrigatório

      Se um novo Pix/boleto pode ser emitido para esta cobrança (true nesses meios).

    • billetDocumentNumberstringobrigatóriopode ser nulo

      Número do documento do boleto.

    • billetReferenceNumberstringobrigatóriopode ser nulo

      Número de referência do boleto.

    • acquirerTransactionNumberstringobrigatóriopode ser nulo

      Número da cobrança no provedor de pagamento (NSU).

  • refundsobject[]obrigatóriopode ser nulo

    Os estornos feitos nesta cobrança; null quando não há.

    +8 campos de refunds
    • idstringobrigatório

      Identificador público (void_/trf_/trr_…)

    • amountintegerobrigatório

      Valor estornado, em centavos.

    • categorystringobrigatóriopode ser nulo

      Categoria do estorno (ver GET /v1/utils/types-of-refund).

    • createdAtstringobrigatóriopode ser nulo

      Quando o recurso foi criado (ISO 8601, UTC).

    • receiptIdum deobrigatóriopode ser nulo

      Comprovante do estorno.

      string
      number
    • updatedAtstringobrigatóriopode ser nulo

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • descriptionstringobrigatóriopode ser nulo

      Por que foi estornado.

    • observationsstringobrigatóriopode ser nulo

      Observações.

  • callbackobjectobrigatóriopode ser nulo

    Webhook só desta cobrança; null quando não há.

    +2 campos de callback
    • activebooleanobrigatóriopode ser nulo

      Se o webhook próprio está ativo.

    • webhookUrlstringobrigatóriopode ser nulo

      URL que recebe os webhooks desta cobrança.

  • currencystringobrigatório

    Moeda (ISO 4217).

  • customIdstringobrigatóriopode ser nulo

    O seu id personalizado da cobrança: prefixo + base + sufixo, como configurado em /v1/companies/configs; null em cobranças antigas.

  • customerobjectobrigatóriopode ser nulo

    O comprador; null quando não há.

    +15 campos de customer
    • idstringobrigatório

      Identificador público (cus_…)

    • emailstringobrigatóriopode ser nulo

      Endereço de e-mail; null quando não há.

    • genderstringobrigatóriopode ser nulo

      Gênero (male, female, other); null quando desconhecido.

    • documentobjectobrigatório

      Documento do comprador.

      +2 campos de document
      • typestringobrigatóriopode ser nulo

        Tipo do documento; null quando não há.

      • numberstringobrigatóriopode ser nulo

        Número do documento (dígitos em CPF/CNPJ); null quando não há.

    • lastNamestringobrigatóriopode ser nulo

      Sobrenome.

    • metadataanypode ser nulo

      Os seus metadados chave-valor; null quando não há.

    • availablebooleanobrigatóriopode ser nulo

      Se o cliente está ativo e pode ser cobrado.

    • birthdatestringobrigatóriopode ser nulo

      Data de nascimento (YYYY-MM-DD); null quando desconhecida.

    • createdAtstringobrigatóriopode ser nulo

      Quando o recurso foi criado (ISO 8601, UTC).

    • firstNamestringobrigatóriopode ser nulo

      Nome.

    • telephoneobjectobrigatório

      Telefone do comprador, em partes.

      +4 campos de telephone
      • linestringobrigatóriopode ser nulo

        O número inteiro com código do país e DDD.

      • numberstringobrigatóriopode ser nulo

        Número local.

      • areaCodestringobrigatóriopode ser nulo

        DDD.

      • countryCodestringobrigatóriopode ser nulo

        Código do país.

    • updatedAtstringobrigatóriopode ser nulo

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • delinquentbooleanobrigatóriopode ser nulo

      Se o cliente tem pagamentos em atraso.

    • additionalEmailsanypode ser nulo

      Outros e-mails do comprador; null quando não há.

    • externalReferencestringobrigatóriopode ser nulo

      O seu próprio identificador deste cliente; null quando não há.

  • discountobjectobrigatóriopode ser nulo

    Desconto aplicado à cobrança; null quando não há.

    +3 campos de discount
    • typestringobrigatório

      flat ou percentage.

    • valueintegerobrigatório

      O desconto, em centavos.

    • percentageOfAmountnumberobrigatóriopode ser nulo

      O desconto como percentual do valor.

  • disputesobject[]obrigatóriopode ser nulo

    As disputas desta cobrança; null quando não há.

    +19 campos de disputes
    • idstringobrigatóriopode ser nulo

      Id da disputa.

    • reasonstringobrigatóriopode ser nulo

      Por que o comprador contestou.

    • statusstringobrigatóriopode ser nulo

      Status da disputa.

    • outcomestringobrigatóriopode ser nulo

      Como terminou: won (a cobrança volta a aprovada) ou lost (chargeback); null enquanto aberta.

      Valores:wonlost
    • closedAtstringobrigatóriopode ser nulo

      Quando foi encerrada; null enquanto aberta.

    • deadlineobjectobrigatóriopode ser nulo

      O prazo das provas, derivado de openedAt; null quando a data de abertura é desconhecida.

      +4 campos de deadline
      • urgentbooleanobrigatório

        Ainda defensável, mas perto do prazo.

      • expiredbooleanobrigatório

        A janela fechou: provas enviadas agora não são mais aceitas.

      • deadlineAtstringobrigatóriopode ser nulo

        Até quando as provas são aceitas.

      • hoursRemainingnumberobrigatóriopode ser nulo

        Horas restantes para enviar as provas.

    • openedAtstringobrigatóriopode ser nulo

      Quando a disputa foi aberta.

    • createdAtstringobrigatóriopode ser nulo

      Quando o recurso foi criado (ISO 8601, UTC).

    • decidedAtstringobrigatóriopode ser nulo

      Quando foi decidida; null enquanto aberta.

    • updatedAtstringobrigatóriopode ser nulo

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • reasonCodestringobrigatóriopode ser nulo

      Código do motivo na bandeira.

    • descriptionstringobrigatóriopode ser nulo

      O texto da sua defesa.

    • returnEmailstringobrigatóriopode ser nulo

      E-mail que recebe o desfecho.

    • deliveryProofanypode ser nulo

      Prova de entrega que você anexou; null quando não há.

    • shipmentProofanypode ser nulo

      Prova de envio que você anexou; null quando não há.

    • fiscalDocumentsanypode ser nulo

      Documentos fiscais que você anexou; null quando não há.

    • deliveryReceiptsanypode ser nulo

      Comprovantes de entrega que você anexou; null quando não há.

    • reasonDescriptionstringobrigatóriopode ser nulo

      Descrição do motivo.

    • communicationProofanypode ser nulo

      Prova de comunicação que você anexou; null quando não há.

  • merchantobject

    A conta dona do recurso (o vendedor de registro).

    +3 campos de merchant
    • namestringobrigatóriopode ser nulo

      Nome fantasia da conta dona do recurso.

    • merchantIdstringobrigatóriopode ser nulo

      Id público da conta dona do recurso (bus_…).

    • isSubAccountbooleanobrigatório

      true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.

  • metadataanypode ser nulo

    Os seus metadados chave-valor; null quando não há.

  • shippinganypode ser nulo

    Retrato do frete, como enviado; null quando não há.

  • spplitedbooleanobrigatório

    Se a cobrança foi dividida com outras contas (ver splits). O nome mantém a grafia histórica.

  • timelineobject[]obrigatório

    Histórico da cobrança (mudanças de status e notas), do mais antigo ao mais novo.

    +6 campos de timeline
    • idstringobrigatóriopode ser nulo

      Id da entrada.

    • typestringobrigatóriopode ser nulo

      Tipo da entrada.

    • detailsstringobrigatóriopode ser nulo

      Detalhes da entrada.

    • messagestringobrigatóriopode ser nulo

      O que aconteceu.

    • createdAtstringobrigatóriopode ser nulo

      Quando o recurso foi criado (ISO 8601, UTC).

    • updatedAtstringobrigatóriopode ser nulo

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

  • createdAtstringobrigatório

    Quando o recurso foi criado (ISO 8601, UTC).

  • discountsany[]obrigatóriopode ser nulo

    Os cupons aplicados; null quando não há.

  • shippablebooleanobrigatório

    Se a venda tem itens físicos para enviar.

  • updatedAtstringobrigatório

    Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

  • receivablesobject[]obrigatóriopode ser nulo

    Os recebíveis desta cobrança, um por parcela e recebedor; null quando ainda não há.

    +19 campos de receivables
    • idstringobrigatóriopode ser nulo

      Id do recebível (rec_…).

    • splitstringobrigatóriopode ser nulo

      O split de que vem; null quando é seu.

    • amountintegerobrigatório

      Valor líquido, em centavos.

    • liablebooleanobrigatóriopode ser nulo

      Se este recebedor arca com os chargebacks dele.

    • paidAtstringobrigatóriopode ser nulo

      Quando foi liberado ao recebedor; null até lá.

    • statusstringobrigatóriopode ser nulo

      Status do recebível.

    • currencystringobrigatóriopode ser nulo

      Moeda (ISO 4217).

    • createdAtstringobrigatóriopode ser nulo

      Quando o recurso foi criado (ISO 8601, UTC).

    • recipientstringobrigatóriopode ser nulo

      A conta que o recebe.

    • updatedAtstringobrigatóriopode ser nulo

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • canceledAtstringobrigatóriopode ser nulo

      Quando foi cancelado; null quando não foi.

    • expectedOnstringobrigatóriopode ser nulo

      Data prevista de liberação.

    • refundedAtstringobrigatóriopode ser nulo

      Quando foi estornado; null quando não foi.

    • descriptionstringobrigatóriopode ser nulo

      Descrição.

    • grossAmountintegerobrigatório

      Valor bruto, em centavos.

    • anticipationFeeintegerobrigatóriopode ser nulo

      Taxa cobrada para antecipá-lo, em centavos; null quando não foi antecipado.

    • authorizationCodestringobrigatóriopode ser nulo

      Código de autorização da cobrança.

    • installmentNumberintegerobrigatóriopode ser nulo

      Número da parcela a que pertence.

    • chargeProcessingFeebooleanobrigatóriopode ser nulo

      Se este recebedor paga a taxa de processamento.

  • paymentGroupobjectpode ser nulo

    Pagamento combinado: esta cobrança é UMA PARTE de um pedido pago com dois cartões ou cartão + Pix. null = venda comum.

    +8 campos de paymentGroup
    • idstringobrigatório

      Id do pedido (o grupo de pagamento).

    • methodstringobrigatório

      dualcredit (dois cartões) ou creditpix (cartão + Pix).

      Valores:dualcreditcreditpix
    • statusstringobrigatório

      Status do pedido inteiro — feche o pedido por ele, nunca por uma parte.

      Valores:authorizingawaiting_retryawaiting_pixcapturingpaidcompensatingfailedcanceledneeds_review
    • legCountintegerobrigatório

      Número de partes do pedido.

    • legIndexintegerobrigatório

      Posição desta parte no pedido (a partir de 0).

    • isPrimarybooleanobrigatório

      Se é a parte principal do pedido.

    • totalAmountintegerobrigatório

      Total do pedido, em centavos.

    • transactionIdsstring[]

      A cobrança atual de cada parte do pedido, na ordem das partes (esta inclusa).

  • originalAmountintegerobrigatório

    Valor antes dos descontos, em centavos.

  • processingTimeMsintegerobrigatóriopode ser nulo

    Tempo da criação até o primeiro resultado do pagamento, em milissegundos; null até lá.

  • externalReferencestringobrigatóriopode ser nulo

    O seu próprio identificador da cobrança; null quando não há.

401Não autenticado (credencial ausente ou inválida)
  • errorobjectobrigatório
    +8 campos de error
    • codestringobrigatório
    • paramsobject[]
    • statusstringobrigatório
    • detailsstring
    • messagestringobrigatório
    • categorystringobrigatório
      Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
    • resourcestringobrigatório
    • statusCodeintegerobrigatório
403Sem permissão
  • errorobjectobrigatório
    +8 campos de error
    • codestringobrigatório
    • paramsobject[]
    • statusstringobrigatório
    • detailsstring
    • messagestringobrigatório
    • categorystringobrigatório
      Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
    • resourcestringobrigatório
    • statusCodeintegerobrigatório
404Não encontrado
  • errorobjectobrigatório
    +8 campos de error
    • codestringobrigatório
    • paramsobject[]
    • statusstringobrigatório
    • detailsstring
    • messagestringobrigatório
    • categorystringobrigatório
      Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
    • resourcestringobrigatório
    • statusCodeintegerobrigatório
500Erro interno do servidor
  • errorobjectobrigatório
    +8 campos de error
    • codestringobrigatório
    • paramsobject[]
    • statusstringobrigatório
    • detailsstring
    • messagestringobrigatório
    • categorystringobrigatório
      Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
    • resourcestringobrigatório
    • statusCodeintegerobrigatório

Preferências de cookies

Hoje o site usa só cookies essenciais: nenhuma ferramenta de medição ou de anúncios está ligada, e nada é compartilhado com terceiros. Se isso mudar, você decide aqui antes de qualquer coisa ser carregada.

  • Mantêm o site funcionando: segurança, a sua escolha sobre cookies e preferências como a versão da documentação. Não dependem de consentimento.

    Sempre ativos