Consulta uma transação
/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órioIdentificador público (tra_/trx_…)
Respostas
200Sucesso
idstringobrigatórioIdentificador público (tra_/trx_…)
netintegerobrigatórioO que você recebe:
amount − fees, em centavos.utmobjectobrigatóriopode ser nuloAtribuição de marketing da venda;
nullquando não há.+5 campos de
utmtermstringutm_term.mediumstringutm_medium.sourcestringutm_source.contentstringutm_content.campaignstringutm_campaign.
feesintegerobrigatórioTotal de taxas retidas, em centavos.
itemsobject[]obrigatóriopode ser nuloItens do carrinho;
nullquando a cobrança não teve itens.+14 campos de
itemsidstringobrigatórioIdentificador público (item_/tri_…)
namestringobrigatórioNome do item.
imagesstring[]obrigatóriopode ser nuloURLs das imagens do item;
nullquando não há.currencystringobrigatóriopode ser nuloMoeda (ISO 4217).
isUpsellbooleanobrigatóriopode ser nuloSe o item foi adicionado por uma oferta de upsell.
metadataanypode ser nuloOs seus metadados chave-valor do item;
nullquando não há.quantityintegerobrigatórioQuantidade.
createdAtstringobrigatóriopode ser nuloQuando o recurso foi criado (ISO 8601, UTC).
unitPriceintegerobrigatórioPreço unitário, em centavos.
updatedAtstringobrigatóriopode ser nuloQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
variantIdstringobrigatóriopode ser nuloA variante do catálogo;
nullnum item avulso.descriptionstringobrigatóriopode ser nuloDescrição do item.
isOrderbumpbooleanobrigatóriopode ser nuloSe o item foi adicionado por um order bump.
externalReferencestringobrigatóriopode ser nuloO seu próprio identificador do item;
nullquando não há.
_linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).amountintegerobrigatórioValor cobrado, em centavos (depois dos descontos).
methodstringobrigatórioMeio de pagamento.
Valores:creditpixbilletnupaysplitsobject[]obrigatóriopode ser nuloAs fatias desta cobrança destinadas a outras contas;
nullquando não há split.+10 campos de
splitsidstringobrigatóriopode ser nuloId do split.
amountintegerobrigatórioFatia líquida, em centavos.
createdAtstringobrigatóriopode ser nuloQuando o recurso foi criado (ISO 8601, UTC).
recipientstringobrigatóriopode ser nuloA conta que recebe a fatia.
updatedAtstringobrigatóriopode ser nuloQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
percentageum deobrigatóriopode ser nuloA fatia como percentual, quando foi definida assim.
string
number
receivablestringobrigatóriopode ser nuloO recebível criado para a fatia.
descriptionstringobrigatóriopode ser nuloDescrição.
grossAmountintegerobrigatórioFatia bruta, em centavos.
chargeProcessingFeebooleanobrigatóriopode ser nuloSe o recebedor paga a taxa de processamento da fatia.
statusstringobrigatórioStatus da cobrança. A criação é assíncrona: o desfecho chega por webhook.
Valores:pendingpre-authorizedapprovedfailedrefusedcanceledrefundedchargebackdisputefraud-reviewanalyzingawaitingbillingobjectobrigatórioBloco de cobrança.
+1 campo de
billingaddressobjectobrigatórioO endereço do pagador.
+19 campos de
addressidstringobrigatóriopode ser nuloId do endereço;
nullquando o endereço não foi salvo.citystringobrigatóriopode ser nuloCidade.
linestringobrigatóriopode ser nuloO endereço inteiro numa linha.
line1stringobrigatóriopode ser nuloPrimeira linha: logradouro e número.
line2stringobrigatóriopode ser nuloSegunda linha: bairro.
line3stringobrigatóriopode ser nuloTerceira linha: cidade, estado e CEP.
statestringobrigatóriopode ser nuloEstado (sigla de duas letras).
numberstringobrigatóriopode ser nuloNúmero.
streetstringobrigatóriopode ser nuloLogradouro.
countrystringobrigatóriopode ser nuloCódigo do país (ISO 3166-1).
ownerIdstringobrigatóriopode ser nuloId público do dono do endereço.
districtstringobrigatóriopode ser nuloBairro.
latitudeum deobrigatóriopode ser nuloLatitude;
nullquando desconhecida.string
number
postcodestringobrigatóriopode ser nuloCEP, só dígitos.
createdAtstringobrigatóriopode ser nuloQuando o recurso foi criado (ISO 8601, UTC).
longitudeum deobrigatóriopode ser nuloLongitude;
nullquando desconhecida.string
number
ownerTypestringobrigatóriopode ser nuloQuem é dono do endereço (
customer,company…).updatedAtstringobrigatóriopode ser nuloQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
complementstringobrigatóriopode ser nuloComplemento (apartamento, sala, bloco…).
paymentobjectobrigatórioComo a cobrança é paga: o código Pix, o boleto, o cartão usado, a recusa.
+25 campos de
paymentcardIdstringobrigatóriopode ser nuloId público (
card_…) do cartão que esta cobrança usou, quando ficou salvo no cliente — o mesmo queGET /v1/cardslista. Use-o para cobrar renovações compayment.card.id.nullsem cartão.paidAtstringobrigatóriopode ser nuloQuando a cobrança foi paga;
nullaté lá.refusedobjectobrigatóriopode ser nuloPor que a cobrança foi recusada;
nullquando não foi.+6 campos de
refusedcodestringobrigatórioCódigo estável da recusa — o valor para tratar no seu sistema.
Valores:insufficientFundsErrorexpiredCardErrorinvalidCardNumberinvalidExpiryMonthinvalidExpiryYearinvalidSecurityCodeinvalidPinCodeinvalidPaymentInformationcardDeclinedauthorizationRefusedcardCustomerNotAssociatedinvalidParameterssellerAuthorizationRefusedpaymentMethodUnavailablepixAutomaticNotDebitedcardValidationUnavailablepaymentProcessingErrortypestringobrigatórioFamília do erro:
cardError,invalidRequestErrorouprocessingError.Valores:cardErrorinvalidRequestErrorprocessingErrormessagestringobrigatórioMensagem técnica (em inglês).
categorystringobrigatóriopayment,validation,businessRuleouprocessing.Valores:paymentvalidationbusinessRuleprocessingreversiblebooleanobrigatórioSe o comprador pode tentar de novo (ex.: com outro cartão).
displayMessagestringobrigatórioMensagem segura para mostrar ao comprador (pt-BR).
versionstringobrigatórioVersão do objeto de pagamento.
Valores:1.1providerstringobrigatórioSempre
selectwin.Valores:selectwinreusablebooleanobrigatórioSe o pagamento pode ser reutilizado (hoje sempre
false).billetUrlstringobrigatóriopode ser nuloURL do boleto (PDF);
nullnos outros meios e até ser emitido.cardBrandstringobrigatóriopode ser nuloBandeira do cartão.
invoiceLinkstringobrigatóriopode ser nuloURL do comprovante hospedado desta cobrança (
pay.selectwin.io/r/…).nullna resposta da criação — preenchido na leitura e nos webhooks.installmentsintegerobrigatóriopode ser nuloNúmero de parcelas.
pixQrCodeEmvstringobrigatóriopode ser nuloCódigo copia e cola do Pix (EMV);
nullaté ser emitido.pixQrCodeUrlstringobrigatóriopode ser nuloURL da imagem do QR code do Pix.
billetBarcodestringobrigatóriopode ser nuloLinha digitável do boleto.
billetSequencestringobrigatóriopode ser nuloNúmero sequencial do boleto.
cardLastDigitsstringobrigatóriopode ser nuloQuatro últimos dígitos do cartão.
cardRegisteredbooleanobrigatórioSe o cartão foi salvo no cliente.
expirationDatestringobrigatóriopode ser nuloQuando o Pix ou o boleto expira;
nullem cartão.pixQrCodeImagestringobrigatóriopode ser nuloImagem do QR code do Pix (base64);
nullquando não disponível.cardFirstDigitsstringobrigatóriopode ser nuloSeis primeiros dígitos do cartão;
nullnos outros meios.invoicePathLinkstringobrigatóriopode ser nuloO mesmo comprovante, como caminho (
/r/{env}/{token}) para renderizar no seu próprio domínio.nullexatamente quandoinvoiceLinké.nupayPaymentUrlstringpode ser nuloNuPay: o link de aprovação no app do Nubank, para onde o comprador é enviado.
nullnos outros meios.allowRenewPaymentbooleanobrigatórioSe um novo Pix/boleto pode ser emitido para esta cobrança (
truenesses meios).billetDocumentNumberstringobrigatóriopode ser nuloNúmero do documento do boleto.
billetReferenceNumberstringobrigatóriopode ser nuloNúmero de referência do boleto.
acquirerTransactionNumberstringobrigatóriopode ser nuloNúmero da cobrança no provedor de pagamento (NSU).
refundsobject[]obrigatóriopode ser nuloOs estornos feitos nesta cobrança;
nullquando não há.+8 campos de
refundsidstringobrigatórioIdentificador público (void_/trf_/trr_…)
amountintegerobrigatórioValor estornado, em centavos.
categorystringobrigatóriopode ser nuloCategoria do estorno (ver
GET /v1/utils/types-of-refund).createdAtstringobrigatóriopode ser nuloQuando o recurso foi criado (ISO 8601, UTC).
receiptIdum deobrigatóriopode ser nuloComprovante do estorno.
string
number
updatedAtstringobrigatóriopode ser nuloQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
descriptionstringobrigatóriopode ser nuloPor que foi estornado.
observationsstringobrigatóriopode ser nuloObservações.
callbackobjectobrigatóriopode ser nuloWebhook só desta cobrança;
nullquando não há.+2 campos de
callbackactivebooleanobrigatóriopode ser nuloSe o webhook próprio está ativo.
webhookUrlstringobrigatóriopode ser nuloURL que recebe os webhooks desta cobrança.
currencystringobrigatórioMoeda (ISO 4217).
customIdstringobrigatóriopode ser nuloO seu id personalizado da cobrança: prefixo + base + sufixo, como configurado em
/v1/companies/configs;nullem cobranças antigas.customerobjectobrigatóriopode ser nuloO comprador;
nullquando não há.+15 campos de
customeridstringobrigatórioIdentificador público (cus_…)
emailstringobrigatóriopode ser nuloEndereço de e-mail;
nullquando não há.genderstringobrigatóriopode ser nuloGênero (
male,female,other);nullquando desconhecido.documentobjectobrigatórioDocumento do comprador.
+2 campos de
documenttypestringobrigatóriopode ser nuloTipo do documento;
nullquando não há.numberstringobrigatóriopode ser nuloNúmero do documento (dígitos em CPF/CNPJ);
nullquando não há.
lastNamestringobrigatóriopode ser nuloSobrenome.
metadataanypode ser nuloOs seus metadados chave-valor;
nullquando não há.availablebooleanobrigatóriopode ser nuloSe o cliente está ativo e pode ser cobrado.
birthdatestringobrigatóriopode ser nuloData de nascimento (
YYYY-MM-DD);nullquando desconhecida.createdAtstringobrigatóriopode ser nuloQuando o recurso foi criado (ISO 8601, UTC).
firstNamestringobrigatóriopode ser nuloNome.
telephoneobjectobrigatórioTelefone do comprador, em partes.
+4 campos de
telephonelinestringobrigatóriopode ser nuloO número inteiro com código do país e DDD.
numberstringobrigatóriopode ser nuloNúmero local.
areaCodestringobrigatóriopode ser nuloDDD.
countryCodestringobrigatóriopode ser nuloCódigo do país.
updatedAtstringobrigatóriopode ser nuloQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
delinquentbooleanobrigatóriopode ser nuloSe o cliente tem pagamentos em atraso.
additionalEmailsanypode ser nuloOutros e-mails do comprador;
nullquando não há.externalReferencestringobrigatóriopode ser nuloO seu próprio identificador deste cliente;
nullquando não há.
discountobjectobrigatóriopode ser nuloDesconto aplicado à cobrança;
nullquando não há.+3 campos de
discounttypestringobrigatórioflatoupercentage.valueintegerobrigatórioO desconto, em centavos.
percentageOfAmountnumberobrigatóriopode ser nuloO desconto como percentual do valor.
disputesobject[]obrigatóriopode ser nuloAs disputas desta cobrança;
nullquando não há.+19 campos de
disputesidstringobrigatóriopode ser nuloId da disputa.
reasonstringobrigatóriopode ser nuloPor que o comprador contestou.
statusstringobrigatóriopode ser nuloStatus da disputa.
outcomestringobrigatóriopode ser nuloComo terminou:
won(a cobrança volta a aprovada) oulost(chargeback);nullenquanto aberta.Valores:wonlostclosedAtstringobrigatóriopode ser nuloQuando foi encerrada;
nullenquanto aberta.deadlineobjectobrigatóriopode ser nuloO prazo das provas, derivado de
openedAt;nullquando a data de abertura é desconhecida.+4 campos de
deadlineurgentbooleanobrigatórioAinda defensável, mas perto do prazo.
expiredbooleanobrigatórioA janela fechou: provas enviadas agora não são mais aceitas.
deadlineAtstringobrigatóriopode ser nuloAté quando as provas são aceitas.
hoursRemainingnumberobrigatóriopode ser nuloHoras restantes para enviar as provas.
openedAtstringobrigatóriopode ser nuloQuando a disputa foi aberta.
createdAtstringobrigatóriopode ser nuloQuando o recurso foi criado (ISO 8601, UTC).
decidedAtstringobrigatóriopode ser nuloQuando foi decidida;
nullenquanto aberta.updatedAtstringobrigatóriopode ser nuloQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
reasonCodestringobrigatóriopode ser nuloCódigo do motivo na bandeira.
descriptionstringobrigatóriopode ser nuloO texto da sua defesa.
returnEmailstringobrigatóriopode ser nuloE-mail que recebe o desfecho.
deliveryProofanypode ser nuloProva de entrega que você anexou;
nullquando não há.shipmentProofanypode ser nuloProva de envio que você anexou;
nullquando não há.fiscalDocumentsanypode ser nuloDocumentos fiscais que você anexou;
nullquando não há.deliveryReceiptsanypode ser nuloComprovantes de entrega que você anexou;
nullquando não há.reasonDescriptionstringobrigatóriopode ser nuloDescrição do motivo.
communicationProofanypode ser nuloProva de comunicação que você anexou;
nullquando não há.
merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
metadataanypode ser nuloOs seus metadados chave-valor;
nullquando não há.shippinganypode ser nuloRetrato do frete, como enviado;
nullquando não há.spplitedbooleanobrigatórioSe a cobrança foi dividida com outras contas (ver
splits). O nome mantém a grafia histórica.timelineobject[]obrigatórioHistórico da cobrança (mudanças de status e notas), do mais antigo ao mais novo.
+6 campos de
timelineidstringobrigatóriopode ser nuloId da entrada.
typestringobrigatóriopode ser nuloTipo da entrada.
detailsstringobrigatóriopode ser nuloDetalhes da entrada.
messagestringobrigatóriopode ser nuloO que aconteceu.
createdAtstringobrigatóriopode ser nuloQuando o recurso foi criado (ISO 8601, UTC).
updatedAtstringobrigatóriopode ser nuloQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
discountsany[]obrigatóriopode ser nuloOs cupons aplicados;
nullquando não há.shippablebooleanobrigatórioSe a venda tem itens físicos para enviar.
updatedAtstringobrigatórioQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
receivablesobject[]obrigatóriopode ser nuloOs recebíveis desta cobrança, um por parcela e recebedor;
nullquando ainda não há.+19 campos de
receivablesidstringobrigatóriopode ser nuloId do recebível (
rec_…).splitstringobrigatóriopode ser nuloO split de que vem;
nullquando é seu.amountintegerobrigatórioValor líquido, em centavos.
liablebooleanobrigatóriopode ser nuloSe este recebedor arca com os chargebacks dele.
paidAtstringobrigatóriopode ser nuloQuando foi liberado ao recebedor;
nullaté lá.statusstringobrigatóriopode ser nuloStatus do recebível.
currencystringobrigatóriopode ser nuloMoeda (ISO 4217).
createdAtstringobrigatóriopode ser nuloQuando o recurso foi criado (ISO 8601, UTC).
recipientstringobrigatóriopode ser nuloA conta que o recebe.
updatedAtstringobrigatóriopode ser nuloQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
canceledAtstringobrigatóriopode ser nuloQuando foi cancelado;
nullquando não foi.expectedOnstringobrigatóriopode ser nuloData prevista de liberação.
refundedAtstringobrigatóriopode ser nuloQuando foi estornado;
nullquando não foi.descriptionstringobrigatóriopode ser nuloDescrição.
grossAmountintegerobrigatórioValor bruto, em centavos.
anticipationFeeintegerobrigatóriopode ser nuloTaxa cobrada para antecipá-lo, em centavos;
nullquando não foi antecipado.authorizationCodestringobrigatóriopode ser nuloCódigo de autorização da cobrança.
installmentNumberintegerobrigatóriopode ser nuloNúmero da parcela a que pertence.
chargeProcessingFeebooleanobrigatóriopode ser nuloSe este recebedor paga a taxa de processamento.
paymentGroupobjectpode ser nuloPagamento combinado: esta cobrança é UMA PARTE de um pedido pago com dois cartões ou cartão + Pix.
null= venda comum.+8 campos de
paymentGroupidstringobrigatórioId do pedido (o grupo de pagamento).
methodstringobrigatóriodualcredit(dois cartões) oucreditpix(cartão + Pix).Valores:dualcreditcreditpixstatusstringobrigatórioStatus do pedido inteiro — feche o pedido por ele, nunca por uma parte.
Valores:authorizingawaiting_retryawaiting_pixcapturingpaidcompensatingfailedcanceledneeds_reviewlegCountintegerobrigatórioNúmero de partes do pedido.
legIndexintegerobrigatórioPosição desta parte no pedido (a partir de 0).
isPrimarybooleanobrigatórioSe é a parte principal do pedido.
totalAmountintegerobrigatórioTotal do pedido, em centavos.
transactionIdsstring[]A cobrança atual de cada parte do pedido, na ordem das partes (esta inclusa).
originalAmountintegerobrigatórioValor antes dos descontos, em centavos.
processingTimeMsintegerobrigatóriopode ser nuloTempo da criação até o primeiro resultado do pagamento, em milissegundos;
nullaté lá.externalReferencestringobrigatóriopode ser nuloO seu próprio identificador da cobrança;
nullquando não há.
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório