Adicionando a fonte de dados
Qual chave usar
- A Kondado apenas lê os dados da sua conta Stripe. Nada é criado nem alterado.
- Recomendado: chave restrita (começa com
rk_live_) com permissão Leitura nos recursos que você vai integrar. Se uma integração precisar de um recurso sem permissão, ela falha com uma mensagem que diz qual recurso liberar. - Também funciona a chave secreta (começa com
sk_live_). - A chave publicável (
pk_live_) não funciona: ela não lê dados. - Para integrar os dados do modo de teste do Stripe, use a chave do modo de teste (
sk_test_/rk_test_) num conector separado.
Como criar a chave restrita
- No Dashboard do Stripe, vá em Desenvolvedores → Chaves de API.
- Clique em Criar chave restrita e dê um nome (por exemplo, "Kondado").
- Marque Leitura em todos os recursos que você vai integrar (ou em todos).
- Clique em Criar chave e copie o valor (
rk_live_...).
Como conectar
- Na Kondado, adicione um novo conector Stripe.
- Cole a chave no campo Chave secreta ou restrita e salve. A Kondado testa a chave na hora.
- Pronto: agora é só criar as integrações desejadas.
Pipelines
Resumo
- Agendamentos de assinatura
- Alertas antecipados de fraude
- Alíquotas de imposto
- Assinaturas
- Assinaturas - Detalhes - Itens da assinatura
- Clientes
- Clientes - Detalhes - Identificações fiscais
- Clientes - Detalhes - Meios de pagamento
- Clientes - Detalhes - Transações de saldo do cliente
- Cobranças
- Concessões de crédito
- Contas conectadas (Connect)
- Contestações
- Cupons
- Códigos promocionais
- Eventos
- Faturas
- Faturas - Detalhes - Itens da fatura
- Funcionalidades (entitlements)
- Intenções de configuração (SetupIntents)
- Intenções de pagamento (PaymentIntents)
- Itens avulsos de fatura
- Links de pagamento
- Links de pagamento - Detalhes - Itens
- Listas do Radar
- Listas do Radar - Detalhes - Itens
- Medidores de uso (billing meters)
- Notas de crédito
- Notas de crédito - Detalhes - Itens
- Orçamentos
- Orçamentos - Detalhes - Itens
- Pagamentos de faturas
- Planos
- Preços
- Produtos
- Recargas de saldo (top-ups)
- Reembolsos
- Repasses (payouts)
- Repasses - Detalhes - Transações do repasse
- Revisões do Radar
- Saldo atual
- Sessões de checkout
- Sessões de checkout - Detalhes - Itens
- Sessões de verificação de identidade
- Tarifas de frete
- Taxas de aplicação
- Terminal - Leitores
- Terminal - Locais
- Transações de saldo
- Transferências
- Transferências - Detalhes - Estornos
Diagrama de relacionamento
Clique para expandir
Agendamentos de assinatura
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer → Clientes > id
- subscription → Assinaturas > id
- subscription_schedule_id > _subscription_schedules_def_invoic_account_tax_ids → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_def_invoice__custom_fields → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_metadata → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_pause_schedules → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_add_invoice_items → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_add_invoi_discounts → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_add_invoic_metadata → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_add_invoi_tax_rates → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_default_tax_rates → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_default_ta_metadata → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_discounts → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_inv_account_tax_ids → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_invoi_custom_fields → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_items → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_items_discounts → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_items_metadata → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_items_tax_rates → Agendamentos de assinatura > id
- subscription_schedule_id > _subscription_schedules_phases_metadata → Agendamentos de assinatura > id
Objeto principal
Agendamentos de assinatura: mudanças programadas (fases) de uma assinatura.
stripe_subscription_schedules_def_invoic_account_tax_ids
Agendamentos de assinatura: default_settings.invoice_settings.account_tax_ids (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os IDs fiscais da conta associados ao agendamento de assinatura. Serão definidos nas faturas geradas pelo agendamento de assinatura. |
stripe_subscription_schedules_def_invoice__custom_fields
Agendamentos de assinatura: default_settings.invoice_settings.custom_fields (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do campo personalizado. |
|
|
text |
[pt] O valor do campo personalizado. |
stripe_subscription_schedules_metadata
Agendamentos de assinatura: metadata (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_subscription_schedules_pause_schedules
Agendamentos de assinatura: pause_schedules (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Identificador único desta programação de pausa. |
|
|
timestamp |
[pt] Momento em que a assinatura é pausada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O tipo de comportamento de cobrança de uso pendente. Valores possíveis: none = sem tipo de conta; pause_at = a partir da data de pausa. |
|
|
text |
[pt] O tipo de comportamento de crédito de tempo não utilizado. Valores possíveis: item_current_period_start = início do período atual do item; none = sem tipo de conta; pause_at = a partir da data de pausa. |
|
|
text |
[pt] Determina como tratar débitos e créditos ao pausar. Valores possíveis: invoice = fatura créditos/débitos imediatamente; pending_invoice_item = deixa como item pendente para próxima fatura. |
|
|
text |
[pt] O tipo de configuração de pausa. Valores possíveis: subscription = pausa de assinatura. |
|
|
text |
[pt] Código de erro legível por máquina. |
|
|
text |
[pt] Descrição do erro. |
|
|
text |
[pt] O estado do ciclo de vida da operação de pausa. Valores possíveis: error = erro na retomada; scheduled = retomada agendada; succeeded = retomada concluída. |
|
|
timestamp |
[pt] Momento em que a assinatura é retomada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Âncora do ciclo de cobrança (billing cycle anchor) aplicada quando a assinatura é retomada. Valores possíveis: resume_at = âncora redefinida na retomada; unchanged = âncora de cobrança inalterada. |
|
|
text |
[pt] Controla se a Stripe tenta o pagamento na fatura de retomada e como isso afeta o status da assinatura. Valores possíveis: resume_on_payment_attempt = retoma ao tentar o pagamento; resume_on_payment_success = retoma só com pagamento aprovado. |
|
|
text |
[pt] Determina como tratar os rateios (proration) resultantes da mudança do billing_cycle_anchor na retomada. Valores possíveis: always_invoice = gera proporcional e fatura na hora; create_prorations = gera itens proporcionais na próxima fatura; none = sem cobrança proporcional. |
|
|
text |
[pt] Código de erro legível por máquina. |
|
|
text |
[pt] Descrição do erro. |
|
|
text |
[pt] O estado do ciclo de vida da operação de retomada. Valores possíveis: error = erro na retomada; pending = retomada pendente; requires_action = retomada requer ação; scheduled = retomada agendada; succeeded = retomada concluída. |
stripe_subscription_schedules_phases
Agendamentos de assinatura: phases (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Um decimal não negativo entre 0 e 100, com no máximo duas casas decimais. Representa a porcentagem do total da fatura da assinatura que será transferida para a conta Stripe do proprietário do aplicativo durante esta fase do cronograma. |
|
|
text |
[pt] Se a Stripe desabilitou o imposto automático, este enum descreve o motivo. Valores possíveis: requires_location_inputs = exige dados de localização do cliente. |
|
|
boolean |
[pt] Se a Stripe calcula automaticamente o imposto nas faturas criadas durante esta fase. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A conta conectada referenciada quando type é account. |
|
|
text |
[pt] Tipo da conta referenciada. Valores possíveis: account = a própria conta; self = o próprio dono. |
|
|
text |
[pt] Os valores possíveis são phase_start ou automatic. Se phase_start, a âncora do ciclo de cobrança da assinatura é definida para o início da fase ao entrar nela. Se automatic, a âncora do ciclo de cobrança é modificada automaticamente conforme necessário ao entrar na fase. Valores possíveis: automatic = âncora de cobrança mantida automaticamente; phase_start = âncora no início da fase. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Limite monetário que faz a assinatura criar uma fatura… |
|
|
boolean |
[pt] Indica se o billing_cycle_anchor deve ser redefinido quando um limite é atingido. Se true, billing_cycle_anchor será atualizado para a data/hora em que o limite foi atingido pela última vez; caso contrário, o valor permanecerá inalterado. Valores: true (sim) ou false (não). |
|
|
text |
[pt] charge_automatically ou send_invoice. Ao cobrar automaticamente, a Stripe tentará pagar a assinatura subjacente no fim de cada ciclo de cobrança, usando a fonte padrão vinculada ao cliente. Valores possíveis: charge_automatically = cobrança automática no meio de pagamento; send_invoice = fatura enviada ao cliente para pagar. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] ID do meio de pagamento padrão do cronograma de assinatura. Deve pertencer ao cliente associado ao cronograma de assinatura. Se não definido, as faturas usarão o meio de pagamento padrão das configurações de fatura do cliente. |
|
|
text |
[pt] Descrição da assinatura, destinada a ser exibida ao cliente. Use este campo para armazenar opcionalmente uma explicação da assinatura a ser exibida nas superfícies da Stripe e em certas interfaces de métodos de pagamento locais. |
|
|
timestamp |
[pt] O fim desta fase do agendamento de assinatura. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
int |
[pt] Número de dias dentro dos quais um cliente deve pagar as faturas geradas por este cronograma de assinatura. Este valor será nulo em cronogramas de assinatura em que billing=charge_automatically. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] Rodapé a ser exibido na fatura. |
|
|
text |
[pt] A conta conectada referenciada quando type é account. |
|
|
text |
[pt] Tipo da conta referenciada. Valores possíveis: account = a própria conta; self = o próprio dono. |
|
|
text |
[pt] A conta (se houver) em nome da qual a cobrança foi feita, para cobranças associadas à assinatura do agendamento. |
|
|
text |
[pt] Na transição entre fases, controla como os rateios (prorations) são tratados, se houver. Valores possíveis: create_prorations, none e always_invoice. Valores possíveis: always_invoice = gera proporcional e fatura na hora; create_prorations = gera itens proporcionais na próxima fatura; none = sem cobrança proporcional. |
|
|
timestamp |
[pt] O início desta fase do agendamento de assinatura. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
float |
[pt] Um decimal não negativo entre 0 e 100, com no máximo duas casas decimais. Representa a porcentagem do total da fatura da assinatura que será transferida para a conta de destino. Por padrão, o valor total é transferido para o destino. |
|
|
text |
[pt] A conta para onde os fundos do pagamento serão transferidos após o sucesso do pagamento. |
|
|
boolean |
[pt] Se true, a fase inteira é contada como período de teste e o cliente não será cobrado por nenhuma tarifa. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Quando o período de teste termina dentro da fase. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
stripe_subscription_schedules_phases_add_invoice_items
Agendamentos de assinatura: phases.add_invoice_items (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
boolean |
[pt] Controla se descontos se aplicam a este item de fatura. Assume true se nenhum valor for informado. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Timestamp Unix preciso do fim do período do item de fatura. Deve ser maior ou igual a period.start. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Selecione como calcular o fim do período do item de fatura. Valores possíveis: min_item_period_end = menor fim de período dos itens; phase_end = fim da fase; timestamp = término em data específica. |
|
|
timestamp |
[pt] Timestamp Unix preciso do início do período do item de fatura. Deve ser menor ou igual a period.end. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Selecione como calcular o início do período do item de fatura. Valores possíveis: max_item_period_start = maior início de período dos itens; phase_start = início da fase; timestamp = término em data específica. |
|
|
text |
[pt] ID do preço usado para gerar o item de fatura. |
|
|
int |
[pt] A quantidade do item da fatura. |
stripe_subscription_schedules_phases_add_invoi_discounts
Agendamentos de assinatura: phases.add_invoice_items.discounts (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases_add_invoice_items, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] ID do cupom para o qual criar um novo desconto. |
|
|
text |
[pt] ID de um desconto existente no objeto (ou em um de seus ancestrais) a ser reutilizado. |
|
|
text |
[pt] ID do código promocional para o qual criar um novo desconto. |
stripe_subscription_schedules_phases_add_invoic_metadata
Agendamentos de assinatura: phases.add_invoice_items.metadata (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases_add_invoice_items, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_subscription_schedules_phases_add_invoi_tax_rates
Agendamentos de assinatura: phases.add_invoice_items.tax_rates (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases_add_invoice_items, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] As alíquotas de imposto que se aplicam ao item. Quando definido, as default_tax_rates não se aplicam a este item. |
stripe_subscription_schedules_phases_default_tax_rates
Agendamentos de assinatura: phases.default_tax_rates (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
stripe_subscription_schedules_phases_default_ta_metadata
Agendamentos de assinatura: phases.default_tax_rates.metadata (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases_default_tax_rates, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_subscription_schedules_phases_discounts
Agendamentos de assinatura: phases.discounts (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] ID do cupom para o qual criar um novo desconto. |
|
|
text |
[pt] ID de um desconto existente no objeto (ou em um de seus ancestrais) a ser reutilizado. |
|
|
text |
[pt] ID do código promocional para o qual criar um novo desconto. |
stripe_subscription_schedules_phases_inv_account_tax_ids
Agendamentos de assinatura: phases.invoice_settings.account_tax_ids (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] IDs fiscais da conta associados a esta fase do cronograma de assinatura. Serão definidos nas faturas geradas por esta fase do cronograma de assinatura. |
stripe_subscription_schedules_phases_invoi_custom_fields
Agendamentos de assinatura: phases.invoice_settings.custom_fields (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do campo personalizado. |
|
|
text |
[pt] O valor do campo personalizado. |
stripe_subscription_schedules_phases_items
Agendamentos de assinatura: phases.items (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
int |
[pt] Limite de uso que faz a assinatura criar uma fatura. |
|
|
text |
[pt] ID do preço no qual o cliente deve ser inscrito. |
|
|
int |
[pt] Quantidade do plano no qual o cliente deve ser inscrito. |
stripe_subscription_schedules_phases_items_discounts
Agendamentos de assinatura: phases.items.discounts (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases_items, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] ID do cupom para o qual criar um novo desconto. |
|
|
text |
[pt] ID de um desconto existente no objeto (ou em um de seus ancestrais) a ser reutilizado. |
|
|
text |
[pt] ID do código promocional para o qual criar um novo desconto. |
stripe_subscription_schedules_phases_items_metadata
Agendamentos de assinatura: phases.items.metadata (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases_items, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um item. Os metadados deste item atualizam os metadados do item de assinatura subjacente quando a fase é iniciada. |
stripe_subscription_schedules_phases_items_tax_rates
Agendamentos de assinatura: phases.items.tax_rates (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases_items, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] As alíquotas de imposto que se aplicam a este phase_item. Quando definido, as default_tax_rates da fase não se aplicam a este phase_item. |
stripe_subscription_schedules_phases_metadata
Agendamentos de assinatura: phases.metadata (uma linha por item; liga-se a stripe_subscription_schedules pela coluna subscription_schedule_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_schedules). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_schedules_phases, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a uma fase. Os metadados da fase de um cronograma atualizam os metadados da assinatura subjacente quando a fase é iniciada. Atualizar diretamente os metadados da assinatura subjacente não afeta os metadados da fase atual. |
Alertas antecipados de fraude
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Alertas antecipados de fraude enviados pelas bandeiras de cartão (Radar), por cobrança.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Um EFW (early fraud warning) é acionável se não recebeu uma contestação e não foi totalmente reembolsado. Você pode querer reembolsar proativamente uma cobrança que receba um EFW, para evitar receber uma contestação depois. Valores: true (sim) ou false (não). |
|
|
text |
[pt] ID da cobrança à qual este alerta antecipado de fraude (early fraud warning) se refere, opcionalmente expandida. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O tipo de fraude rotulado pelo emissor. Um entre card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, unauthorized_use_of_card. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] ID do Payment Intent ao qual este alerta antecipado de fraude (early fraud warning) se refere, opcionalmente expandido. |
Alíquotas de imposto
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Alíquotas de imposto cadastradas para faturas e assinaturas.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
stripe_tax_rates_metadata
Alíquotas de imposto: metadata (uma linha por item; liga-se a stripe_tax_rates pela coluna tax_rate_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_tax_rates). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Assinaturas
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer → Clientes > id
- schedule → Agendamentos de assinatura > id
- subscription_id > _subscriptions_billing_schedules → Assinaturas > id
- subscription_id > _subscriptions_billing_schedules_applies_to → Assinaturas > id
- subscription_id > _subscriptions_default_tax_rates → Assinaturas > id
- subscription_id > _subscriptions_default_tax_rates_metadata → Assinaturas > id
- subscription_id > _subscriptions_discounts → Assinaturas > id
- subscription_id > _subscriptions_invoice_settings_account_tax_ids → Assinaturas > id
- subscription_id > _subscriptions_invoice_settings_custom_fields → Assinaturas > id
- subscription_id > _subscriptions_metadata → Assinaturas > id
- subscription_id > _subscriptions_payment_sett_payment_method_options → Assinaturas > id
- subscription_id > _subscriptions_pay_pay_fin_fil_account_subcategori → Assinaturas > id
- subscription_id > _subscriptions_payment_setting_pay_fin_permissions → Assinaturas > id
- subscription_id > _subscriptions_payment_settings_pay_finan_prefetch → Assinaturas > id
- subscription_id > _subscriptions_payment_settin_payment_method_types → Assinaturas > id
- subscription_id > _subscriptions_pending_update_discounts → Assinaturas > id
- subscription_id > _subscriptions_pending_update_metadata → Assinaturas > id
- subscription_id > _subscriptions_pending_update_subscription_items → Assinaturas > id
Objeto principal
Assinaturas de todos os status (ativas, em teste, inadimplentes, canceladas...), com ciclo de cobrança, períodos, cancelamento e descontos. Assinaturas mudam de status depois de criadas: para a base sempre fiel, escolha a replicação Integral.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] ID do aplicativo Connect que criou a assinatura. |
|
|
float |
[pt] Um decimal não negativo entre 0 e 100, com no máximo duas casas decimais. Representa a porcentagem do total da fatura da assinatura que será transferida para a conta Stripe do proprietário do aplicativo. |
|
|
text |
[pt] Se a Stripe desabilitou o imposto automático, este enum descreve o motivo. Valores possíveis: requires_location_inputs = exige dados de localização do cliente. |
|
|
boolean |
[pt] Se a Stripe calcula automaticamente o imposto nesta assinatura. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A conta conectada referenciada quando type é account. |
|
|
text |
[pt] Tipo da conta referenciada. Valores possíveis: account = a própria conta; self = o próprio dono. |
|
|
timestamp |
[pt] O ponto de referência que alinha as datas dos ciclos de cobrança futuros. Define o dia da semana para intervalos semanais, o dia do mês para intervalos mensais e anuais, e o mês do ano para intervalos anuais. O carimbo de data/hora está no formato UTC. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
int |
[pt] O dia do mês do billing_cycle_anchor. |
|
|
int |
[pt] A hora do dia do billing_cycle_anchor. |
|
|
int |
[pt] O minuto da hora do billing_cycle_anchor. |
|
|
int |
[pt] O mês de início dos períodos de cobrança de ciclo completo. |
|
|
int |
[pt] O segundo do minuto do billing_cycle_anchor. |
|
|
text |
[pt] Controla como faturas e itens de fatura exibem valores de rateio (proration) e de desconto. Valores possíveis: included = descontos incluídos no valor proporcional; itemized = descontos discriminados separadamente. |
|
|
text |
[pt] Controla como os rateios (prorations) e as faturas de assinaturas são calculados e orquestrados. Valores possíveis: classic = modo clássico de cobrança; flexible = modo flexível de cobrança. |
|
|
timestamp |
[pt] Detalhes sobre quando o billing_mode atual foi adotado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Limite monetário que faz a assinatura criar uma fatura… |
|
|
boolean |
[pt] Indica se o billing_cycle_anchor deve ser redefinido quando um limite é atingido. Se true, billing_cycle_anchor será atualizado para a data/hora em que o limite foi atingido pela última vez; caso contrário, o valor permanecerá inalterado. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Uma data futura em que a assinatura será cancelada automaticamente… Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
boolean |
[pt] Se esta assinatura será (se status=active) ou foi (se status=canceled) cancelada ao fim do período de cobrança atual. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Se a assinatura foi cancelada, a data desse cancelamento. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Comentários adicionais sobre por que o usuário cancelou a assinatura, se a assinatura foi cancelada explicitamente pelo usuário. |
|
|
text |
[pt] O motivo informado pelo cliente para o cancelamento, se a assinatura foi cancelada explicitamente pelo usuário. Valores possíveis: customer_service = insatisfeito com o atendimento; low_quality = qualidade baixa; missing_features = faltam funcionalidades; other = outro motivo; switched_service = trocou por outro serviço; too_complex = complexo demais; too_expensive = caro demais; unused = não usava o suficiente. |
|
|
text |
[pt] Opções de feedback personalizadas que dão uma visão mais profunda de por que a assinatura foi cancelada, se ela foi cancelada explicitamente pelo usuário. |
|
|
text |
[pt] Por que esta assinatura foi cancelada. Valores possíveis: canceled_by_retention_policy = cancelada pela política de retenção; cancellation_requested = cancelamento solicitado; payment_disputed = pagamento contestado; payment_failed = falha no pagamento. |
|
|
text |
[pt] charge_automatically ou send_invoice. Ao cobrar automaticamente, a Stripe tentará pagar esta assinatura no fim do ciclo usando a fonte padrão vinculada ao cliente. Valores possíveis: charge_automatically = cobrança automática no meio de pagamento; send_invoice = fatura enviada ao cliente para pagar. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] ID do cliente titular da assinatura. |
|
|
text |
[pt] ID da conta que representa o cliente titular da assinatura. |
|
|
int |
[pt] Número de dias que um cliente tem para pagar as faturas geradas por esta assinatura. Este valor será nulo em assinaturas em que collection_method=charge_automatically. |
|
|
text |
[pt] ID do método de pagamento padrão da assinatura. Deve pertencer ao cliente associado à assinatura. Tem precedência sobre default_source. Se nenhum dos dois estiver definido, as faturas usarão invoice_settings.default_payment_method ou default_source do cliente. |
|
|
text |
[pt] ID da fonte de pagamento padrão da assinatura. Deve pertencer ao cliente associado à assinatura e estar em estado cobrável. Se default_payment_method também estiver definido, default_payment_method terá precedência. |
|
|
text |
[pt] A descrição da assinatura, destinada a ser exibida ao cliente. Use este campo para armazenar, opcionalmente, uma explicação da assinatura para renderização em superfícies da Stripe e em certas interfaces de métodos de pagamento locais. |
|
|
timestamp |
[pt] Se a assinatura terminou, a data em que terminou. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] Rodapé a ser exibido na fatura. |
|
|
text |
[pt] A conta conectada referenciada quando type é account. |
|
|
text |
[pt] Tipo da conta referenciada. Valores possíveis: account = a própria conta; self = o próprio dono. |
|
|
text |
[pt] A fatura mais recente que esta assinatura gerou ao longo do seu ciclo de vida (por exemplo, quando ela renova ou é atualizada). |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
boolean |
[pt] Defina como true para habilitar o Managed Payments, a solução de merchant of record da Stripe, para esta sessão. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Especifica o carimbo de data e hora aproximado em que quaisquer itens de fatura pendentes serão cobrados, de acordo com o cronograma fornecido em pending_invoice_item_interval. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A conta (se houver) em nome da qual a cobrança foi feita, para cobranças associadas a esta assinatura. |
|
|
text |
[pt] O comportamento de cobrança de pagamento desta assinatura enquanto estiver pausada. Valores possíveis: keep_as_draft = faturas mantidas como rascunho; mark_uncollectible = faturas marcadas como incobráveis; void = faturas anuladas. |
|
|
timestamp |
[pt] O momento após o qual a assinatura voltará a cobrar pagamentos. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Configura se a Stripe atualiza subscription.default_payment_method quando o pagamento é bem-sucedido. O padrão é off. Valores possíveis: off = não atualiza meio de pagamento padrão; on_subscription = define como padrão da assinatura. |
|
|
text |
[pt] Especifica a frequência de faturamento. day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O número de intervalos entre faturas. Por exemplo, interval=month e interval_count=3 cobra a cada 3 meses. É permitido um intervalo máximo de um ano (1 ano, 12 meses ou 52 semanas). |
|
|
text |
[pt] Você pode usar este SetupIntent para coletar autenticação do usuário ao criar uma assinatura sem pagamento imediato ou ao atualizar o método de pagamento de uma assinatura, permitindo otimizar para pagamentos fora de sessão (off-session). |
|
|
timestamp |
[pt] Se a atualização for aplicada, determina a data da primeira fatura completa e, para planos com intervalos month ou year, o dia do mês das faturas seguintes. O carimbo de data e hora está em formato UTC. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
boolean |
[pt] Indica se esta assinatura deve ser cancelada no fim do período atual caso a atualização seja aplicada. Valores: true (sim) ou false (não). |
|
|
text |
[pt] O ID do objeto de desconto. Descontos não podem ser consultados por ID. Use expand[]=discounts nas chamadas de API para expandir os IDs de desconto em um array. |
|
|
text |
[pt] A sessão de checkout à qual este cupom é aplicado, se for aplicado a uma sessão específica no modo payment. Não presente no modo subscription. |
|
|
text |
[pt] O ID do cliente associado a este desconto. |
|
|
text |
[pt] O ID da conta que representa o cliente associado a este desconto. |
|
|
timestamp |
[pt] Se o cupom tem duração repeating, a data em que este desconto terminará. Se o cupom tem duração once ou forever, este atributo será nulo. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A fatura à qual o cupom do desconto foi aplicado, se foi aplicado diretamente a uma fatura específica. |
|
|
text |
[pt] O ID do item de fatura (ou do item de linha de fatura, para itens de linha do tipo type='subscription') ao qual o cupom do desconto foi aplicado, se foi aplicado diretamente a um item de fatura ou item de linha de fatura específico. |
|
|
text |
[pt] O código promocional aplicado para criar este desconto. |
|
|
text |
[pt] O cupom que foi resgatado para criar este desconto. |
|
|
text |
[pt] O tipo de origem do desconto. Valores possíveis: coupon = cupom. |
|
|
timestamp |
[pt] Data em que o cupom foi aplicado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A assinatura à qual este cupom é aplicado, se for aplicado a uma assinatura específica. |
|
|
text |
[pt] O item de assinatura ao qual este cupom é aplicado, se for aplicado a um item de assinatura específico. |
|
|
timestamp |
[pt] O ponto após o qual as alterações refletidas nesta atualização serão descartadas e não serão mais aplicadas. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] Carimbo de data/hora Unix que representa o fim do período de teste que o cliente terá antes de ser cobrado pela primeira vez, se a atualização for aplicada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
boolean |
[pt] Indica se o trial_period_days de um plano deve ser aplicado à assinatura. É preferível definir trial_end por assinatura; o padrão é false. Não é permitido definir este sinalizador como true junto com trial_end. Consulte Using trial periods on subscriptions para saber mais. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Moeda usada nos pagamentos do cliente. |
|
|
text |
[pt] O agendamento associado à assinatura. |
|
|
timestamp |
[pt] Data em que a assinatura foi criada pela primeira vez. A data pode diferir da data de criação devido a retroatividade (backdating). Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Os valores possíveis são incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid ou paused. Para collection_method=charge_automatically, uma assinatura passa para incomplete se a tentativa de pagamento inicial falhar. Valores possíveis: active = ativo, em vigor; canceled = cancelado; incomplete = incompleta: primeiro pagamento pendente; incomplete_expired = expirada sem o primeiro pagamento; past_due = em atraso: pagamento falhou; paused = pausada; trialing = em período de teste; unpaid = não paga: cobranças em aberto. active não garante que o cliente está pagando (ex.: cobrança pausada gera faturas em rascunho): confira as faturas pagas (status = paid). |
|
|
text |
[pt] O motivo pelo qual a assinatura foi pausada. Valores possíveis: final_payment_failure = falha no pagamento final; first_payment_failure = falha no primeiro pagamento; pause_requested = pausa solicitada; system = pausada pelo sistema; trial_end_without_payment_method = fim do teste sem meio de pagamento. |
|
|
timestamp |
[pt] Carimbo de data/hora Unix, em segundos, de quando o status da assinatura passou para paused. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O tipo de pausa. Valores possíveis: subscription = pausa de assinatura. |
|
|
text |
[pt] ID do relógio de teste (test clock) ao qual esta assinatura pertence. Só é preenchido em modo de teste (chave sk_test_/rk_test_), quando o registro foi criado preso a um relógio de teste para simular a passagem do tempo; em conta real fica sempre vazio. |
|
|
float |
[pt] Um decimal não negativo entre 0 e 100, com no máximo duas casas decimais. Representa a porcentagem do total da fatura da assinatura que será transferida para a conta de destino. Por padrão, o valor total é transferido para o destino. |
|
|
text |
[pt] A conta para onde os fundos do pagamento serão transferidos após o sucesso do pagamento. |
|
|
timestamp |
[pt] Se a assinatura tem um período de teste, o fim desse período de teste. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Indica como a âncora do ciclo de cobrança da assinatura é redefinida quando um período de teste termina. Se não definido, o padrão é now. Valores possíveis: now = âncora redefinida para o fim do trial; unchanged = âncora de cobrança inalterada. |
|
|
text |
[pt] Indica como a assinatura deve mudar quando o período de teste termina, se o usuário não forneceu um método de pagamento. Valores possíveis: cancel = cancela a assinatura; create_invoice = gera fatura mesmo sem meio de pagamento; pause = pausa a assinatura. |
|
|
timestamp |
[pt] Se a assinatura tem um período de teste, o início desse período de teste. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
stripe_subscriptions_billing_schedules
Assinaturas: billing_schedules (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
timestamp |
[pt] O timestamp até o qual o cronograma de cobrança será aplicado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Especifica a duração da cobrança. day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O multiplicador aplicado ao intervalo. |
|
|
timestamp |
[pt] Se especificado, o cronograma de cobrança será aplicado até o timestamp informado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Descreve como o cronograma de cobrança determinará a data de término. duration ou timestamp. Valores possíveis: duration = término por duração; timestamp = término em data específica. |
|
|
text |
[pt] Identificador único do cronograma de cobrança. |
stripe_subscriptions_billing_schedules_applies_to
Assinaturas: billing_schedules.applies_to (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscriptions_billing_schedules, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O cronograma de cobrança se aplicará ao item de assinatura com o ID de preço informado. |
|
|
text |
[pt] Controla a quais itens da assinatura o cronograma de cobrança se aplica. Valores possíveis: price = aplica-se a preços específicos. |
stripe_subscriptions_default_tax_rates
Assinaturas: default_tax_rates (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
stripe_subscriptions_default_tax_rates_metadata
Assinaturas: default_tax_rates.metadata (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscriptions_default_tax_rates, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_subscriptions_discounts
Assinaturas: discounts (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os descontos aplicados à assinatura. Os descontos dos itens da assinatura são aplicados antes dos descontos da assinatura. Use expand[]=discounts para expandir cada desconto. |
stripe_subscriptions_invoice_settings_account_tax_ids
Assinaturas: invoice_settings.account_tax_ids (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os IDs fiscais da conta associados à assinatura. Serão definidos nas faturas geradas pela assinatura. |
stripe_subscriptions_invoice_settings_custom_fields
Assinaturas: invoice_settings.custom_fields (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do campo personalizado. |
|
|
text |
[pt] O valor do campo personalizado. |
stripe_subscriptions_metadata
Assinaturas: metadata (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_subscriptions_payment_sett_payment_method_options
Assinaturas: payment_settings.payment_method_options (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] O código de país desejado para as informações da conta bancária. Valores permitidos: DE, FR, IE ou NL. Valores possíveis: BE = Bélgica; DE = Alemanha; ES = Espanha; FR = França; IE = Irlanda; NL = Países Baixos. |
|
|
text |
[pt] Tipo de transferência bancária que pode ser usado para financiar. Valores permitidos: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer ou us_bank_transfer. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras. |
|
|
text |
[pt] Linha 1 do endereço (por exemplo, rua, caixa postal ou nome da empresa). |
|
|
text |
[pt] Linha 2 do endereço (por exemplo, apartamento, sala, unidade ou edifício). |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região. |
|
|
text |
[pt] Nome da empresa ou entidade. |
|
|
text |
[pt] O número oficial de registro para o tipo de registro informado. |
|
|
text |
[pt] Tipo de registro que a empresa ou entidade possui em seu país de registro. Valores possíveis: ch_ein = número de empresa (Suíça); de_hrb = registro comercial HRB (Alemanha); dk_cvr = número CVR (Dinamarca); es_cif = CIF fiscal (Espanha); fi_tunnus = Y-tunnus, ID empresarial (Finlândia); fr_siren = número SIREN (França); fr_siret = número SIRET (França); it_rea = registro REA (Itália); nl_kvk = número KvK (Holanda); no_org_number = número de organização (Noruega); no_pno = número pessoal (Noruega); se_org_number = número de organização (Suécia); se_pno = número pessoal (Suécia); uk_crn = número Companies House (Reino Unido). |
|
|
text |
[pt] Número do VAT ID. |
|
|
int |
[pt] O número de segundos (entre 10 e 1209600) após o qual o pagamento Pix expirará. O padrão é 86400 segundos. |
|
|
text |
[pt] O tipo de método de financiamento a ser usado quando não há fundos suficientes no saldo do cliente. Valores permitidos: bank_transfer. Valores possíveis: bank_transfer = transferência bancária. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor a cobrar nos pagamentos futuros, na moeda de apresentação. |
|
|
text |
[pt] Determina se o valor inclui o imposto IOF. Valores possíveis: always = valor sempre inclui IOF; never = valor não inclui IOF. |
|
|
text |
[pt] fixed ou maximum. Com fixed, amount é o valor exato cobrado nos pagamentos futuros; com maximum, o valor cobrado pode ir até amount. Valores possíveis: fixed = valor exato a cobrar; maximum = valor máximo a cobrar. |
|
|
text |
[pt] Descrição do mandato ou da assinatura exibida ao cliente. |
|
|
text |
[pt] Data em que o mandato expira e nenhum pagamento futuro será cobrado, no formato AAAA-MM-DD. |
|
|
timestamp |
[pt] Data em que o mandato expira e nenhum pagamento futuro será cobrado. Se não informada, o mandato é indefinido. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Programação em que os pagamentos futuros serão cobrados. Valores possíveis: halfyearly = semestral; monthly = mensal; quarterly = trimestral; weekly = semanal; yearly = anual. |
|
|
text |
[pt] Finalidade dos pagamentos. Tem valor padrão conforme o código de categoria do comerciante (MCC). Valores possíveis: dependant_support = sustento de dependentes; government = pagamento governamental; loan = empréstimo; mortgage = financiamento imobiliário; other = outro propósito; pension = aposentadoria/pensão; personal = pagamento pessoal; retail = compra no varejo; salary = salário; tax = pagamento de impostos; utility = contas de consumo (água, luz etc.). |
|
|
text |
[pt] Tipo de transação do mandato. Valores possíveis: business = transação empresarial; personal = transação pessoal. |
|
|
text |
[pt] Rede selecionada para processar esta assinatura. Depende das redes disponíveis do cartão anexado à assinatura. Só pode ser definida no momento da confirmação. Valores possíveis: amex; cartes_bancaires; diners; discover; eftpos_au; girocard; interac; jcb; link; mastercard; unionpay; unknown; visa. |
|
|
text |
[pt] Idioma preferido da página de autorização do Bancontact para a qual o cliente é redirecionado. Valores possíveis: de = alemão; en = inglês; fr = francês; nl = holandês. |
|
|
text |
[pt] Recomendamos fortemente que você use o nosso SCA Engine para solicitar automaticamente a autenticação dos seus clientes com base no nível de risco e em outros requisitos. No entanto, se quiser solicitar 3D Secure com base na lógica do seu próprio mecanismo antifraude, informe esta opção. Valores possíveis: any = solicita 3D Secure sempre que possível; automatic = Stripe decide quando exigir 3D Secure; challenge = força desafio 3D Secure. |
|
|
text |
[pt] Método de verificação da conta bancária. O valor padrão é automatic. Valores possíveis: automatic = automática (instantânea ou microdepósitos); instant = verificação instantânea; microdeposits = verificação por microdepósitos. |
stripe_subscriptions_pay_pay_fin_fil_account_subcategori
Assinaturas: payment_settings.payment_method_options.financial_connections.filters.account_subcategories (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscriptions_payment_sett_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Subcategorias de conta usadas para filtrar as possíveis contas a vincular. As subcategorias válidas são checking e savings. Valores possíveis: checking = conta corrente; savings = conta poupança. |
stripe_subscriptions_payment_setting_pay_fin_permissions
Assinaturas: payment_settings.payment_method_options.financial_connections.permissions (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscriptions_payment_sett_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de permissões a solicitar. A permissão payment_method deve ser incluída. Valores possíveis: balances = saldos da conta; ownership = titularidade da conta; payment_method = uso como meio de pagamento; transactions = transações da conta. |
stripe_subscriptions_payment_settings_pay_finan_prefetch
Assinaturas: payment_settings.payment_method_options.financial_connections.prefetch (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscriptions_payment_sett_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Recursos de dados solicitados para serem recuperados na criação da conta. Valores possíveis: balances = saldos; ownership = titularidade; transactions = transações. |
stripe_subscriptions_payment_settin_payment_method_types
Assinaturas: payment_settings.payment_method_types (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de tipos de método de pagamento a fornecer a cada fatura criada pela assinatura. Valores possíveis: ach_credit_transfer = transferência ACH a crédito (EUA); ach_debit = débito ACH (EUA); acss_debit = débito pré-autorizado ACSS (Canadá); affirm = Affirm (parcelamento, EUA); alipay = Alipay (carteira digital, China); amazon_pay = Amazon Pay (carteira digital); au_becs_debit = débito em conta BECS (Austrália); bacs_debit = débito em conta Bacs (Reino Unido); bancontact = Bancontact (Bélgica); billie = Billie (pagamento B2B a prazo); blik = BLIK (pagamento móvel, Polônia); boleto = boleto bancário (Brasil); card = cartão (online); cashapp = Cash App Pay (EUA); crypto = criptomoeda (stablecoin); custom = meio de pagamento personalizado; customer_balance = saldo do cliente (transferência bancária); eps = EPS (transferência, Áustria); fpx = FPX (transferência, Malásia); giropay = giropay (transferência, Alemanha); grabpay = GrabPay (carteira digital, Sudeste Asiático); ideal = iDEAL (transferência, Holanda); jp_credit_transfer = transferência bancária (Japão); kakao_pay = Kakao Pay (carteira digital, Coreia); klarna = Klarna (meio de pagamento); konbini = Konbini (pagamento em loja, Japão); kr_card = cartão coreano; link = Link (checkout salvo da Stripe); mb_way = MB WAY (pagamento móvel, Portugal); multibanco = Multibanco (referência bancária, Portugal); naver_pay = Naver Pay (carteira digital, Coreia); nz_bank_account = débito em conta (Nova Zelândia); p24 = Przelewy24 (transferência, Polônia); pay_by_bank = pagamento via banco (open banking); payco = PAYCO (carteira digital, Coreia); paynow = PayNow (QR code, Singapura); paypal = PayPal (carteira digital); payto = PayTo (débito em conta, Austrália); pix = Pix (pagamento instantâneo, Brasil); promptpay = PromptPay (QR code, Tailândia); revolut_pay = Revolut Pay (carteira digital); satispay = Satispay (pagamento móvel, Itália); sepa_credit_transfer = transferência SEPA a crédito; sepa_debit = débito em conta SEPA (Europa); sofort = Sofort (transferência, Europa); swish = Swish (pagamento móvel, Suécia); twint = TWINT (pagamento móvel, Suíça); upi = UPI (pagamento instantâneo, Índia); us_bank_account = débito em conta ACH (EUA); wechat_pay = WeChat Pay (carteira digital, China). |
stripe_subscriptions_pending_update_discounts
Assinaturas: pending_update.discounts (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os descontos que serão aplicados à assinatura quando a atualização pendente for aplicada. Use expand[]=discounts para expandir cada desconto. |
stripe_subscriptions_pending_update_metadata
Assinaturas: pending_update.metadata (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_subscriptions_pending_update_subscription_items
Assinaturas: pending_update.subscription_items (uma linha por item; liga-se a stripe_subscriptions pela coluna subscription_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscriptions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista de itens de assinatura, cada um com um plano vinculado, que será definida se a atualização for aplicada. |
Assinaturas - Detalhes - Itens da assinatura
Tipo de replicação: Integral
Relacionamentos:
- subscription_id → Assinaturas > id
- subscription → Assinaturas > id
- subscription_id > _subscription_items_discounts → Assinaturas > id
- subscription_item_id > _subscription_items_discounts → Assinaturas - Detalhes - Itens da assinatura > id
- subscription_id > _subscription_items_metadata → Assinaturas > id
- subscription_item_id > _subscription_items_metadata → Assinaturas - Detalhes - Itens da assinatura > id
- subscription_id > _subscription_items_price_currency_options → Assinaturas > id
- subscription_item_id > _subscription_items_price_currency_options → Assinaturas - Detalhes - Itens da assinatura > id
- subscription_id > _subscription_items_price_currency_options_tiers → Assinaturas > id
- subscription_item_id > _subscription_items_price_currency_options_tiers → Assinaturas - Detalhes - Itens da assinatura > id
- subscription_id > _subscription_items_price_metadata → Assinaturas > id
- subscription_item_id > _subscription_items_price_metadata → Assinaturas - Detalhes - Itens da assinatura > id
- subscription_id > _subscription_items_price_tiers → Assinaturas > id
- subscription_item_id > _subscription_items_price_tiers → Assinaturas - Detalhes - Itens da assinatura > id
- subscription_id > _subscription_items_tax_rates → Assinaturas > id
- subscription_item_id > _subscription_items_tax_rates → Assinaturas - Detalhes - Itens da assinatura > id
- subscription_id > _subscription_items_tax_rates_metadata → Assinaturas > id
- subscription_item_id > _subscription_items_tax_rates_metadata → Assinaturas - Detalhes - Itens da assinatura > id
Objeto principal
Itens de cada assinatura (preço, quantidade e período corrente de cada item).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
timestamp |
[pt] O período de tempo pelo qual o item da assinatura foi cobrado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
int |
[pt] Limite de uso que faz a assinatura criar uma fatura. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O horário de término do período de cobrança atual deste item da assinatura. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O horário de início do período de cobrança atual deste item da assinatura. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] Data de término (UTC) do período de teste atual deste item de assinatura. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] Data de início (UTC) do período de teste atual deste item de assinatura. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Identificador da oferta de teste aplicada ao período de teste atual deste item de assinatura. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o preço pode ser usado em novas compras. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Descreve como calcular o preço por período. per_unit ou tiered. Valores possíveis: per_unit = preço fixo por unidade; tiered = preço por faixas. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Uma chave de consulta usada para recuperar preços dinamicamente a partir de uma string estática. Pode ter até 200 caracteres. |
|
|
text |
[pt] Uma breve descrição do preço, oculta dos clientes. |
|
|
text |
[pt] O ID do produto ao qual este preço está associado. |
|
|
text |
[pt] A frequência com que uma assinatura é cobrada. Um entre day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O número de intervalos (especificados no atributo interval) entre as cobranças da assinatura. Por exemplo, interval=month e interval_count=3 cobra a cada 3 meses. |
|
|
text |
[pt] O medidor que rastreia o uso de um preço medido. |
|
|
text |
[pt] Configura como a quantidade por período deve ser determinada. Pode ser metered ou licensed. licensed cobra automaticamente a quantidade definida ao adicioná-la a uma assinatura. metered agrega o uso total com base nos registros de uso. O padrão é licensed. Valores possíveis: licensed = cobra a quantidade contratada; metered = cobra pelo uso medido. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
text |
[pt] Define se o preço escalonado deve ser graduated ou baseado em volume. No escalonamento baseado em volume, a quantidade máxima dentro de um período determina o preço por unidade. No escalonamento graduated, o preço pode mudar à medida que a quantidade cresce. Valores possíveis: graduated = graduado: cada faixa com seu preço; volume = por volume: faixa total define preço. |
|
|
int |
[pt] Divida o uso por este número. |
|
|
text |
[pt] Após a divisão, arredonde o resultado para cima ou para baixo. Valores possíveis: down = arredonda para baixo; up = arredonda para cima. |
|
|
text |
[pt] Um de one_time ou recurring, dependendo de o preço ser de uma compra única ou de uma compra recorrente (assinatura). Valores possíveis: one_time = preço avulso (compra única); recurring = preço recorrente (assinatura). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
|
|
int |
[pt] A quantidade do plano em que o cliente deve estar assinado. |
|
|
text |
[pt] A assinatura à qual este subscription_item pertence. |
stripe_subscription_items_discounts
Assinaturas - Detalhes - Itens da assinatura: discounts (uma linha por item; liga-se a stripe_subscription_items pela coluna subscription_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os descontos aplicados ao item da assinatura. Os descontos do item da assinatura são aplicados antes dos descontos da assinatura. Use expand[]=discounts para expandir cada desconto. |
stripe_subscription_items_metadata
Assinaturas - Detalhes - Itens da assinatura: metadata (uma linha por item; liga-se a stripe_subscription_items pela coluna subscription_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_subscription_items_price_currency_options
Assinaturas - Detalhes - Itens da assinatura: price.currency_options (uma linha por item; liga-se a stripe_subscription_items pela coluna subscription_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
stripe_subscription_items_price_currency_options_tiers
Assinaturas - Detalhes - Itens da assinatura: price.currency_options.tiers (uma linha por item; liga-se a stripe_subscription_items pela coluna subscription_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_items_price_currency_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_subscription_items_price_metadata
Assinaturas - Detalhes - Itens da assinatura: price.metadata (uma linha por item; liga-se a stripe_subscription_items pela coluna subscription_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_subscription_items_price_tiers
Assinaturas - Detalhes - Itens da assinatura: price.tiers (uma linha por item; liga-se a stripe_subscription_items pela coluna subscription_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_subscription_items_tax_rates
Assinaturas - Detalhes - Itens da assinatura: tax_rates (uma linha por item; liga-se a stripe_subscription_items pela coluna subscription_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
stripe_subscription_items_tax_rates_metadata
Assinaturas - Detalhes - Itens da assinatura: tax_rates.metadata (uma linha por item; liga-se a stripe_subscription_items pela coluna subscription_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_subscriptions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_subscription_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_subscription_items_tax_rates, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Clientes
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer_id > _customers_cash_balance_available → Clientes > id
- customer_id > _customers_invoice_credit_balance → Clientes > id
- customer_id > _customers_invoice_settings_custom_fields → Clientes > id
- customer_id > _customers_metadata → Clientes > id
- customer_id > _customers_preferred_locales → Clientes > id
Objeto principal
Clientes cadastrados no Stripe, com contato, endereço, saldo, moeda, configurações de fatura e inadimplência. Clientes são alterados depois de criados: para a base sempre fiel, escolha a replicação Integral.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O saldo atual, se houver, armazenado no cliente em sua moeda padrão. Se negativo, o cliente tem crédito a aplicar na próxima fatura. Se positivo, o cliente tem um valor devido que é adicionado à próxima fatura. |
|
|
text |
[pt] O nome da empresa do cliente. |
|
|
text |
[pt] O ID do cliente cujo saldo em dinheiro este objeto representa. |
|
|
text |
[pt] O ID de uma conta (Account) que representa um cliente cujo saldo em dinheiro este objeto representa. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] A configuração de como os fundos que chegam ao saldo em dinheiro do cliente são conciliados. Valores possíveis: automatic = conciliação automática; manual = conciliação manual. |
|
|
boolean |
[pt] Um indicador de se o modo de conciliação retornado é o padrão do usuário ou é específico deste saldo de caixa do cliente… Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código ISO de três letras da moeda em que o cliente pode ser cobrado para fins de cobrança recorrente. Vazia até o cliente ter a primeira assinatura, fatura ou saldo. |
|
|
text |
[pt] O ID de uma conta (Account) que representa um cliente. Você pode usar este ID com qualquer API v1 que aceite o parâmetro customer_account. |
|
|
text |
[pt] ID da fonte de pagamento padrão do cliente. Se você usa métodos de pagamento criados pela API PaymentMethods, consulte o campo invoice_settings.default_payment_method. |
|
|
boolean |
[pt] Acompanha a mudança de estado mais recente em qualquer fatura pertencente ao cliente. Pagar uma fatura ou marcá-la como incobrável pela API definirá este campo como false. Uma falha automática de pagamento ou a passagem de invoice.due_date definirá este campo como true. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] O ID do objeto de desconto. Descontos não podem ser consultados por ID. Use expand[]=discounts nas chamadas de API para expandir os IDs de desconto em um array. |
|
|
text |
[pt] A sessão de checkout à qual este cupom é aplicado, se for aplicado a uma sessão específica no modo payment. Não presente no modo subscription. |
|
|
text |
[pt] O ID do cliente associado a este desconto. |
|
|
text |
[pt] O ID da conta que representa o cliente associado a este desconto. |
|
|
timestamp |
[pt] Se o cupom tem duração repeating, a data em que este desconto terminará. Se o cupom tem duração once ou forever, este atributo será nulo. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A fatura à qual o cupom do desconto foi aplicado, se foi aplicado diretamente a uma fatura específica. |
|
|
text |
[pt] O ID do item de fatura (ou do item de linha de fatura, para itens de linha do tipo type='subscription') ao qual o cupom do desconto foi aplicado, se foi aplicado diretamente a um item de fatura ou item de linha de fatura específico. |
|
|
text |
[pt] O código promocional aplicado para criar este desconto. |
|
|
text |
[pt] O cupom que foi resgatado para criar este desconto. |
|
|
text |
[pt] O tipo de origem do desconto. Valores possíveis: coupon = cupom. |
|
|
timestamp |
[pt] Data em que o cupom foi aplicado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A assinatura à qual este cupom é aplicado, se for aplicado a uma assinatura específica. |
|
|
text |
[pt] O item de assinatura ao qual este cupom é aplicado, se for aplicado a um item de assinatura específico. |
|
|
text |
[pt] O endereço de e-mail do cliente. |
|
|
text |
[pt] O nome individual do cliente. |
|
|
text |
[pt] O prefixo do cliente usado para gerar números de fatura únicos. |
|
|
text |
[pt] ID de um método de pagamento vinculado ao cliente, a ser usado como método de pagamento padrão do cliente em assinaturas e faturas. |
|
|
text |
[pt] Rodapé padrão a ser exibido nas faturas deste cliente. |
|
|
text |
[pt] Como os preços e valores dos itens de linha serão exibidos em relação aos impostos nos PDFs de fatura. |
|
|
text |
[pt] ID do modelo de renderização de fatura a ser usado nas faturas deste cliente. Se definido, o modelo será usado em todas as faturas deste cliente, a menos que um modelo seja definido diretamente na fatura. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O nome completo ou o nome da empresa do cliente. |
|
|
int |
[pt] O sufixo do número da próxima fatura do cliente (por exemplo, 0001). Quando a conta usa sequenciamento em nível de conta, este parâmetro é ignorado nas requisições da API e o campo é omitido nas respostas da API. |
|
|
text |
[pt] O número de telefone do cliente. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] A transportadora que enviou um produto físico, como Fedex, UPS, USPS etc. |
|
|
text |
[pt] Nome do destinatário. |
|
|
text |
[pt] Telefone do destinatário (incluindo ramal). |
|
|
text |
[pt] O código de rastreamento de um produto físico, obtido da transportadora. Se vários códigos de rastreamento foram gerados para esta compra, separe-os por vírgulas. |
|
|
text |
[pt] Indica se o cálculo automático de impostos é possível, dadas as informações atuais de localização do cliente. Valores possíveis: failed = cálculo automático falhou; not_collecting = sem recolhimento de imposto; supported = cálculo automático possível; unrecognized_location = localização do cliente não reconhecida. |
|
|
text |
[pt] Um endereço IP recente do cliente, usado para declaração de impostos e inferência da localização fiscal. |
|
|
text |
[pt] O país fiscal identificado do cliente. |
|
|
text |
[pt] A fonte de dados usada para inferir a localização do cliente. Valores possíveis: billing_address = endereço de cobrança; ip_address = endereço IP; payment_method = dados do meio de pagamento; shipping_destination = endereço de entrega. |
|
|
text |
[pt] O estado, condado, província ou região fiscal identificado do cliente. |
|
|
text |
[pt] O provedor de cálculo de imposto usado para resolução de local. O padrão é stripe quando não se usa um provedor terceirizado. Valores possíveis: anrok = Anrok (provedor de impostos); avalara = Avalara (provedor de impostos); sphere = Sphere (provedor de impostos); stripe = Stripe Tax (cálculo nativo). |
|
|
text |
[pt] Descreve o status de isenção de impostos do cliente, que é none, exempt ou reverse. Quando definido como reverse, os PDFs de fatura e de recibo incluem o seguinte texto: **"Reverse charge"**. Valores possíveis: exempt = cliente isento de impostos; none = cliente não isento; reverse = reverse charge: o comprador recolhe o imposto. |
|
|
text |
[pt] ID do relógio de teste (test clock) ao qual este cliente pertence. Só é preenchido em modo de teste (chave sk_test_/rk_test_), quando o registro foi criado preso a um relógio de teste para simular a passagem do tempo; em conta real fica sempre vazio. |
stripe_customers_cash_balance_available
Clientes: cash_balance.available (uma linha por item; liga-se a stripe_customers pela coluna customer_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Um hash com todos os saldos de caixa disponíveis para este cliente. Não é possível excluir um cliente que tenha qualquer saldo de caixa, mesmo que o saldo seja 0. Os valores são representados. |
stripe_customers_invoice_credit_balance
Clientes: invoice_credit_balance (uma linha por item; liga-se a stripe_customers pela coluna customer_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Os saldos multimoeda atuais, se houver, armazenados no cliente. Se positivo em uma moeda, o cliente tem um crédito a aplicar na próxima fatura, denominado nessa moeda. Se negativo, o cliente tem um valor devido que é adicionado à próxima fatura, denominado nessa moeda. |
stripe_customers_invoice_settings_custom_fields
Clientes: invoice_settings.custom_fields (uma linha por item; liga-se a stripe_customers pela coluna customer_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customers). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do campo personalizado. |
|
|
text |
[pt] O valor do campo personalizado. |
stripe_customers_metadata
Clientes: metadata (uma linha por item; liga-se a stripe_customers pela coluna customer_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_customers_preferred_locales
Clientes: preferred_locales (uma linha por item; liga-se a stripe_customers pela coluna customer_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customers). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] As localidades (idiomas) preferidas do cliente, ordenadas por preferência. |
Clientes - Detalhes - Identificações fiscais
Identificações fiscais (CNPJ, CPF, VAT etc.) cadastradas em cada cliente, com status de verificação.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] Código ISO de duas letras que representa o país do ID fiscal. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] ID do cliente. |
|
|
text |
[pt] ID da Account que representa o cliente. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] A conta referenciada quando type é account. |
|
|
text |
[pt] O aplicativo Connect referenciado quando type é application. |
|
|
text |
[pt] O cliente referenciado quando type é customer. |
|
|
text |
[pt] A Account que representa o cliente referenciado quando type é customer. |
|
|
text |
[pt] Tipo de proprietário referenciado. Valores possíveis: account = a própria conta; application = aplicação Connect; customer = cliente (customer); self = o próprio dono. |
|
|
text |
[pt] Tipo do ID fiscal, um entre ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_… Valores possíveis: ad_nrt = NRT (Andorra); ae_trn = TRN (Emirados Árabes); al_tin = NIPT/TIN (Albânia); am_tin = TIN (Armênia); ao_tin = NIF (Angola); ar_cuit = CUIT (Argentina); au_abn = ABN (Austrália); au_arn = ARN (Austrália); aw_tin = TIN (Aruba); az_tin = TIN (Azerbaijão); ba_tin = TIN (Bósnia e Herzegovina); bb_tin = TIN (Barbados); bd_bin = BIN (Bangladesh); bf_ifu = IFU (Burkina Faso); bg_uic = UIC (Bulgária); bh_vat = VAT/IVA (Bahrein); bj_ifu = IFU (Benin); bo_tin = NIT (Bolívia); br_cnpj = CNPJ (Brasil); br_cpf = CPF (Brasil); bs_tin = TIN (Bahamas); by_tin = TIN (Belarus); ca_bn = BN (Canadá); ca_gst_hst = GST/HST (Canadá); ca_pst_bc = PST Colúmbia Britânica (Canadá); ca_pst_mb = PST Manitoba (Canadá); ca_pst_sk = PST Saskatchewan (Canadá); ca_qst = QST Quebec (Canadá); cd_nif = NIF (Rep. Dem. do Congo); ch_uid = UID (Suíça); ch_vat = VAT/IVA (Suíça); cl_tin = RUT (Chile); cm_niu = NIU (Camarões); cn_tin = TIN (China); co_nit = NIT (Colômbia); cr_tin = TIN (Costa Rica); cv_nif = NIF (Cabo Verde); de_stn = Steuernummer (Alemanha); do_rcn = RNC (Rep. Dominicana); ec_ruc = RUC (Equador); eg_tin = TIN (Egito); es_cif = CIF/NIF (Espanha); et_tin = TIN (Etiópia); eu_oss_vat = VAT/IVA regime OSS (União Europeia); eu_vat = VAT/IVA (União Europeia); fo_vat = VAT/IVA (Ilhas Faroé); gb_vat = VAT/IVA (Reino Unido); ge_vat = VAT/IVA (Geórgia); gi_tin = TIN (Gibraltar); gn_nif = NIF (Guiné); hk_br = BR (Hong Kong); hr_oib = OIB (Croácia); hu_tin = TIN (Hungria); ic_nif = NIF (Ilhas Canárias); id_npwp = NPWP (Indonésia); il_vat = VAT/IVA (Israel); in_gst = GSTIN (Índia); is_vat = VAT/IVA (Islândia); it_cf = Codice Fiscale (Itália); jp_cn = Corporate Number (Japão); jp_rn = RN para empresa estrangeira (Japão); jp_trn = TRN de consumo (Japão); ke_pin = KRA PIN (Quênia); kg_tin = TIN (Quirguistão); kh_tin = TIN (Camboja); kr_brn = BRN (Coreia do Sul); kz_bin = BIN (Cazaquistão); la_tin = TIN (Laos); li_uid = UID (Liechtenstein); li_vat = VAT/IVA (Liechtenstein); lk_vat = VAT/IVA (Sri Lanka); ma_vat = VAT/IVA (Marrocos); md_vat = VAT/IVA (Moldávia); me_pib = PIB (Montenegro); mk_vat = VAT/IVA (Macedônia do Norte); mr_nif = NIF (Mauritânia); mx_rfc = RFC (México); my_frp = FRP (Malásia); my_itn = ITN (Malásia); my_sst = SST (Malásia); ng_tin = TIN (Nigéria); no_vat = VAT/IVA (Noruega); no_voec = VOEC (Noruega); np_pan = PAN (Nepal); nz_gst = GST (Nova Zelândia); om_vat = VAT/IVA (Omã); pe_ruc = RUC (Peru); ph_tin = TIN (Filipinas); pl_nip = NIP (Polônia); py_ruc = RUC (Paraguai); ro_tin = TIN (Romênia); rs_pib = PIB (Sérvia); ru_inn = INN (Rússia); ru_kpp = KPP (Rússia); sa_vat = VAT/IVA (Arábia Saudita); sg_gst = GST (Singapura); sg_uen = UEN (Singapura); si_tin = TIN (Eslovênia); sn_ninea = NINEA (Senegal); sr_fin = FIN (Suriname); sv_nit = NIT (El Salvador); th_vat = VAT/IVA (Tailândia); tj_tin = TIN (Tajiquistão); tr_tin = TIN (Turquia); tw_vat = VAT/IVA (Taiwan); tz_vat = VAT/IVA (Tanzânia); ua_vat = VAT/IVA (Ucrânia); ug_tin = TIN (Uganda); unknown = tipo de ID fiscal desconhecido; us_ein = EIN (EUA); uy_ruc = RUC (Uruguai); uz_tin = TIN (Uzbequistão); uz_vat = VAT/IVA (Uzbequistão); ve_rif = RIF (Venezuela); vn_tin = TIN (Vietnã); za_vat = VAT/IVA (África do Sul); zm_tin = TIN (Zâmbia); zw_tin = TIN (Zimbábue). |
|
|
text |
[pt] Valor do ID fiscal. |
|
|
text |
[pt] Status da verificação, um entre pending, verified, unverified ou unavailable. Valores possíveis: pending = pendente; unavailable = indisponível; unverified = não verificado; verified = verificado. |
|
|
text |
[pt] Endereço verificado. |
|
|
text |
[pt] Nome verificado. |
Clientes - Detalhes - Meios de pagamento
Tipo de replicação: Integral
Relacionamentos:
- customer_id → Clientes > id
- customer → Clientes > id
- customer_id > _customer_payment_methods_car_gen_payment_method_d → Clientes > id
- payment_method_id > _customer_payment_methods_car_gen_payment_method_d → Clientes - Detalhes - Meios de pagamento > id
- customer_id > _customer_payment_methods_car_gen_pay_preferred_lo → Clientes > id
- payment_method_id > _customer_payment_methods_car_gen_pay_preferred_lo → Clientes - Detalhes - Meios de pagamento > id
- customer_id > _customer_payment_methods_card_networks_available → Clientes > id
- payment_method_id > _customer_payment_methods_card_networks_available → Clientes - Detalhes - Meios de pagamento > id
- customer_id > _customer_payment_methods_card__networks_available → Clientes > id
- payment_method_id > _customer_payment_methods_card__networks_available → Clientes - Detalhes - Meios de pagamento > id
- customer_id > _customer_payment_methods_card_p_preferred_locales → Clientes > id
- payment_method_id > _customer_payment_methods_card_p_preferred_locales → Clientes - Detalhes - Meios de pagamento > id
- customer_id > _customer_payment_methods_inter_networks_available → Clientes > id
- payment_method_id > _customer_payment_methods_inter_networks_available → Clientes - Detalhes - Meios de pagamento > id
- customer_id > _customer_payment_methods_intera_preferred_locales → Clientes > id
- payment_method_id > _customer_payment_methods_intera_preferred_locales → Clientes - Detalhes - Meios de pagamento > id
- customer_id > _customer_payment_methods_metadata → Clientes > id
- payment_method_id > _customer_payment_methods_metadata → Clientes - Detalhes - Meios de pagamento > id
- customer_id > _customer_payment_methods_us_ba_networks_supported → Clientes > id
- payment_method_id > _customer_payment_methods_us_ba_networks_supported → Clientes - Detalhes - Meios de pagamento > id
Objeto principal
Meios de pagamento salvos em cada cliente (cartão, boleto, Pix etc.), com dados de cobrança e, para cartões, bandeira, final e validade.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] Nome do banco associado à conta bancária. |
|
|
text |
[pt] Identifica de forma única esta conta bancária. Você pode usar este atributo para verificar se duas contas bancárias são a mesma. |
|
|
text |
[pt] Número da instituição da conta bancária. |
|
|
text |
[pt] Últimos quatro dígitos do número da conta bancária. |
|
|
text |
[pt] Número de trânsito (transit number) da conta bancária. |
|
|
text |
[pt] Este campo indica se este método de pagamento pode ser exibido novamente ao cliente em um fluxo de checkout. Produtos da Stripe como Checkout e Elements usam este campo para determinar se um método de pagamento pode ser exibido como método de pagamento salvo em um fluxo de checkout. O campo tem como padrão “unspecified”. Valores possíveis: always = pode ser sempre reexibido; limited = reexibição limitada; unspecified = não especificado. |
|
|
text |
[pt] Número de seis dígitos que identifica o banco e a agência associados a esta conta bancária. |
|
|
text |
[pt] Identifica de forma única esta conta bancária. Você pode usar este atributo para verificar se duas contas bancárias são a mesma. |
|
|
text |
[pt] Últimos quatro dígitos do número da conta bancária. |
|
|
text |
[pt] Identifica de forma única esta conta bancária. Você pode usar este atributo para verificar se duas contas bancárias são a mesma. |
|
|
text |
[pt] Últimos quatro dígitos do número da conta bancária. |
|
|
text |
[pt] Sort code da conta bancária. (p. ex., 10-20-30) |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] Endereço de e-mail. |
|
|
text |
[pt] Nome completo. |
|
|
text |
[pt] Telefone de cobrança (incluindo ramal). |
|
|
text |
[pt] Número de identificação do contribuinte. Usado apenas em transações entre compradores da América Latina (LATAM) e vendedores de fora da LATAM. |
|
|
text |
[pt] Identificador único do comprador, definido pelo processador de pagamentos local. |
|
|
text |
[pt] Identificador único e imutável atribuído pelo BLIK a cada comprador. |
|
|
text |
[pt] Identifica de forma única o documento fiscal do cliente (CNPJ ou CPF) |
|
|
text |
[pt] Bandeira do cartão. Pode ser amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa ou unknown. |
|
|
text |
[pt] Se a linha 1 do endereço (line1) foi fornecida, o resultado da verificação: pass, fail, unavailable ou unchecked. |
|
|
text |
[pt] Se o código postal do endereço foi fornecido, o resultado da verificação: pass, fail, unavailable ou unchecked. |
|
|
text |
[pt] Se um CVC foi fornecido, o resultado da verificação: pass, fail, unavailable ou unchecked. |
|
|
text |
[pt] Código ISO de duas letras que representa o país do cartão. Você pode usar este atributo para ter uma noção da distribuição internacional dos cartões que coletou. |
|
|
text |
[pt] A bandeira a ser usada na exibição do cartão, considerando a escolha de bandeira do cliente em cartões com bandeira dupla. Pode ser american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa ou other, e pode conter mais valores no futuro. |
|
|
int |
[pt] Número de dois dígitos que representa o mês de validade do cartão. |
|
|
int |
[pt] Número de quatro dígitos que representa o ano de validade do cartão. |
|
|
text |
[pt] Identifica de forma única este número de cartão específico. Você pode usar este atributo para verificar, por exemplo, se dois clientes que se cadastraram usam o mesmo número de cartão. |
|
|
text |
[pt] Tipo de financiamento do cartão. Pode ser credit, debit, prepaid ou unknown. |
|
|
text |
[pt] A cobrança que criou este objeto. |
|
|
text |
[pt] O tipo de detalhes específicos da transação do meio de pagamento, da transação que gerou este meio de pagamento de cartão. Sempre card_present. |
|
|
text |
[pt] O ID do SetupAttempt que gerou este PaymentMethod, se houver. |
|
|
text |
[pt] Os últimos quatro dígitos do cartão. |
|
|
text |
[pt] A rede preferida para cartões co-branded. Pode ser cartes_bancaires, mastercard, visa ou invalid_preference se a rede solicitada não for válida para o cartão. |
|
|
text |
[pt] Status de um cartão com base no emissor do cartão. Valores possíveis: regulated = cartão regulado (tarifa limitada); unregulated = cartão não regulado. |
|
|
boolean |
[pt] Se o 3D Secure é suportado neste cartão. Valores: true (sim) ou false (não). |
|
|
text |
[pt] (Somente para números tokenizados.) Os últimos quatro dígitos do número da conta do dispositivo. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] E-mail verificado do titular. Os valores são verificados ou fornecidos diretamente pela carteira (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Nome completo verificado do titular. Os valores são verificados ou fornecidos diretamente pela carteira (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] O tipo da carteira digital do cartão, um entre amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout ou link. Um hash adicional é incluído no sub-hash Wallet com nome correspondente a este valor. Ele contém informações adicionais específicas do tipo de carteira do cartão. Valores possíveis: amex_express_checkout = Amex Express Checkout (carteira); apple_pay = Apple Pay (carteira); google_pay = Google Pay (carteira); link = Link (checkout salvo da Stripe); masterpass = Masterpass (carteira); samsung_pay = Samsung Pay (carteira digital); visa_checkout = Visa Checkout (carteira). |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] E-mail verificado do titular. Os valores são verificados ou fornecidos diretamente pela carteira (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Nome completo verificado do titular. Os valores são verificados ou fornecidos diretamente pela carteira (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] Bandeira do cartão. Pode ser amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa ou unknown. |
|
|
text |
[pt] O código de produto que identifica o programa ou produto específico associado a um cartão. |
|
|
text |
[pt] Nome do titular do cartão conforme lido do cartão, no formato ISO 7813. Pode incluir caracteres alfanuméricos, caracteres especiais e o separador de nome/sobrenome (/). Em alguns casos, o nome do titular pode não estar disponível, dependendo de como o emissor configurou o cartão. |
|
|
text |
[pt] Código ISO de duas letras que representa o país do cartão. Você pode usar este atributo para ter uma noção da distribuição internacional dos cartões que coletou. |
|
|
text |
[pt] Descrição de alto nível do tipo de cartões emitidos nesta faixa. |
|
|
int |
[pt] Número de dois dígitos que representa o mês de validade do cartão. |
|
|
int |
[pt] Número de quatro dígitos que representa o ano de validade do cartão. |
|
|
text |
[pt] Identifica de forma única este número de cartão específico. Você pode usar este atributo para verificar, por exemplo, se dois clientes que se cadastraram usam o mesmo número de cartão. |
|
|
text |
[pt] Tipo de financiamento do cartão. Pode ser credit, debit, prepaid ou unknown. |
|
|
text |
[pt] O nome do banco emissor do cartão. |
|
|
text |
[pt] Os últimos quatro dígitos do cartão. |
|
|
text |
[pt] A rede preferencial para o cartão. |
|
|
timestamp |
[pt] Momento em que o pagamento foi coletado offline… Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O método usado para processar este meio de pagamento offline. Somente deferred é permitido. Valores possíveis: deferred = processamento diferido (offline). |
|
|
text |
[pt] Como os dados do cartão foram lidos nesta transação. Valores possíveis: contact_emv = chip inserido (EMV); contactless_emv = aproximação (EMV); contactless_magstripe_mode = aproximação em modo tarja; magnetic_stripe_fallback = tarja magnética após falha do chip; magnetic_stripe_track2 = tarja magnética (trilha 2). |
|
|
text |
[pt] O tipo de carteira digital móvel, um entre apple_pay, google_pay, samsung_pay ou unknown. Valores possíveis: apple_pay = Apple Pay (carteira); google_pay = Google Pay (carteira); samsung_pay = Samsung Pay (carteira digital); unknown = tipo de ID fiscal desconhecido. |
|
|
text |
[pt] Identificador único e imutável atribuído pelo Cash App a cada comprador. |
|
|
text |
[pt] Identificador público de compradores que usam o Cash App. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Nome de exibição do CustomPaymentMethodType exclusivo do Dashboard. |
|
|
text |
[pt] Tipo de conteúdo do logo do CustomPaymentMethodType exclusivo do Dashboard. |
|
|
text |
[pt] URL do logo do CustomPaymentMethodType exclusivo do Dashboard. |
|
|
text |
[pt] ID do CustomPaymentMethodType exclusivo do Dashboard. Não expansível. |
|
|
text |
[pt] O ID do cliente (Customer) em que este PaymentMethod está salvo. Não é definido quando o PaymentMethod não foi salvo em um cliente. |
|
|
text |
[pt] Identificador da conta de cliente (Accounts v2) a que este objeto pertence, quando a conta usa Accounts v2. |
|
|
text |
[pt] O banco do cliente. Valores possíveis: arzte_und_apotheker_bank; austrian_anadi_bank_ag; bank_austria; bankhaus_carl_spangler; bankhaus_schelhammer_und_schattera_ag; bawag_psk_ag; bks_bank_ag; brull_kallmus_bank_ag; btv_vier_lander_bank; capital_bank_grawe_gruppe_ag; deutsche_bank_ag; dolomitenbank; easybank_ag; erste_bank_und_sparkassen; hypo_alpeadriabank_international_ag; hypo_bank_burgenland_aktiengesellschaft; hypo_noe_lb_fur_niederosterreich_u_wien; hypo_oberosterreich_salzburg_steiermark; hypo_tirol_bank_ag; hypo_vorarlberg_bank_ag; marchfelder_bank; oberbank_ag; raiffeisen_bankengruppe_osterreich; schoellerbank_ag; sparda_bank_wien; volksbank_gruppe; volkskreditbank_ag; vr_bank_braunau. |
|
|
text |
[pt] O banco do cliente, se informado. Valores possíveis: affin_bank; agrobank; alliance_bank; ambank; bank_islam; bank_muamalat; bank_of_china; bank_rakyat; bnp_paribas; bsn; cimb; citibank; deutsche_bank; hong_leong_bank; hsbc; kfh; maybank2e; maybank2u; mbsb_bank; ocbc; pb_enterprise; public_bank; rhb; standard_chartered; uob. |
|
|
text |
[pt] O banco do cliente, se informado. Pode ser um de abn_amro, adyen, asn_bank, bunq, buut, finom, handelsbanken, ing, knab, mollie, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot ou yoursafe. Valores possíveis: abn_amro; adyen; asn_bank; bunq; buut; finom; handelsbanken; ing; knab; mollie; moneyou; n26; nn; rabobank; regiobank; revolut; sns_bank; triodos_bank; van_lanschot; yoursafe. |
|
|
text |
[pt] Bank Identifier Code (BIC) do banco do cliente, se o banco foi informado. Valores possíveis: ABNANL2A; ADYBNL2A; ASNBNL21; BITSNL2A; BUNQNL2A; BUUTNL2A; FNOMNL22; FVLBNL22; HANDNL2A; INGBNL2A; KNABNL2H; MLLENL2A; MOYONL21; NNBANL2G; NTSBDEB1; RABONL2U; RBRBNL21; REVOIE23; REVOLT21; SNSBNL2A; TRIONL2U. |
|
|
text |
[pt] Bandeira do cartão. Pode ser interac, mastercard ou visa. |
|
|
text |
[pt] Nome do titular do cartão conforme lido do cartão, no formato ISO 7813. Pode incluir caracteres alfanuméricos, caracteres especiais e o separador de nome/sobrenome (/). Em alguns casos, o nome do titular pode não estar disponível, dependendo de como o emissor configurou o cartão. |
|
|
text |
[pt] Código ISO de duas letras que representa o país do cartão. Você pode usar este atributo para ter uma noção da distribuição internacional dos cartões que coletou. |
|
|
text |
[pt] Descrição de alto nível do tipo de cartões emitidos nesta faixa. |
|
|
int |
[pt] Número de dois dígitos que representa o mês de validade do cartão. |
|
|
int |
[pt] Número de quatro dígitos que representa o ano de validade do cartão. |
|
|
text |
[pt] Identifica de forma única este número de cartão específico. Você pode usar este atributo para verificar, por exemplo, se dois clientes que se cadastraram usam o mesmo número de cartão. |
|
|
text |
[pt] Tipo de financiamento do cartão. Pode ser credit, debit, prepaid ou unknown. |
|
|
text |
[pt] O nome do banco emissor do cartão. |
|
|
text |
[pt] Os últimos quatro dígitos do cartão. |
|
|
text |
[pt] A rede preferencial para o cartão. |
|
|
text |
[pt] Como os dados do cartão foram lidos nesta transação. Valores possíveis: contact_emv = chip inserido (EMV); contactless_emv = aproximação (EMV); contactless_magstripe_mode = aproximação em modo tarja; magnetic_stripe_fallback = tarja magnética após falha do chip; magnetic_stripe_track2 = tarja magnética (trilha 2). |
|
|
int |
[pt] O dia de nascimento, entre 1 e 31. |
|
|
int |
[pt] O mês de nascimento, entre 1 e 12. |
|
|
int |
[pt] O ano de nascimento com quatro dígitos. |
|
|
text |
[pt] A bandeira local do cartão de crédito ou débito. Valores possíveis: bc; citi; hana; hyundai; jeju; jeonbuk; kakaobank; kbank; kdbbank; kookmin; kwangju; lotte; mg; nh; post; samsung; savingsbank; shinhan; shinhyup; suhyup; tossbank; woori. |
|
|
text |
[pt] Os últimos quatro dígitos do cartão. Pode não estar presente em cartões American Express. |
|
|
text |
[pt] E-mail do titular da conta. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Identifica de forma única esta conta Naver Pay. Você pode usar este atributo para verificar se duas contas Naver Pay são a mesma. |
|
|
text |
[pt] Se esta transação será financiada com pontos Naver Pay ou com um cartão. Valores possíveis: card = financiado com cartão; points = financiado com pontos Naver Pay. |
|
|
text |
[pt] O nome na conta bancária. Presente apenas se o nome do titular da conta for diferente do nome do signatário autorizado coletado nos detalhes de cobrança do PaymentMethod. |
|
|
text |
[pt] O código numérico do banco da conta bancária. |
|
|
text |
[pt] O nome do banco. |
|
|
text |
[pt] O código numérico da agência bancária da conta bancária. |
|
|
text |
[pt] Últimos quatro dígitos do número da conta bancária. |
|
|
text |
[pt] O sufixo do número da conta bancária. |
|
|
text |
[pt] O banco do cliente, se informado. Valores possíveis: alior_bank; bank_millennium; bank_nowy_bfg_sa; bank_pekao_sa; banki_spbdzielcze; blik; bnp_paribas; boz; citi_handlowy; credit_agricole; envelobank; etransfer_pocztowy24; getin_bank; ideabank; ing; inteligo; mbank_mtransfer; nest_przelew; noble_pay; pbac_z_ipko; plus_bank; santander_przelew24; tmobile_usbugi_bankowe; toyota_bank; velobank; volkswagen_bank. |
|
|
text |
[pt] Código ISO de duas letras que representa o país do comprador. Os valores são fornecidos diretamente pelo PayPal (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] E-mail do titular. Os valores são fornecidos diretamente pelo PayPal (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] PayerID da conta PayPal. Este identificador identifica de forma única o cliente do PayPal. |
|
|
text |
[pt] Número Bank-State-Branch (BSB) da conta bancária. |
|
|
text |
[pt] Últimos quatro dígitos do número da conta bancária. |
|
|
text |
[pt] Alias PayID da conta bancária. |
|
|
text |
[pt] Identifica de forma única esta conta Pix. Você pode usar este atributo para verificar se duas contas Pix são a mesma. |
|
|
text |
[pt] Uma Radar Session é um instantâneo dos metadados do navegador e dos detalhes do dispositivo que ajudam o Radar a fazer previsões mais precisas sobre seus pagamentos. |
|
|
text |
[pt] Código do banco associado à conta bancária. |
|
|
text |
[pt] Código da agência do banco associado à conta bancária. |
|
|
text |
[pt] Código ISO de duas letras que representa o país onde a conta bancária está localizada. |
|
|
text |
[pt] Identifica de forma única esta conta bancária. Você pode usar este atributo para verificar se duas contas bancárias são a mesma. |
|
|
text |
[pt] ID da cobrança que gerou este meio de pagamento (PaymentMethod), se houver. |
|
|
text |
[pt] O ID do SetupAttempt que gerou este PaymentMethod, se houver. |
|
|
text |
[pt] Últimos quatro caracteres do IBAN. |
|
|
text |
[pt] Código ISO de duas letras que representa o país onde a conta bancária está localizada. |
|
|
text |
[pt] O tipo do PaymentMethod. Um hash adicional é incluído no PaymentMethod com nome correspondente a este valor. Ele contém informações adicionais específicas do tipo de PaymentMethod. Valores possíveis: acss_debit = débito pré-autorizado ACSS (Canadá); affirm = Affirm (parcelamento, EUA); afterpay_clearpay = Afterpay/Clearpay (parcelamento); alipay = Alipay (carteira digital, China); alma = Alma (parcelamento, França); amazon_pay = Amazon Pay (carteira digital); au_becs_debit = débito em conta BECS (Austrália); bacs_debit = débito em conta Bacs (Reino Unido); bancontact = Bancontact (Bélgica); billie = Billie (pagamento B2B a prazo); bizum = Bizum (pagamento móvel, Espanha); blik = BLIK (pagamento móvel, Polônia); boleto = boleto bancário (Brasil); card = cartão (online); card_present = cartão presencial (Terminal); cashapp = Cash App Pay (EUA); crypto = criptomoeda (stablecoin); custom = meio de pagamento personalizado; customer_balance = saldo do cliente (transferência bancária); eps = EPS (transferência, Áustria); fpx = FPX (transferência, Malásia); giropay = giropay (transferência, Alemanha); grabpay = GrabPay (carteira digital, Sudeste Asiático); ideal = iDEAL (transferência, Holanda); interac_present = cartão Interac presencial (Canadá); kakao_pay = Kakao Pay (carteira digital, Coreia); klarna = Klarna (meio de pagamento); konbini = Konbini (pagamento em loja, Japão); kr_card = cartão coreano; link = Link (checkout salvo da Stripe); mb_way = MB WAY (pagamento móvel, Portugal); mobilepay = MobilePay (carteira digital, Nórdicos); multibanco = Multibanco (referência bancária, Portugal); naver_pay = Naver Pay (carteira digital, Coreia); nz_bank_account = débito em conta (Nova Zelândia); oxxo = OXXO (pagamento em loja, México); p24 = Przelewy24 (transferência, Polônia); pay_by_bank = pagamento via banco (open banking); payco = PAYCO (carteira digital, Coreia); paynow = PayNow (QR code, Singapura); paypal = PayPal (carteira digital); paypay = PayPay (carteira digital, Japão); payto = PayTo (débito em conta, Austrália); pix = Pix (pagamento instantâneo, Brasil); promptpay = PromptPay (QR code, Tailândia); revolut_pay = Revolut Pay (carteira digital); samsung_pay = Samsung Pay (carteira digital); satispay = Satispay (pagamento móvel, Itália); scalapay = Scalapay (parcelamento, Europa); sepa_debit = débito em conta SEPA (Europa); sequra = SeQura (parcelamento, Espanha); sofort = Sofort (transferência, Europa); sunbit = Sunbit (parcelamento, EUA); swish = Swish (pagamento móvel, Suécia); twint = TWINT (pagamento móvel, Suíça); upi = UPI (pagamento instantâneo, Índia); us_bank_account = débito em conta ACH (EUA); wechat_pay = WeChat Pay (carteira digital, China); zip = Zip (parcelamento). |
|
|
text |
[pt] Virtual Payment Address (VPA) único do cliente… |
|
|
text |
[pt] Tipo de titular da conta: individual ou company. Valores possíveis: company = titular pessoa jurídica; individual = titular pessoa física. |
|
|
text |
[pt] Tipo de conta: checkings ou savings. Assume checking se omitido. Valores possíveis: checking = conta corrente; savings = conta poupança. |
|
|
text |
[pt] O nome do banco. |
|
|
text |
[pt] ID da conta do Financial Connections usada para criar o meio de pagamento. |
|
|
text |
[pt] Identifica de forma única esta conta bancária. Você pode usar este atributo para verificar se duas contas bancárias são a mesma. |
|
|
text |
[pt] Últimos quatro dígitos do número da conta bancária. |
|
|
text |
[pt] A rede preferencial. |
|
|
text |
[pt] Número de roteamento (routing number) da conta bancária. |
|
|
text |
[pt] Código da rede ACH que resultou neste bloqueio. Valores possíveis: R02 = ACH R02: conta encerrada; R03 = ACH R03: conta inexistente ou não localizada; R04 = ACH R04: número de conta inválido; R05 = ACH R05: débito corporativo não autorizado; R07 = ACH R07: autorização revogada pelo cliente; R08 = ACH R08: pagamento sustado; R10 = ACH R10: débito não autorizado pelo cliente; R11 = ACH R11: débito fora dos termos autorizados; R16 = ACH R16: conta bloqueada; R20 = ACH R20: conta não transacional; R29 = ACH R29: corporativo não autorizou; R31 = ACH R31: devolução aceita pelo originador. |
|
|
text |
[pt] O motivo pelo qual a impressão digital (fingerprint) deste PaymentMethod foi bloqueada… Valores possíveis: bank_account_closed = conta bancária encerrada; bank_account_frozen = conta bancária congelada; bank_account_invalid_details = dados da conta bancária inválidos; bank_account_restricted = conta bancária com restrição; bank_account_unusable = conta bancária inutilizável; debit_not_authorized = débito não autorizado pelo titular; tokenized_account_number_deactivated = número de conta tokenizado desativado. |
stripe_customer_payment_methods_car_gen_payment_method_d
Clientes - Detalhes - Meios de pagamento: card.generated_from.payment_method_details (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor autorizado… |
|
|
text |
[pt] Bandeira do cartão. Pode ser amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa ou unknown. |
|
|
text |
[pt] O código de produto que identifica o programa ou produto específico associado a um cartão. |
|
|
timestamp |
[pt] Ao usar captura manual, um timestamp futuro após o qual a cobrança será reembolsada automaticamente se não for capturada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Nome do titular do cartão conforme lido do cartão, no formato ISO 7813. Pode incluir caracteres alfanuméricos, caracteres especiais e o separador de nome/sobrenome (/). Em alguns casos, o nome do titular pode não estar disponível, dependendo de como o emissor configurou o cartão. |
|
|
text |
[pt] Código ISO de duas letras que representa o país do cartão. Você pode usar este atributo para ter uma noção da distribuição internacional dos cartões que coletou. |
|
|
text |
[pt] Descrição de alto nível do tipo de cartões emitidos nesta faixa. |
|
|
text |
[pt] Criptograma da resposta de autorização. |
|
|
int |
[pt] Número de dois dígitos que representa o mês de validade do cartão. |
|
|
int |
[pt] Número de quatro dígitos que representa o ano de validade do cartão. |
|
|
text |
[pt] Identifica de forma única este número de cartão específico. Você pode usar este atributo para verificar, por exemplo, se dois clientes que se cadastraram usam o mesmo número de cartão. |
|
|
text |
[pt] Tipo de financiamento do cartão. Pode ser credit, debit, prepaid ou unknown. |
|
|
text |
[pt] ID de um PaymentMethod de cartão gerado a partir do PaymentMethod card_present, que pode ser anexado a um cliente para transações futuras. Presente apenas se foi possível gerar um PaymentMethod de cartão. |
|
|
boolean |
[pt] Se esta intenção de pagamento (PaymentIntent) é elegível para autorizações incrementais. Solicite suporte usando request_incremental_authorization_support. Valores: true (sim) ou false (não). |
|
|
text |
[pt] O nome do banco emissor do cartão. |
|
|
text |
[pt] Os últimos quatro dígitos do cartão. |
|
|
text |
[pt] ID do local (location) ao qual o leitor desta transação está atribuído. |
|
|
text |
[pt] Identifica em qual rede esta cobrança foi processada. Pode ser amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa ou unknown. |
|
|
text |
[pt] Usado pelas redes financeiras para identificar uma transação. A Visa o chama de Transaction ID, a Mastercard de Trace ID e a American Express de Acquirer Reference Data. |
|
|
timestamp |
[pt] Momento em que o pagamento foi coletado offline… Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O método usado para processar este meio de pagamento offline. Somente deferred é permitido. Valores possíveis: deferred = processamento diferido (offline). |
|
|
boolean |
[pt] Define se o valor autorizado pode ser capturado a mais (over-capture) ou não… Valores: true (sim) ou false (não). |
|
|
text |
[pt] Como os dados do cartão foram lidos nesta transação. Valores possíveis: contact_emv = chip inserido (EMV); contactless_emv = aproximação (EMV); contactless_magstripe_mode = aproximação em modo tarja; magnetic_stripe_fallback = tarja magnética após falha do chip; magnetic_stripe_track2 = tarja magnética (trilha 2). |
|
|
text |
[pt] ID do leitor em que esta transação foi realizada. |
|
|
text |
[pt] O tipo de conta sendo debitada ou creditada… Valores possíveis: checking = conta corrente; credit = conta de crédito; prepaid = conta pré-paga; unknown = tipo desconhecido. |
|
|
text |
[pt] Application Cryptogram, valor único gerado pelo cartão para autenticar a transação junto aos emissores. |
|
|
text |
[pt] Application Identifier (AID) do cartão, usado para determinar quais redes são elegíveis para processar a transação. Referente à EMV tag 9F12, dado codificado no chip do cartão. |
|
|
text |
[pt] Identificador desta transação. |
|
|
text |
[pt] EMV tag 8A. Código retornado pelo emissor do cartão. |
|
|
text |
[pt] Descreve o método usado pelo titular do cartão para verificar a posse do cartão. Um dos seguintes: approval, failure, none, offline_pin, offline_pin_and_signature, online_pin ou signature. |
|
|
text |
[pt] Semelhante a application_preferred_name, identifica os aplicativos (AIDs) disponíveis no cartão. Referente à EMV tag 84. |
|
|
text |
[pt] String de 5 bytes que registra as verificações e validações realizadas entre o cartão e o terminal. Essas verificações determinam como o terminal processa a transação e qual tolerância a risco é aceitável. Referente à EMV Tag 95. |
|
|
text |
[pt] Indicação de quais etapas foram concluídas durante a leitura do cartão. Referente à EMV Tag 9B. |
|
|
text |
[pt] O tipo de carteira digital móvel, um entre apple_pay, google_pay, samsung_pay ou unknown. Valores possíveis: apple_pay = Apple Pay (carteira); google_pay = Google Pay (carteira); samsung_pay = Samsung Pay (carteira digital); unknown = tipo de ID fiscal desconhecido. |
stripe_customer_payment_methods_car_gen_pay_preferred_lo
Clientes - Detalhes - Meios de pagamento: card.generated_from.payment_method_details.preferred_locales (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_customer_payment_methods_car_gen_payment_method_d, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os idiomas que o banco emissor recomenda usar para localizar qualquer texto voltado ao cliente, conforme lido do cartão. Referenciado da tag EMV 5F2D, dado codificado no chip do cartão. |
stripe_customer_payment_methods_card_networks_available
Clientes - Detalhes - Meios de pagamento: card.networks.available (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Todas as redes disponíveis para seleção por meio de payment_method_options.card.network. |
stripe_customer_payment_methods_card__networks_available
Clientes - Detalhes - Meios de pagamento: card_present.networks.available (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Todas as redes disponíveis para seleção por meio de payment_method_options.card.network. |
stripe_customer_payment_methods_card_p_preferred_locales
Clientes - Detalhes - Meios de pagamento: card_present.preferred_locales (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os idiomas que o banco emissor recomenda usar para localizar qualquer texto voltado ao cliente, conforme lido do cartão. Referenciado da tag EMV 5F2D, dado codificado no chip do cartão. |
stripe_customer_payment_methods_inter_networks_available
Clientes - Detalhes - Meios de pagamento: interac_present.networks.available (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Todas as redes disponíveis para seleção por meio de payment_method_options.card.network. |
stripe_customer_payment_methods_intera_preferred_locales
Clientes - Detalhes - Meios de pagamento: interac_present.preferred_locales (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os idiomas que o banco emissor recomenda usar para localizar qualquer texto voltado ao cliente, conforme lido do cartão. Referenciado da tag EMV 5F2D, dado codificado no chip do cartão. |
stripe_customer_payment_methods_metadata
Clientes - Detalhes - Meios de pagamento: metadata (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_customer_payment_methods_us_ba_networks_supported
Clientes - Detalhes - Meios de pagamento: us_bank_account.networks.supported (uma linha por item; liga-se a stripe_customer_payment_methods pela coluna payment_method_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_payment_methods). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Todas as redes suportadas. Valores possíveis: ach = ACH (EUA); us_domestic_wire = transferência bancária doméstica (EUA). |
Clientes - Detalhes - Transações de saldo do cliente
Tipo de replicação: Integral
Relacionamentos:
- customer_id → Clientes > id
- credit_note → Notas de crédito > id
- customer → Clientes > id
- invoice → Faturas > id
- customer_id > _customer_balance_transactions_metadata → Clientes > id
- customer_balance_transaction_id > _customer_balance_transactions_metadata → Clientes - Detalhes - Transações de saldo do cliente > id
Objeto principal
Transações do saldo de crédito de cada cliente (créditos, débitos e aplicação em faturas).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor da transação. Um valor negativo é um crédito no saldo do cliente, e um valor positivo é um débito no saldo do cliente. |
|
|
text |
[pt] O ID da sessão de checkout (se houver) que criou a transação. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O ID da nota de crédito (se houver) relacionada à transação. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] O ID do cliente ao qual a transação pertence. |
|
|
text |
[pt] O ID de uma conta (Account) que representa um cliente ao qual a transação pertence. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O saldo do cliente após a aplicação da transação. Um valor negativo diminui o valor devido na próxima fatura do cliente. Um valor positivo aumenta o valor devido na próxima fatura do cliente. |
|
|
text |
[pt] O ID da fatura (se houver) relacionada à transação. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Tipo de transação: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment ou checkout_session_subscription_payment_canceled. Valores possíveis: adjustment = ajuste de saldo; applied_to_invoice = saldo aplicado a uma fatura; checkout_session_subscription_payment = pagamento de assinatura via Checkout; checkout_session_subscription_payment_canceled = pagamento de assinatura Checkout cancelado; credit_note = nota de crédito; initial = saldo inicial; invoice_overpaid = fatura paga a mais; invoice_too_large = fatura grande demais, saldo devolvido; invoice_too_small = fatura abaixo do mínimo cobrável; migration = migração de saldo; unapplied_from_invoice = saldo desaplicado de fatura; unspent_receiver_credit = crédito não utilizado de recebimento. |
stripe_customer_balance_transactions_metadata
Clientes - Detalhes - Transações de saldo do cliente: metadata (uma linha por item; liga-se a stripe_customer_balance_transactions pela coluna customer_balance_transaction_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_customers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_customer_balance_transactions). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Cobranças
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- balance_transaction → Transações de saldo > id
- customer → Clientes > id
- payment_intent → Intenções de pagamento (PaymentIntents) > id
- transfer → Transferências > id
- charge_id > _charges_metadata → Cobranças > id
- charge_id > _charges_payment_method_details → Cobranças > id
- charge_id > _charges_payment_method_details_preferred_locales → Cobranças > id
- charge_id > _charges_paym_seller_protection_dispute_categories → Cobranças > id
Objeto principal
Cobranças: cada tentativa de cobrar o cliente (cartão, boleto, Pix...), paga ou recusada. Valores na moeda cobrada do cliente (coluna currency, ex.: usd); o mesmo valor convertido para a moeda do seu saldo Stripe (ex.: reais), com a tarifa da Stripe e o líquido, está nas colunas balance_transaction_amount, balance_transaction_fee e balance_transaction_net. Para faturamento use status = succeeded; recusas têm status = failed e o motivo em outcome_reason / failure_code.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que se pretende cobrar por este pagamento. Valor que representa quanto cobrar. O valor mínimo é US$ 0,50 ou o equivalente na moeda da cobrança. Na moeda cobrada do cliente (coluna currency). O mesmo valor na moeda do seu saldo Stripe (ex.: reais) está em balance_transaction_amount. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor capturado (pode ser menor que o atributo amount da cobrança se foi feita uma captura parcial). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor reembolsado (pode ser menor que o atributo amount da cobrança se foi emitido um reembolso parcial). |
|
|
text |
[pt] ID do aplicativo Connect que criou a cobrança. |
|
|
text |
[pt] A taxa de aplicação (se houver) da cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor da taxa de aplicação (se houver) solicitada para a cobrança. |
|
|
text |
[pt] ID da transação de saldo que descreve o impacto desta cobrança no saldo da sua conta (sem incluir reembolsos ou contestações). |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] Endereço de e-mail. |
|
|
text |
[pt] Nome completo. |
|
|
text |
[pt] Telefone de cobrança (incluindo ramal). |
|
|
text |
[pt] Número de identificação do contribuinte. Usado apenas em transações entre compradores da América Latina (LATAM) e vendedores de fora da LATAM. |
|
|
text |
[pt] O descritor de fatura completo que é repassado às redes de cartão e exibido nas faturas de cartão de crédito e extratos bancários dos seus clientes. Permite ver como fica o descritor após a combinação das partes estática e dinâmica. Este valor só existe para pagamentos com cartão. |
|
|
boolean |
[pt] Se a cobrança foi criada sem captura, este booleano indica se ela ainda não foi capturada ou se já foi capturada desde então. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] ID do cliente ao qual esta cobrança se refere, se existir. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
boolean |
[pt] Se a cobrança foi contestada. Valores: true (sim) ou false (não). |
|
|
text |
[pt] ID da transação de saldo que descreve a reversão do saldo na sua conta devido à falha do pagamento. |
|
|
text |
[pt] Código de erro que explica o motivo da falha da cobrança, se disponível (consulte a seção de erros para a lista de códigos). Códigos mais comuns: insufficient_funds = saldo insuficiente; do_not_honor = recusada pelo banco sem motivo; card_velocity_exceeded = limite de tentativas/valor excedido; lost_card / stolen_card = cartão perdido/roubado (não tente de novo); expired_card = cartão vencido; transaction_not_allowed = transação não permitida no cartão; previously_declined_do_not_retry = recusada antes, a Stripe bloqueou nova tentativa; try_again_later = tente mais tarde; invalid_account = conta/cartão inválido; highest_risk_level = bloqueada pelo antifraude. |
|
|
text |
[pt] Mensagem ao usuário que explica melhor o motivo da falha da cobrança, se disponível. |
|
|
text |
[pt] Avaliações da Stripe. Se definido, o valor é fraudulent. |
|
|
text |
[pt] Avaliações informadas por você. Se definido, os valores possíveis são safe e fraudulent. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] A conta (se houver) em nome da qual a cobrança foi feita, sem acionar uma transferência automática. |
|
|
text |
[pt] Um valor enumerado que fornece uma explicação mais detalhada sobre como proceder diante de um erro. Valores possíveis: confirm_card_data = confirmar dados do cartão antes de tentar; do_not_try_again = não tentar novamente; try_again_later = tentar novamente mais tarde. |
|
|
text |
[pt] Para cobranças recusadas pela rede, um código de 2 dígitos que indica a orientação retornada pela rede sobre como proceder diante de um erro. |
|
|
text |
[pt] Para cobranças recusadas pela rede, um código alfanumérico que indica o motivo da falha da cobrança. |
|
|
text |
[pt] Os valores possíveis são approved_by_network, declined_by_network, not_sent_to_network e reversed_after_approval. O valor reversed_after_approval indica que o pagamento foi bloqueado pela Stripe após a autorização do banco e pode aparecer temporariamente como "pendente" no extrato do titular do cartão. |
|
|
text |
[pt] Um valor enumerado que fornece uma explicação mais detalhada do tipo do resultado. Cobranças bloqueadas pela regra de bloqueio padrão do Radar têm o valor highest_risk_level. Cobranças colocadas em revisão pela regra de revisão padrão do Radar têm o valor elevated_risk_level. Códigos mais comuns: insufficient_funds = saldo insuficiente; do_not_honor = recusada pelo banco sem motivo; card_velocity_exceeded = limite de tentativas/valor excedido; lost_card / stolen_card = cartão perdido/roubado (não tente de novo); expired_card = cartão vencido; transaction_not_allowed = transação não permitida no cartão; previously_declined_do_not_retry = recusada antes, a Stripe bloqueou nova tentativa; try_again_later = tente mais tarde; invalid_account = conta/cartão inválido; highest_risk_level = bloqueada pelo antifraude. |
|
|
text |
[pt] Avaliação do Stripe Radar sobre o risco do pagamento. Os valores possíveis para pagamentos avaliados são normal, elevated, highest. Em pagamentos que não sejam de cartão e pagamentos com cartão anteriores à atribuição pública de níveis de risco, este campo terá o valor not_assessed. |
|
|
int |
[pt] Avaliação do Stripe Radar sobre o risco do pagamento. Os valores possíveis para pagamentos avaliados ficam entre 0 e 100. Em pagamentos que não sejam de cartão, pagamentos com cartão anteriores à atribuição pública de pontuações de risco, ou em caso de erro durante a avaliação, este campo não estará presente. |
|
|
text |
[pt] O ID da regra do Radar que correspondeu ao pagamento, se aplicável. |
|
|
text |
[pt] Uma descrição legível do tipo e do motivo do resultado, pensada para você (o destinatário do pagamento), e não para o seu cliente. |
|
|
text |
[pt] Os valores possíveis são authorized, manual_review, issuer_declined, blocked e invalid. Consulte understanding declines e Radar reviews para mais detalhes. authorized = aprovada; issuer_declined = recusada pelo banco emissor; blocked = bloqueada pelo antifraude da Stripe; manual_review = em revisão manual; invalid = dados inválidos. |
|
|
boolean |
[pt] true se a cobrança foi bem-sucedida ou foi autorizada com sucesso para captura posterior. Valores: true (sim) ou false (não). |
|
|
text |
[pt] ID do PaymentIntent associado a esta cobrança, se existir. |
|
|
text |
[pt] ID do método de pagamento usado nesta cobrança. |
|
|
text |
[pt] O tipo de detalhes específicos da transação do método de pagamento usado no pagamento. Veja PaymentMethod.type para a lista completa de tipos possíveis. Um hash adicional é incluído em payment_method_details com nome correspondente a este valor. Ele contém informações específicas do método de pagamento. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que se pretende cobrar por este pagamento, denominado em presentment_currency. |
|
|
text |
[pt] Moeda apresentada ao cliente durante o pagamento. |
|
|
text |
[pt] Uma Radar Session é um instantâneo dos metadados do navegador e dos detalhes do dispositivo que ajudam o Radar a fazer previsões mais precisas sobre seus pagamentos. |
|
|
text |
[pt] Este é o endereço de e-mail para o qual o recibo desta cobrança foi enviado. |
|
|
text |
[pt] Este é o número da transação que aparece nos recibos enviados por e-mail para esta cobrança. Este atributo será null até que um recibo seja enviado. |
|
|
text |
[pt] Esta é a URL para visualizar o recibo desta cobrança. O recibo é mantido atualizado com o estado mais recente da cobrança, incluindo quaisquer reembolsos. Se a cobrança for de uma fatura, o recibo será estilizado como um recibo de fatura. |
|
|
boolean |
[pt] Se a cobrança foi totalmente reembolsada. Se a cobrança foi reembolsada apenas parcialmente, este atributo continuará false. Valores: true (sim) ou false (não). |
|
|
text |
[pt] ID da revisão associada a esta cobrança, se existir. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] A transportadora que enviou um produto físico, como Fedex, UPS, USPS etc. |
|
|
text |
[pt] Nome do destinatário. |
|
|
text |
[pt] Telefone do destinatário (incluindo ramal). |
|
|
text |
[pt] O código de rastreamento de um produto físico, obtido da transportadora. Se vários códigos de rastreamento foram gerados para esta compra, separe-os por vírgulas. |
|
|
text |
[pt] O ID da transferência que criou esta cobrança. Presente apenas se a cobrança veio de outra conta Stripe. |
|
|
text |
[pt] Em uma cobrança que não seja de cartão, texto que aparece no extrato do cliente como descritor de extrato. Este valor substitui o descritor de extrato padrão da conta. Para informações sobre os requisitos, incluindo o limite de 22 caracteres, consulte a documentação de Statement Descriptor. |
|
|
text |
[pt] Fornece informações sobre uma cobrança de cartão. Concatenado ao prefixo do descritor de extrato da conta para formar o descritor de extrato completo que aparece no extrato do cliente. Se a conta não tiver prefixo, o sufixo é concatenado ao descritor de extrato da conta. |
|
|
text |
[pt] O status do pagamento é succeeded, pending ou failed. Valores possíveis: failed = falhou; pending = pendente; succeeded = concluído com sucesso. |
|
|
text |
[pt] ID da transferência para a conta de destino (aplicável somente se a cobrança foi criada com o parâmetro destination). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor transferido para a conta de destino, se especificado. Por padrão, o valor total da cobrança é transferido para a conta de destino. |
|
|
text |
[pt] ID de uma conta Stripe conectada existente para a qual transferir fundos, se transfer_data foi especificado na solicitação de cobrança. |
|
|
text |
[pt] Uma string que identifica esta transação como parte de um grupo. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Este valor convertido para a moeda do seu saldo Stripe (ex.: reais), como entrou no saldo. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Tarifa da Stripe sobre esta transação, na moeda do seu saldo Stripe. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Líquido (valor menos a tarifa da Stripe), na moeda do seu saldo Stripe: o que de fato você recebe. |
|
|
text |
[pt] Moeda do seu saldo Stripe em que estão balance_transaction_amount, balance_transaction_fee e balance_transaction_net (ex.: brl = reais). |
|
|
float |
[pt] Câmbio usado para converter o valor para a moeda do saldo (amount × exchange_rate = balance_transaction_amount). Vazio quando não houve conversão. |
|
|
timestamp |
[pt] Data em que o dinheiro fica disponível no seu saldo Stripe para ser repassado ao banco. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Se o dinheiro já está disponível no seu saldo Stripe (available) ou ainda não (pending). |
stripe_charges_metadata
Cobranças: metadata (uma linha por item; liga-se a stripe_charges pela coluna charge_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_charges). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_charges_payment_method_details
Cobranças: payment_method_details (uma linha por item; liga-se a stripe_charges pela coluna charge_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_charges). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] O nome na conta bancária. Presente apenas se o nome do titular da conta for diferente do nome do signatário autorizado coletado nos detalhes de cobrança do PaymentMethod. |
|
|
text |
[pt] Tipo de entidade titular da conta. Pode ser individual ou company. Valores possíveis: company = titular pessoa jurídica; individual = titular pessoa física. |
|
|
text |
[pt] Número da conta para a qual transferir os fundos. |
|
|
text |
[pt] Tipo de conta: checkings ou savings. Assume checking se omitido. Valores possíveis: checking = conta corrente; savings = conta poupança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor autorizado. |
|
|
text |
[pt] Código de autorização da cobrança. |
|
|
text |
[pt] O banco do cliente. Valores possíveis: arzte_und_apotheker_bank; austrian_anadi_bank_ag; bank_austria; bankhaus_carl_spangler; bankhaus_schelhammer_und_schattera_ag; bawag_psk_ag; bks_bank_ag; brull_kallmus_bank_ag; btv_vier_lander_bank; capital_bank_grawe_gruppe_ag; deutsche_bank_ag; dolomitenbank; easybank_ag; erste_bank_und_sparkassen; hypo_alpeadriabank_international_ag; hypo_bank_burgenland_aktiengesellschaft; hypo_noe_lb_fur_niederosterreich_u_wien; hypo_oberosterreich_salzburg_steiermark; hypo_tirol_bank_ag; hypo_vorarlberg_bank_ag; marchfelder_bank; oberbank_ag; raiffeisen_bankengruppe_osterreich; schoellerbank_ag; sparda_bank_wien; volksbank_gruppe; volkskreditbank_ag; vr_bank_braunau. |
|
|
text |
[pt] Código do banco associado à conta bancária. |
|
|
text |
[pt] Nome do banco associado ao número de roteamento (routing number). |
|
|
text |
[pt] Id único da transação gerado pelo BCB… |
|
|
text |
[pt] Bank Identifier Code (BIC) do banco associado à conta bancária. |
|
|
text |
[pt] O código numérico da agência bancária da conta bancária. |
|
|
text |
[pt] Bandeira do cartão. Pode ser amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa ou unknown. |
|
|
text |
[pt] O código de produto que identifica o programa ou produto específico associado a um cartão. |
|
|
text |
[pt] Número Bank-State-Branch (BSB) da conta bancária. |
|
|
text |
[pt] O endereço da carteira (wallet) do cliente. |
|
|
text |
[pt] Identifica de forma única esta conta Alipay. Você pode usar este atributo para verificar se duas contas Alipay são a mesma. |
|
|
timestamp |
[pt] Ao usar captura manual, um timestamp futuro em que a cobrança será reembolsada automaticamente se não for capturada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Bandeira do cartão usado na transação… |
|
|
text |
[pt] Código ISO de duas letras que representa o país do cartão… |
|
|
int |
[pt] Número de dois dígitos que representa o mês de expiração do cartão… |
|
|
int |
[pt] Número de dois dígitos que representa o ano de expiração do cartão… |
|
|
text |
[pt] Os últimos 4 dígitos do cartão… |
|
|
text |
[pt] Nome do titular do cartão conforme lido do cartão, no formato ISO 7813. Pode incluir caracteres alfanuméricos, caracteres especiais e o separador de nome/sobrenome (/). Em alguns casos, o nome do titular pode não estar disponível, dependendo de como o emissor configurou o cartão. |
|
|
text |
[pt] Identificador público de compradores que usam o Cash App. |
|
|
text |
[pt] Se a linha 1 do endereço (line1) foi fornecida, o resultado da verificação: pass, fail, unavailable ou unchecked. |
|
|
text |
[pt] Se o código postal do endereço foi fornecido, o resultado da verificação: pass, fail, unavailable ou unchecked. |
|
|
text |
[pt] Se um CVC foi fornecido, o resultado da verificação: pass, fail, unavailable ou unchecked. |
|
|
text |
[pt] Código ISO de duas letras que representa o país onde a conta bancária está localizada. |
|
|
text |
[pt] Descrição de alto nível do tipo de cartões emitidos nesta faixa. |
|
|
text |
[pt] Electronic Commerce Indicator (ECI) retornado pela rede do cartão na resposta de autorização. Indica o nível de autenticação usado. Preenchido apenas em transações Visa e Mastercard. É o ECI final da rede e pode diferir do valor da requisição. |
|
|
text |
[pt] Criptograma da resposta de autorização. |
|
|
text |
[pt] Número da entidade associado a este pagamento Multibanco. |
|
|
int |
[pt] Número de dois dígitos que representa o mês de validade do cartão. |
|
|
int |
[pt] Número de quatro dígitos que representa o ano de validade do cartão. |
|
|
text |
[pt] Data estimada do débito na conta bancária do cliente. String de data no formato YYYY-MM-DD. |
|
|
text |
[pt] Indica se a janela de captura é estendida além da autorização padrão. Valores possíveis: disabled = desativado; enabled = ativado. |
|
|
text |
[pt] Identifica de forma única esta conta bancária. Você pode usar este atributo para verificar se duas contas bancárias são a mesma. |
|
|
text |
[pt] Tipo de cartão (credit, debit, prepaid ou unknown), nos meios de pagamento com cartão. |
|
|
text |
[pt] Bandeira do cartão. Pode ser American Express, Cartes Bancaires, Diners Club, Discover, Eftpos Australia, Girocard, JCB, MasterCard, UnionPay, Visa ou Unknown. |
|
|
text |
[pt] Código ISO de duas letras que representa o país do cartão. Você pode usar este atributo para ter uma noção da distribuição internacional dos cartões que coletou. |
|
|
int |
[pt] Número de dois dígitos que representa o mês de validade do cartão. |
|
|
int |
[pt] Número de quatro dígitos que representa o ano de validade do cartão. |
|
|
text |
[pt] Tipo de financiamento do cartão. Pode ser credit, debit, prepaid ou unknown. |
|
|
text |
[pt] Os últimos quatro dígitos do cartão. |
|
|
text |
[pt] tipo de financiamento do meio de pagamento subjacente. Valores possíveis: card = cartão (online). |
|
|
text |
[pt] O código do grupo de fonte de financiamento aplicado a este pagamento Link no momento da confirmação. |
|
|
text |
[pt] ID de um PaymentMethod de cartão gerado a partir do PaymentMethod card_present, que pode ser anexado a um cliente para transações futuras. Presente apenas se foi possível gerar um PaymentMethod de cartão. |
|
|
text |
[pt] ID do PaymentMethod de débito direto SEPA gerado por esta cobrança. |
|
|
text |
[pt] O mandato do PaymentMethod de débito direto SEPA que foi gerado por esta cobrança. |
|
|
text |
[pt] Últimos quatro caracteres do IBAN. |
|
|
text |
[pt] Indica se há suporte ao recurso de autorização incremental. Valores possíveis: available = disponível; unavailable = indisponível. |
|
|
boolean |
[pt] Se esta intenção de pagamento (PaymentIntent) é elegível para autorizações incrementais. Solicite suporte usando request_incremental_authorization_support. Valores: true (sim) ou false (não). |
|
|
int |
[pt] O número de parcelas. |
|
|
int |
[pt] Em planos de parcelamento fixed_count, é o número de parcelas que o cliente pagará no cartão de crédito. |
|
|
text |
[pt] Em planos de parcelamento fixed_count, é o intervalo entre as parcelas que o cliente pagará no cartão de crédito. Um de month. Valores possíveis: month = mensal. |
|
|
text |
[pt] Tipo de plano de parcelamento, um entre fixed_count, bonus ou revolving. Valores possíveis: bonus = parcelamento bônus; fixed_count = número fixo de parcelas; revolving = crédito rotativo. |
|
|
text |
[pt] Número da instituição da conta bancária… |
|
|
text |
[pt] O nome do banco emissor do cartão. |
|
|
text |
[pt] Últimos quatro dígitos do número da conta bancária. |
|
|
text |
[pt] ID do local (location) ao qual este leitor está atribuído. |
|
|
text |
[pt] ID do mandato usado para realizar este pagamento. |
|
|
text |
[pt] Indica se há suporte a múltiplas capturas. Valores possíveis: available = disponível; unavailable = indisponível. |
|
|
text |
[pt] Identifica em qual rede esta cobrança foi processada. Pode ser amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa ou unknown. |
|
|
boolean |
[pt] Indica se a Stripe usou um token de rede (network token), fornecido pelo usuário ou gerenciado pela Stripe, ao processar a transação. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Usado pelas redes financeiras para identificar uma transação. A Visa o chama de Transaction ID, a Mastercard de Trace ID e a American Express de Acquirer Reference Data. |
|
|
text |
[pt] Número de referência OXXO… |
|
|
timestamp |
[pt] Momento em que o pagamento foi coletado offline… Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O método usado para processar este meio de pagamento offline. Somente deferred é permitido. Valores possíveis: deferred = processamento diferido (offline). |
|
|
text |
[pt] ID do pedido Afterpay associado a esta intenção de pagamento. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor máximo que pode ser capturado. |
|
|
text |
[pt] Indica se o valor autorizado pode ser capturado a mais (over-capture). Valores possíveis: available = disponível; unavailable = indisponível. |
|
|
boolean |
[pt] Define se o valor autorizado pode ser capturado a mais (over-capture) ou não… Valores: true (sim) ou false (não). |
|
|
text |
[pt] Alias PayID da conta bancária. |
|
|
text |
[pt] O país do endereço do pagador… |
|
|
text |
[pt] E-mail do titular. Os valores são fornecidos diretamente pelo PayPal (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] PayerID da conta PayPal. Este identificador identifica de forma única o cliente do PayPal. |
|
|
text |
[pt] Nome completo do titular. Os valores são fornecidos diretamente pelo PayPal (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Meio de pagamento Klarna usado nesta transação. Pode ser pay_later, pay_now, pay_with_financing ou pay_in_installments… |
|
|
text |
[pt] Número de referência do banco do pagador para o pagamento… |
|
|
text |
[pt] Idioma preferido da página de autorização do Bancontact para a qual o cliente é redirecionado. Pode ser en, de, fr ou nl… Valores possíveis: de = alemão; en = inglês; fr = francês; nl = holandês. |
|
|
text |
[pt] Idioma preferido da página de autorização da Klarna para a qual o cliente é redirecionado. |
|
|
text |
[pt] Como os dados do cartão foram lidos nesta transação. Valores possíveis: contact_emv = chip inserido (EMV); contactless_emv = aproximação (EMV); contactless_magstripe_mode = aproximação em modo tarja; magnetic_stripe_fallback = tarja magnética após falha do chip; magnetic_stripe_track2 = tarja magnética (trilha 2). |
|
|
text |
[pt] ID do leitor em que esta transação foi realizada. |
|
|
text |
[pt] O tipo de conta sendo debitada ou creditada… Valores possíveis: checking = conta corrente; credit = conta de crédito; prepaid = conta pré-paga; unknown = tipo desconhecido. |
|
|
text |
[pt] Application Cryptogram, valor único gerado pelo cartão para autenticar a transação junto aos emissores. |
|
|
text |
[pt] Application Identifier (AID) do cartão, usado para determinar quais redes são elegíveis para processar a transação. Referente à EMV tag 9F12, dado codificado no chip do cartão. |
|
|
text |
[pt] Identificador desta transação. |
|
|
text |
[pt] EMV tag 8A. Código retornado pelo emissor do cartão. |
|
|
text |
[pt] Descreve o método usado pelo titular do cartão para verificar a posse do cartão. Um dos seguintes: approval, failure, none, offline_pin, offline_pin_and_signature, online_pin ou signature. |
|
|
text |
[pt] Semelhante a application_preferred_name, identifica os aplicativos (AIDs) disponíveis no cartão. Referente à EMV tag 84. |
|
|
text |
[pt] String de 5 bytes que registra as verificações e validações realizadas entre o cartão e o terminal. Essas verificações determinam como o terminal processa a transação e qual tolerância a risco é aceitável. Referente à EMV Tag 95. |
|
|
text |
[pt] Indicação de quais etapas foram concluídas durante a leitura do cartão. Referente à EMV Tag 9B. |
|
|
text |
[pt] Identificador do pedido exibido ao comerciante no portal online da Afterpay. |
|
|
text |
[pt] Status de um cartão com base no emissor do cartão. Valores possíveis: regulated = cartão regulado (tarifa limitada); unregulated = cartão não regulado. |
|
|
text |
[pt] Routing transit number da conta bancária para a qual transferir os fundos. |
|
|
text |
[pt] Indica se a transação é elegível à proteção ao vendedor do PayPal. Valores possíveis: eligible = elegível à proteção ao vendedor; not_eligible = não elegível à proteção ao vendedor; partially_eligible = parcialmente elegível à proteção. |
|
|
text |
[pt] Sort code da conta bancária. (p. ex., 10-20-30) |
|
|
text |
[pt] O nome da rede de lojas de conveniência onde o pagamento foi concluído. Valores possíveis: familymart = FamilyMart (rede de lojas de conveniência); lawson = Lawson (rede de lojas de conveniência); ministop = Ministop (rede de lojas de conveniência); seicomart = Seicomart (rede de lojas de conveniência). |
|
|
text |
[pt] O sufixo do número da conta bancária. |
|
|
text |
[pt] Código SWIFT do banco associado ao número de roteamento (routing number). |
|
|
text |
[pt] O documento fiscal do cliente (CPF para consumidores pessoa física ou CNPJ para consumidores pessoa jurídica) |
|
|
text |
[pt] Para transações autenticadas: como o cliente foi autenticado pelo banco emissor. Valores possíveis: challenge = cliente teve que se autenticar (desafio); frictionless = autenticado sem interação do cliente. |
|
|
text |
[pt] Electronic Commerce Indicator (ECI). Campo em nível de protocolo que indica o grau de autenticação realizado. Valores possíveis: 01 = ECI 01: autenticação tentada (Mastercard); 02 = ECI 02: totalmente autenticado (Mastercard); 05 = ECI 05: totalmente autenticado (Visa e outras); 06 = ECI 06: autenticação tentada (Visa e outras); 07 = ECI 07: sem autenticação 3DS. |
|
|
text |
[pt] A isenção solicitada via 3DS e aceita pelo emissor no momento da autenticação. Valores possíveis: low_risk = isenção por baixo risco aceita; none = sem isenção. |
|
|
boolean |
[pt] Se a Stripe solicitou o valor de exemption_indicator na transação. Isso dependerá do resultado da avaliação de risco interna da Stripe. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Indica o resultado da autenticação 3D Secure. Valores possíveis: attempt_acknowledged = tentativa reconhecida, sem autenticação completa; authenticated = autenticado com sucesso; data_share_only = apenas compartilhamento de dados; exempted = isento de autenticação; failed = autenticação falhou; not_supported = cartão não suporta 3D Secure; processing_error = erro de processamento. |
|
|
text |
[pt] Informações adicionais sobre o motivo do sucesso ou da falha do 3D Secure, com base no resultado. Valores possíveis: abandoned = cliente abandonou a autenticação; bypassed = 3DS dispensado pelo emissor; canceled = autenticação cancelada; card_not_enrolled = cartão não inscrito no 3DS; network_not_supported = bandeira não suporta 3DS; protocol_error = erro de protocolo 3DS; rejected = emissor rejeitou a autenticação. |
|
|
text |
[pt] XID do 3D Secure 1 ou ID da transação no Directory Server do 3D Secure 2 (dsTransId) deste pagamento. |
|
|
text |
[pt] A versão do 3D Secure que foi usada. Valores possíveis: 1.0.2 = 3D Secure versão 1.0.2; 2.1.0 = 3D Secure versão 2.1.0; 2.2.0 = 3D Secure versão 2.2.0; 2.3.0 = 3D Secure versão 2.3.0; 2.3.1 = 3D Secure versão 2.3.1. |
|
|
text |
[pt] A moeda do token com a qual a transação foi enviada. Valores possíveis: phantom_cash = Phantom Cash (stablecoin); usdc = USDC (stablecoin em dólar); usdg = USDG (stablecoin em dólar); usdp = USDP / Pax Dollar (stablecoin); usdsui = USDsui (stablecoin na rede Sui); usdt = USDT / Tether (stablecoin). |
|
|
text |
[pt] Hash da transação em blockchain do pagamento em cripto. |
|
|
text |
[pt] ID da transação Affirm associada a este pagamento. |
|
|
text |
[pt] O Transaction Link ID (TLID) é um identificador único de uma transação. É usado por algumas redes de cartão, como a Mastercard, para vincular transações, além dos Network Transaction IDs. |
|
|
text |
[pt] Número de trânsito (transit number) da conta bancária. |
|
|
text |
[pt] Nome completo verificado do titular. Os valores são verificados ou fornecidos diretamente pelo Bancontact (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Os últimos quatro dígitos do telefone da conta Swish… |
|
|
text |
[pt] Virtual Payment Address (VPA) único do cliente. |
|
|
text |
[pt] (Somente para números tokenizados.) Os últimos quatro dígitos do número da conta do dispositivo. |
|
|
text |
[pt] O código do grupo de fonte de financiamento aplicado a este pagamento Link no momento da confirmação. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] E-mail verificado do titular. Os valores são verificados ou fornecidos diretamente pela carteira (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Nome completo verificado do titular. Os valores são verificados ou fornecidos diretamente pela carteira (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] O tipo da carteira digital do cartão, um entre amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout ou link. Um hash adicional é incluído no sub-hash Wallet com nome correspondente a este valor. Ele contém informações adicionais específicas do tipo de carteira do cartão. Valores possíveis: amex_express_checkout = Amex Express Checkout (carteira); apple_pay = Apple Pay (carteira); google_pay = Google Pay (carteira); link = Link (checkout salvo da Stripe); masterpass = Masterpass (carteira); samsung_pay = Samsung Pay (carteira digital); visa_checkout = Visa Checkout (carteira). |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] E-mail verificado do titular. Os valores são verificados ou fornecidos diretamente pela carteira (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Nome completo verificado do titular. Os valores são verificados ou fornecidos diretamente pela carteira (se suportado) no momento da autorização ou liquidação. Não podem ser definidos nem alterados. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
stripe_charges_payment_method_details_preferred_locales
Cobranças: payment_method_details.preferred_locales (uma linha por item; liga-se a stripe_charges pela coluna charge_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_charges). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_charges_payment_method_details, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os idiomas que o banco emissor recomenda usar para localizar qualquer texto voltado ao cliente, conforme lido do cartão. Referenciado da tag EMV 5F2D, dado codificado no chip do cartão. |
stripe_charges_paym_seller_protection_dispute_categories
Cobranças: payment_method_details.seller_protection.dispute_categories (uma linha por item; liga-se a stripe_charges pela coluna charge_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_charges). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_charges_payment_method_details, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista de condições cobertas para a transação, se aplicável. Valores possíveis: fraudulent = contestação por fraude; product_not_received = produto não recebido. |
Concessões de crédito
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Créditos concedidos a clientes para cobrança baseada em consumo.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que representa o valor. |
|
|
text |
[pt] O tipo deste valor. Atualmente só oferecemos suporte a créditos de cobrança monetários. Valores possíveis: monetary = crédito monetário. |
|
|
text |
[pt] O tipo de preço ao qual as concessões de crédito podem ser aplicadas. Atualmente só oferecemos suporte ao tipo de preço metered, que se refere a preços que têm um Billing Meter associado. Não pode ser usado em combinação com prices. Valores possíveis: metered = preço por uso medido (Billing Meter). |
|
|
text |
[pt] A categoria desta concessão de crédito. Serve para fins de acompanhamento e não é exibida ao cliente. Valores possíveis: paid = crédito pago; promotional = crédito promocional. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] ID do cliente que recebe os créditos de cobrança. |
|
|
text |
[pt] ID da conta que representa o cliente que recebe os créditos de cobrança… |
|
|
timestamp |
[pt] O momento em que os créditos de cobrança passam a valer, ou seja, quando ficam elegíveis para uso. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O momento em que os créditos de cobrança expiram. Se ausente, os créditos de cobrança não expiram. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Um nome descritivo exibido no dashboard. |
|
|
int |
[pt] A prioridade de aplicação desta concessão de crédito. A maior prioridade é 0 e a menor é 100. |
|
|
text |
[pt] ID do relógio de teste (test clock) ao qual esta concessão de crédito pertence. Só é preenchido em modo de teste (chave sk_test_/rk_test_), quando o registro foi criado preso a um relógio de teste para simular a passagem do tempo; em conta real fica sempre vazio. |
|
|
timestamp |
[pt] Momento em que o objeto foi atualizado pela última vez. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O momento em que esta concessão de crédito foi anulada. Se ausente, a concessão de crédito não foi anulada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
stripe_billing_credit_grants_applicability__scope_prices
Concessões de crédito: applicability_config.scope.prices (uma linha por item; liga-se a stripe_billing_credit_grants pela coluna credit_grant_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_billing_credit_grants). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Identificador único do objeto. |
stripe_billing_credit_grants_metadata
Concessões de crédito: metadata (uma linha por item; liga-se a stripe_billing_credit_grants pela coluna credit_grant_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_billing_credit_grants). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Contas conectadas (Connect)
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- account_id > _connected_accounts_bus_minority_owned_business_de → Contas conectadas (Connect) > id
- account_id > _connected_accounts_future_requiremen_alternatives → Contas conectadas (Connect) > id
- account_id > _connected_accounts_fut_alt_alternative_fields_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_fut_altern_original_fields_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_future_requireme_currently_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_future_requirements_errors → Contas conectadas (Connect) > id
- account_id > _connected_accounts_future_requirem_eventually_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_future_requirements_past_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_future_re_pending_verification → Contas conectadas (Connect) > id
- account_id > _connected_accounts_metadata → Contas conectadas (Connect) > id
- account_id > _connected_accounts_requirements_alternatives → Contas conectadas (Connect) > id
- account_id > _connected_accounts_req_alt_alternative_fields_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_req_altern_original_fields_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_requirements_currently_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_requirements_errors → Contas conectadas (Connect) > id
- account_id > _connected_accounts_requirements_eventually_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_requirements_past_due → Contas conectadas (Connect) > id
- account_id > _connected_accounts_requireme_pending_verification → Contas conectadas (Connect) > id
- account_id > _connected_accounts_set_inv_default_account_tax_id → Contas conectadas (Connect) > id
- account_id > _connected_accounts_set_pay_sch_monthly_payout_day → Contas conectadas (Connect) > id
- account_id > _connected_accounts_set_pay_sch_weekly_payout_days → Contas conectadas (Connect) > id
- account_id > _connected_accounts_settings_payp_additional_files → Contas conectadas (Connect) > id
Objeto principal
Contas conectadas à plataforma (Stripe Connect), com status de cadastro, capacidades e configurações.
stripe_connected_accounts_bus_minority_owned_business_de
Contas conectadas (Connect): business_profile.minority_owned_business_designation (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Se a empresa é de propriedade de minorias, mulheres e/ou pessoas LGBTQI+. Valores possíveis: lgbtqi_owned_business = empresa de proprietário LGBTQI+; minority_owned_business = empresa de proprietário de minoria; none_of_these_apply = nenhuma se aplica; prefer_not_to_answer = prefere não responder; women_owned_business = empresa de proprietária mulher. |
stripe_connected_accounts_future_requiremen_alternatives
Contas conectadas (Connect): future_requirements.alternatives (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
stripe_connected_accounts_fut_alt_alternative_fields_due
Contas conectadas (Connect): future_requirements.alternatives.alternative_fields_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_connected_accounts_future_requiremen_alternatives, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que podem ser fornecidos para resolver todos os campos de original_fields_due. |
stripe_connected_accounts_fut_altern_original_fields_due
Contas conectadas (Connect): future_requirements.alternatives.original_fields_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_connected_accounts_future_requiremen_alternatives, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos pendentes que podem ser resolvidos fornecendo todos os campos de alternative_fields_due. |
stripe_connected_accounts_future_requireme_currently_due
Contas conectadas (Connect): future_requirements.currently_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que precisam ser resolvidos para manter a conta habilitada. Se não forem resolvidos até future_requirements[current_deadline], esses campos passarão para o hash principal de requirements. |
stripe_connected_accounts_future_requirements_errors
Contas conectadas (Connect): future_requirements.errors (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O código do tipo de erro. Valores possíveis: external_request = falha em verificação de órgão externo; information_missing = informação obrigatória ausente; invalid_address_city_state_postal_code = cidade/estado/CEP inválidos; invalid_address_cmra_address = endereço de agência de recebimento de correspondência (CMRA) não aceito; invalid_address_highway_contract_box = endereço de caixa postal rural (HCR) não aceito; invalid_address_private_mailbox = caixa postal privada não aceita; invalid_address_registered_agent_address = endereço de agente registrado não aceito; invalid_business_profile_name = nome do perfil comercial inválido; invalid_business_profile_name_denylisted = nome do perfil comercial bloqueado; invalid_company_name_denylisted = razão social bloqueada; invalid_dob_age_over_maximum = data de nascimento acima da idade máxima; invalid_dob_age_under_18 = pessoa menor de 18 anos; invalid_dob_age_under_minimum = idade abaixo do mínimo exigido; invalid_product_description_length = descrição do produto com tamanho inválido; invalid_product_description_url_match = descrição do produto igual à URL; invalid_representative_country = país do representante inválido; invalid_signator = signatário inválido; invalid_statement_descriptor_business_mismatch = descritor da fatura não condiz com o negócio; invalid_statement_descriptor_denylisted = descritor da fatura bloqueado; invalid_statement_descriptor_length = descritor da fatura com tamanho inválido; invalid_statement_descriptor_prefix_denylisted = prefixo do descritor bloqueado; invalid_statement_descriptor_prefix_mismatch = prefixo do descritor não condiz com o negócio; invalid_street_address = endereço (rua) inválido; invalid_tax_id = identificação fiscal inválida; invalid_tax_id_format = formato da identificação fiscal inválido; invalid_tos_acceptance = aceite dos termos de serviço inválido; invalid_url_denylisted = URL bloqueada; invalid_url_format = formato de URL inválido; invalid_url_web_presence_detected = presença web detectada, informe a URL; invalid_url_website_business_information_mismatch = site não condiz com dados da empresa; invalid_url_website_empty = site sem conteúdo; invalid_url_website_inaccessible = site inacessível; invalid_url_website_inaccessible_geoblocked = site inacessível por bloqueio geográfico; invalid_url_website_inaccessible_password_protected = site protegido por senha; invalid_url_website_incomplete = site incompleto; invalid_url_website_incomplete_cancellation_policy = site sem política de cancelamento; invalid_url_website_incomplete_customer_service_details = site sem dados de atendimento ao cliente; invalid_url_website_incomplete_legal_restrictions = site sem restrições legais; invalid_url_website_incomplete_refund_policy = site sem política de reembolso; invalid_url_website_incomplete_return_policy = site sem política de devolução; invalid_url_website_incomplete_terms_and_conditions = site sem termos e condições; invalid_url_website_incomplete_under_construction = site em construção; invalid_url_website_other = site inválido (outro motivo); invalid_value_other = valor inválido (outro motivo); unsupported_business_type = tipo de negócio não suportado; verification_directors_mismatch = diretores não conferem com o registro; verification_document_address_mismatch = endereço do documento não confere; verification_document_address_missing = documento sem endereço; verification_document_corrupt = arquivo do documento corrompido; verification_document_country_not_supported = país do documento não suportado; verification_document_directors_mismatch = diretores do documento não conferem; verification_document_dob_mismatch = data de nascimento do documento não confere; verification_document_duplicate_type = mesmo tipo de documento enviado em duplicidade; verification_document_expired = documento vencido; verification_document_failed_copy = documento é cópia, não original; verification_document_failed_greyscale = documento em escala de cinza; verification_document_failed_other = falha no documento (outro motivo); verification_document_failed_test_mode = documento de teste falhou (modo teste); verification_document_fraudulent = documento fraudulento; verification_document_id_number_mismatch = número de ID do documento não confere; verification_document_id_number_missing = documento sem número de ID; verification_document_incomplete = documento incompleto; verification_document_invalid = documento inválido; verification_document_issue_or_expiry_date_missing = documento sem data de emissão ou validade; verification_document_manipulated = documento adulterado; verification_document_missing_back = falta o verso do documento; verification_document_missing_front = falta a frente do documento; verification_document_name_mismatch = nome do documento não confere; verification_document_name_missing = documento sem nome; verification_document_nationality_mismatch = nacionalidade do documento não confere; verification_document_not_readable = documento ilegível; verification_document_not_signed = documento não assinado; verification_document_not_uploaded = documento não enviado; verification_document_photo_mismatch = foto do documento não confere; verification_document_too_large = arquivo do documento grande demais; verification_document_type_not_supported = tipo de documento não aceito; verification_extraneous_directors = diretores informados a mais; verification_failed_address_match = endereço não confirmado; verification_failed_authorizer_authority = autoridade do autorizador não confirmada; verification_failed_business_iec_number = número IEC da empresa não verificado (Índia); verification_failed_document_match = documento não confere com os dados; verification_failed_id_number_match = número de ID não confere; verification_failed_keyed_identity = identidade digitada não verificada; verification_failed_keyed_match = dados digitados não conferem; verification_failed_name_match = nome não confere; verification_failed_other = verificação falhou (outro motivo); verification_failed_representative_authority = autoridade do representante não confirmada; verification_failed_residential_address = endereço residencial não aceito; verification_failed_tax_id_match = identificação fiscal não confere; verification_failed_tax_id_not_issued = identificação fiscal não emitida; verification_legal_entity_structure_mismatch = estrutura jurídica não confere; verification_missing_directors = faltam diretores; verification_missing_executives = faltam executivos; verification_missing_owners = faltam sócios/proprietários; verification_rejected_ownership_exemption_reason = motivo de isenção de sócios rejeitado; verification_requires_additional_memorandum_of_associations = exige contrato social adicional; verification_requires_additional_proof_of_registration = exige comprovante de registro adicional; verification_supportability = negócio não suportado pela Stripe. |
|
|
text |
[pt] Mensagem informativa que indica o tipo do erro e fornece detalhes adicionais sobre ele. |
|
|
text |
[pt] O campo específico de requisito de onboarding do usuário (no hash requirements) que precisa ser resolvido. |
stripe_connected_accounts_future_requirem_eventually_due
Contas conectadas (Connect): future_requirements.eventually_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que você deve coletar quando todos os limites forem atingidos. À medida que se tornam obrigatórios, também aparecem em currently_due. |
stripe_connected_accounts_future_requirements_past_due
Contas conectadas (Connect): future_requirements.past_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que não foram resolvidos até requirements.current_deadline. Esses campos precisam ser resolvidos para habilitar a capacidade na conta. future_requirements.past_due é um subconjunto de requirements.past_due. |
stripe_connected_accounts_future_re_pending_verification
Contas conectadas (Connect): future_requirements.pending_verification (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que estão em revisão ou que podem se tornar obrigatórios dependendo do resultado de uma revisão. Se a revisão falhar, esses campos podem passar para eventually_due, currently_due, past_due ou alternatives. |
stripe_connected_accounts_metadata
Contas conectadas (Connect): metadata (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_connected_accounts_requirements_alternatives
Contas conectadas (Connect): requirements.alternatives (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
stripe_connected_accounts_req_alt_alternative_fields_due
Contas conectadas (Connect): requirements.alternatives.alternative_fields_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_connected_accounts_requirements_alternatives, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que podem ser fornecidos para resolver todos os campos de original_fields_due. |
stripe_connected_accounts_req_altern_original_fields_due
Contas conectadas (Connect): requirements.alternatives.original_fields_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_connected_accounts_requirements_alternatives, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos pendentes que podem ser resolvidos fornecendo todos os campos de alternative_fields_due. |
stripe_connected_accounts_requirements_currently_due
Contas conectadas (Connect): requirements.currently_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que precisam ser resolvidos para manter a conta habilitada. Se não forem resolvidos até current_deadline, esses campos também aparecerão em past_due e a conta será desabilitada. |
stripe_connected_accounts_requirements_errors
Contas conectadas (Connect): requirements.errors (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O código do tipo de erro. Valores possíveis: external_request = falha em verificação de órgão externo; information_missing = informação obrigatória ausente; invalid_address_city_state_postal_code = cidade/estado/CEP inválidos; invalid_address_cmra_address = endereço de agência de recebimento de correspondência (CMRA) não aceito; invalid_address_highway_contract_box = endereço de caixa postal rural (HCR) não aceito; invalid_address_private_mailbox = caixa postal privada não aceita; invalid_address_registered_agent_address = endereço de agente registrado não aceito; invalid_business_profile_name = nome do perfil comercial inválido; invalid_business_profile_name_denylisted = nome do perfil comercial bloqueado; invalid_company_name_denylisted = razão social bloqueada; invalid_dob_age_over_maximum = data de nascimento acima da idade máxima; invalid_dob_age_under_18 = pessoa menor de 18 anos; invalid_dob_age_under_minimum = idade abaixo do mínimo exigido; invalid_product_description_length = descrição do produto com tamanho inválido; invalid_product_description_url_match = descrição do produto igual à URL; invalid_representative_country = país do representante inválido; invalid_signator = signatário inválido; invalid_statement_descriptor_business_mismatch = descritor da fatura não condiz com o negócio; invalid_statement_descriptor_denylisted = descritor da fatura bloqueado; invalid_statement_descriptor_length = descritor da fatura com tamanho inválido; invalid_statement_descriptor_prefix_denylisted = prefixo do descritor bloqueado; invalid_statement_descriptor_prefix_mismatch = prefixo do descritor não condiz com o negócio; invalid_street_address = endereço (rua) inválido; invalid_tax_id = identificação fiscal inválida; invalid_tax_id_format = formato da identificação fiscal inválido; invalid_tos_acceptance = aceite dos termos de serviço inválido; invalid_url_denylisted = URL bloqueada; invalid_url_format = formato de URL inválido; invalid_url_web_presence_detected = presença web detectada, informe a URL; invalid_url_website_business_information_mismatch = site não condiz com dados da empresa; invalid_url_website_empty = site sem conteúdo; invalid_url_website_inaccessible = site inacessível; invalid_url_website_inaccessible_geoblocked = site inacessível por bloqueio geográfico; invalid_url_website_inaccessible_password_protected = site protegido por senha; invalid_url_website_incomplete = site incompleto; invalid_url_website_incomplete_cancellation_policy = site sem política de cancelamento; invalid_url_website_incomplete_customer_service_details = site sem dados de atendimento ao cliente; invalid_url_website_incomplete_legal_restrictions = site sem restrições legais; invalid_url_website_incomplete_refund_policy = site sem política de reembolso; invalid_url_website_incomplete_return_policy = site sem política de devolução; invalid_url_website_incomplete_terms_and_conditions = site sem termos e condições; invalid_url_website_incomplete_under_construction = site em construção; invalid_url_website_other = site inválido (outro motivo); invalid_value_other = valor inválido (outro motivo); unsupported_business_type = tipo de negócio não suportado; verification_directors_mismatch = diretores não conferem com o registro; verification_document_address_mismatch = endereço do documento não confere; verification_document_address_missing = documento sem endereço; verification_document_corrupt = arquivo do documento corrompido; verification_document_country_not_supported = país do documento não suportado; verification_document_directors_mismatch = diretores do documento não conferem; verification_document_dob_mismatch = data de nascimento do documento não confere; verification_document_duplicate_type = mesmo tipo de documento enviado em duplicidade; verification_document_expired = documento vencido; verification_document_failed_copy = documento é cópia, não original; verification_document_failed_greyscale = documento em escala de cinza; verification_document_failed_other = falha no documento (outro motivo); verification_document_failed_test_mode = documento de teste falhou (modo teste); verification_document_fraudulent = documento fraudulento; verification_document_id_number_mismatch = número de ID do documento não confere; verification_document_id_number_missing = documento sem número de ID; verification_document_incomplete = documento incompleto; verification_document_invalid = documento inválido; verification_document_issue_or_expiry_date_missing = documento sem data de emissão ou validade; verification_document_manipulated = documento adulterado; verification_document_missing_back = falta o verso do documento; verification_document_missing_front = falta a frente do documento; verification_document_name_mismatch = nome do documento não confere; verification_document_name_missing = documento sem nome; verification_document_nationality_mismatch = nacionalidade do documento não confere; verification_document_not_readable = documento ilegível; verification_document_not_signed = documento não assinado; verification_document_not_uploaded = documento não enviado; verification_document_photo_mismatch = foto do documento não confere; verification_document_too_large = arquivo do documento grande demais; verification_document_type_not_supported = tipo de documento não aceito; verification_extraneous_directors = diretores informados a mais; verification_failed_address_match = endereço não confirmado; verification_failed_authorizer_authority = autoridade do autorizador não confirmada; verification_failed_business_iec_number = número IEC da empresa não verificado (Índia); verification_failed_document_match = documento não confere com os dados; verification_failed_id_number_match = número de ID não confere; verification_failed_keyed_identity = identidade digitada não verificada; verification_failed_keyed_match = dados digitados não conferem; verification_failed_name_match = nome não confere; verification_failed_other = verificação falhou (outro motivo); verification_failed_representative_authority = autoridade do representante não confirmada; verification_failed_residential_address = endereço residencial não aceito; verification_failed_tax_id_match = identificação fiscal não confere; verification_failed_tax_id_not_issued = identificação fiscal não emitida; verification_legal_entity_structure_mismatch = estrutura jurídica não confere; verification_missing_directors = faltam diretores; verification_missing_executives = faltam executivos; verification_missing_owners = faltam sócios/proprietários; verification_rejected_ownership_exemption_reason = motivo de isenção de sócios rejeitado; verification_requires_additional_memorandum_of_associations = exige contrato social adicional; verification_requires_additional_proof_of_registration = exige comprovante de registro adicional; verification_supportability = negócio não suportado pela Stripe. |
|
|
text |
[pt] Mensagem informativa que indica o tipo do erro e fornece detalhes adicionais sobre ele. |
|
|
text |
[pt] O campo específico de requisito de onboarding do usuário (no hash requirements) que precisa ser resolvido. |
stripe_connected_accounts_requirements_eventually_due
Contas conectadas (Connect): requirements.eventually_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que você deve coletar quando todos os limites forem atingidos. À medida que se tornam obrigatórios, também aparecem em currently_due, e current_deadline passa a ser definido. |
stripe_connected_accounts_requirements_past_due
Contas conectadas (Connect): requirements.past_due (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que não foram resolvidos até current_deadline. Esses campos precisam ser resolvidos para habilitar a conta. |
stripe_connected_accounts_requireme_pending_verification
Contas conectadas (Connect): requirements.pending_verification (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Campos que estão em revisão ou que podem se tornar obrigatórios dependendo do resultado de uma revisão. Se a revisão falhar, esses campos podem passar para eventually_due, currently_due, past_due ou alternatives. |
stripe_connected_accounts_set_inv_default_account_tax_id
Contas conectadas (Connect): settings.invoices.default_account_tax_ids (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de IDs fiscais padrão da conta a serem incluídos automaticamente nas faturas. Os IDs fiscais da conta são adicionados quando uma fatura é finalizada. |
stripe_connected_accounts_set_pay_sch_monthly_payout_day
Contas conectadas (Connect): settings.payouts.schedule.monthly_payout_days (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
int |
[pt] Os dias do mês em que os fundos serão repassados (payout). Exibido apenas se interval for monthly. Repasses (payouts) agendados entre os dias 29 e 31 do mês são enviados no último dia dos meses mais curtos. |
stripe_connected_accounts_set_pay_sch_weekly_payout_days
Contas conectadas (Connect): settings.payouts.schedule.weekly_payout_days (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os dias da semana em que os fundos disponíveis são repassados (payout), especificados como um array, por exemplo, [monday, tuesday]. Exibido apenas se interval for weekly. Valores possíveis: friday = sexta-feira; monday = segunda-feira; thursday = quinta-feira; tuesday = terça-feira; wednesday = quarta-feira. |
stripe_connected_accounts_settings_payp_additional_files
Contas conectadas (Connect): settings.paypay_payments.additional_files (uma linha por item; liga-se a stripe_connected_accounts pela coluna account_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_connected_accounts). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Arquivos adicionais necessários para dar suporte ao processo de onboarding da sua empresa. |
Contestações
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- charge → Cobranças > id
- payment_intent → Intenções de pagamento (PaymentIntents) > id
- dispute_id > _disputes_balance_transactions → Contestações > id
- dispute_id > _disputes_enhanced_eligibility_types → Contestações > id
- dispute_id > _disputes_evi_enh_vis_prior_undisputed_transaction → Contestações > id
- dispute_id > _disputes_evidence_detail_enh_vis_required_actions → Contestações > id
- dispute_id > _disputes_metadata → Contestações > id
- dispute_id > _disputes_payment_method_details → Contestações > id
Objeto principal
Contestações (chargebacks) abertas pelos titulares de cartão, com valor, motivo, status, prazo para enviar evidências e evidências enviadas. Uma linha por contestação; liga-se à cobrança pela coluna charge.
stripe_disputes_balance_transactions
Contestações: balance_transactions (uma linha por item; liga-se a stripe_disputes pela coluna dispute_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_disputes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista de zero, uma ou duas transações de saldo que mostram os fundos retirados e restituídos à sua conta Stripe em decorrência desta contestação. |
stripe_disputes_enhanced_eligibility_types
Contestações: enhanced_eligibility_types (uma linha por item; liga-se a stripe_disputes pela coluna dispute_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_disputes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista dos tipos de elegibilidade incluídos em enhanced_evidence. Valores possíveis: mastercard_compliance = Mastercard compliance (resolução reforçada); visa_compelling_evidence_3 = Visa Compelling Evidence 3.0; visa_compliance = Visa compliance (resolução reforçada). |
stripe_disputes_evi_enh_vis_prior_undisputed_transaction
Contestações: evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions (uma linha por item; liga-se a stripe_disputes pela coluna dispute_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_disputes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] ID da cobrança da Stripe anterior elegível ao Visa Compelling Evidence 3.0. |
|
|
text |
[pt] ID da conta de usuário usado para fazer login na plataforma da empresa. Deve ser reconhecível pelo usuário. |
|
|
text |
[pt] Identificador único do dispositivo do titular do cartão, derivado de uma combinação de pelo menos dois atributos de hardware e software. Deve ter pelo menos 20 caracteres. |
|
|
text |
[pt] Identificador único do dispositivo do titular do cartão, como o número de série do dispositivo (ex.: International Mobile Equipment Identity [IMEI]). Deve ter pelo menos 15 caracteres. |
|
|
text |
[pt] O endereço de e-mail do cliente. |
|
|
text |
[pt] O endereço IP que o cliente usou ao fazer a compra. |
|
|
text |
[pt] Uma descrição do produto ou serviço que foi vendido. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
stripe_disputes_evidence_detail_enh_vis_required_actions
Contestações: evidence_details.enhanced_eligibility.visa_compelling_evidence_3.required_actions (uma linha por item; liga-se a stripe_disputes pela coluna dispute_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_disputes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista de ações necessárias para qualificar a contestação ao envio de evidências do Visa Compelling Evidence 3.0. Valores possíveis: missing_customer_identifiers = faltam identificadores do cliente; missing_disputed_transaction_description = falta descrição da transação contestada; missing_merchandise_or_services = falta informar mercadoria ou serviço; missing_prior_undisputed_transaction_description = falta descrição de transação anterior não contestada; missing_prior_undisputed_transactions = faltam transações anteriores não contestadas. |
stripe_disputes_metadata
Contestações: metadata (uma linha por item; liga-se a stripe_disputes pela coluna dispute_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_disputes). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_disputes_payment_method_details
Contestações: payment_method_details (uma linha por item; liga-se a stripe_disputes pela coluna dispute_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_disputes). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Bandeira do cartão. Pode ser amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa ou unknown. |
|
|
text |
[pt] O ID da contestação no PayPal. |
|
|
text |
[pt] O tipo de contestação aberta. Diferentes tipos de caso podem ter taxas e impacto financeiro variados. Valores possíveis: block = bloqueio; chargeback = chargeback (estorno contestado); compliance = disputa de conformidade da bandeira; inquiry = consulta prévia do emissor; resolution = resolução. |
|
|
text |
[pt] Motivo de perda de chargeback mapeado pela Stripe a partir do motivo de perda de chargeback da Klarna… |
|
|
text |
[pt] O tipo de contestação do AmazonPay: chargeback ou claim… Valores possíveis: chargeback = chargeback (estorno pelo banco); claim = reclamação na Amazon (A-to-z). |
|
|
text |
[pt] Identifica em qual rede esta cobrança foi processada. Pode ser amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa ou unknown. |
|
|
text |
[pt] O código de motivo de contestação específico da rede do cartão, que corresponde a uma das categorias principais de contestação da Stripe para simplificar a orientação de resposta. O mapa de códigos de rede lista todos os códigos de motivo de contestação disponíveis por rede. |
|
|
text |
[pt] O motivo da contestação conforme definido pela Klarna. |
Cupons
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Cupons de desconto, com percentual ou valor, duração e limites de uso.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor (na moeda especificada) que será abatido do subtotal de todas as faturas deste cliente. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Se amount_off foi definido, o código ISO de três letras da moeda do valor a ser abatido. |
|
|
text |
[pt] Um de forever, once ou repeating. Descreve por quanto tempo um cliente que aplica este cupom receberá o desconto. Valores possíveis: forever = desconto para sempre; once = desconto em uma única cobrança; repeating = desconto por N meses. |
|
|
int |
[pt] Se duration for repeating, o número de meses em que o cupom se aplica. Nulo se a duração do cupom for forever ou once. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
int |
[pt] Número máximo de vezes que este cupom pode ser resgatado, no total, entre todos os clientes, antes de deixar de ser válido. |
|
|
text |
[pt] Nome do cupom exibido aos clientes, por exemplo, em faturas ou recibos. |
|
|
float |
[pt] Porcentagem que será abatida do subtotal de todas as faturas deste cliente durante a duração do cupom. Por exemplo, um cupom com percent_off de 50 fará uma fatura de US$ 100 (ou equivalente local) passar a ser de US$ 50 (ou equivalente local). |
|
|
timestamp |
[pt] Data após a qual o cupom não pode mais ser resgatado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
int |
[pt] Número de vezes que este cupom foi aplicado a um cliente. |
|
|
boolean |
[pt] Considerando as propriedades acima, indica se este cupom ainda pode ser aplicado a um cliente. Valores: true (sim) ou false (não). |
stripe_coupons_applies_to_products
Cupons: applies_to.products (uma linha por item; liga-se a stripe_coupons pela coluna coupon_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_coupons). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Uma lista de IDs de produtos aos quais este cupom se aplica… |
stripe_coupons_currency_options
Cupons: currency_options (uma linha por item; liga-se a stripe_coupons pela coluna coupon_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_coupons). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor (na moeda especificada) que será abatido do subtotal de todas as faturas deste cliente. |
stripe_coupons_metadata
Cupons: metadata (uma linha por item; liga-se a stripe_coupons pela coluna coupon_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_coupons). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Códigos promocionais
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Códigos promocionais que clientes digitam para aplicar um cupom.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o código promocional está atualmente ativo. Um código promocional só está ativo se o cupom também for válido. Valores: true (sim) ou false (não). |
|
|
text |
[pt] O código exibido ao cliente. Independentemente de maiúsculas e minúsculas, este código deve ser único entre todos os códigos promocionais ativos de cada cliente. Os caracteres válidos são letras minúsculas (a-z), letras maiúsculas (A-Z), dígitos (0-9) e hifens (-). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O cliente que pode usar este código promocional. |
|
|
text |
[pt] A conta que representa o cliente que pode usar este código promocional. |
|
|
timestamp |
[pt] Data após a qual o código promocional não pode mais ser resgatado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
int |
[pt] Número máximo de vezes que este código promocional pode ser resgatado. |
|
|
text |
[pt] Se o tipo de promoção for coupon, o cupom desta promoção. |
|
|
text |
[pt] O tipo de promoção. Valores possíveis: coupon = cupom. |
|
|
boolean |
[pt] Um booleano que indica se o código promocional deve ser resgatado apenas por clientes sem nenhum pagamento ou fatura bem-sucedidos… Valores: true (sim) ou false (não). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor mínimo necessário para resgatar este código promocional como um cupom (por exemplo, a compra deve ser de US$ 100 ou mais para funcionar). |
|
|
text |
[pt] Código ISO de três letras de minimum_amount. |
|
|
int |
[pt] Número de vezes que este código promocional foi usado. |
stripe_promotion_codes_metadata
Códigos promocionais: metadata (uma linha por item; liga-se a stripe_promotion_codes pela coluna promotion_code_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_promotion_codes). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_promotion_codes_restrictions_currency_options
Códigos promocionais: restrictions.currency_options (uma linha por item; liga-se a stripe_promotion_codes pela coluna promotion_code_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_promotion_codes). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor mínimo necessário para resgatar este código promocional como um cupom (por exemplo, a compra deve ser de US$ 100 ou mais para funcionar). |
Eventos
Tipo de replicação: Incremental
Parâmetros:
- Data inicial de leitura: O Stripe guarda só os últimos 30 dias de eventos
Relacionamentos:
Objeto principal
Eventos da conta (o mesmo que os webhooks recebem): tipo, data, o id e o tipo do objeto afetado, o objeto completo e os atributos anteriores em JSON (sem segredos como client_secret). O Stripe guarda só os últimos 30 dias, por isso esta integração é sempre incremental e a tabela acumula o histórico; se a integração ficar parada mais de 30 dias, o intervalo além disso não existe mais no Stripe.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] A conta conectada que origina o evento. |
|
|
text |
[pt] A versão da API da Stripe usada para renderizar os dados quando o evento foi criado. O conteúdo de data nunca muda, então este valor permanece estático independentemente da versão da API em uso no momento. Esta propriedade só é preenchida para eventos criados a partir de 31 de outubro de 2014. |
|
|
text |
[pt] Contexto de autenticação necessário para buscar o evento ou o objeto relacionado. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
int |
[pt] Número de webhooks que não foram entregues com sucesso (por exemplo, retornando uma resposta 20x) às URLs que você especificou. |
|
|
text |
[pt] ID da requisição de API que causou o evento. Se nulo, o evento foi automático (por exemplo, o tratamento automático de assinaturas da Stripe). Os logs de requisições estão disponíveis no dashboard, mas atualmente não na API. |
|
|
text |
[pt] A chave de idempotência transmitida durante a requisição, se houver. *Observação: esta propriedade só é preenchida para eventos a partir de 23 de maio de 2017*. |
|
|
text |
[pt] Descrição do evento (por exemplo, invoice.created ou charge.refunded). |
|
|
text |
[pt] Identificador do objeto ao qual o evento se refere. |
|
|
text |
[pt] Tipo do objeto ao qual o evento se refere (cobrança, fatura, cliente...). |
stripe_events_changes
Eventos: changes (uma linha por item; liga-se a stripe_events pela coluna event_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_events). |
|
|
text |
[pt] Atributo que mudou neste evento, como caminho com pontos (p. ex., status, items.data.0.quantity). |
|
|
text |
[pt] Valor do atributo antes do evento, em texto. |
|
|
text |
[pt] Valor do atributo após o evento, em texto. |
Faturas
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer → Clientes > id
- invoice_id > _invoices_account_tax_ids → Faturas > id
- invoice_id > _invoices_custom_fields → Faturas > id
- invoice_id > _invoices_customer_tax_ids → Faturas > id
- invoice_id > _invoices_default_tax_rates → Faturas > id
- invoice_id > _invoices_default_tax_rates_metadata → Faturas > id
- invoice_id > _invoices_discounts → Faturas > id
- invoice_id > _invoices_metadata → Faturas > id
- invoice_id > _invoices_parent_subscription_details_metadata → Faturas > id
- invoice_id > _invoices_payment_settings_payment_method_options → Faturas > id
- invoice_id > _invoices_pay_pay_fin_filter_account_subcategories → Faturas > id
- invoice_id > _invoices_payment_settings_pay_financi_permissions → Faturas > id
- invoice_id > _invoices_payment_settings_pay_financial__prefetch → Faturas > id
- invoice_id > _invoices_payment_settings_payment_method_types → Faturas > id
- invoice_id > _invoices_shipping_cost_taxes → Faturas > id
- invoice_id > _invoices_threshold_reason_item_reasons → Faturas > id
- invoice_id > _invoices_threshold_rea_item_reasons_line_item_ids → Faturas > id
- invoice_id > _invoices_total_discount_amounts → Faturas > id
- invoice_id > _invoices_total_pretax_credit_amounts → Faturas > id
- invoice_id > _invoices_total_taxes → Faturas > id
Objeto principal
Faturas (invoices) emitidas para clientes, avulsas ou de assinaturas, com valores, impostos, descontos, status e datas. Para receita use status = paid e amount_paid; para contas a receber use status = open e amount_remaining. Faturas draft (rascunho) não foram cobradas e não são dívida. Vencimento (due_date) só existe em faturas enviadas para pagamento (collection_method = send_invoice); na cobrança automática fica vazio.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. Para faturas de pré-visualização criadas pelo endpoint de create preview, este id terá o prefixo upcoming_in. |
|
|
text |
[pt] O país da empresa associada a esta fatura, na maioria das vezes a empresa que cria a fatura. |
|
|
text |
[pt] O nome público da empresa associada a esta fatura, na maioria das vezes a empresa que cria a fatura. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor final devido neste momento para esta fatura. Se o total da fatura for menor que o valor mínimo de cobrança, por exemplo, ou se houver crédito na conta que possa ser aplicado à fatura, o amount_due pode ser 0. Só é valor a receber quando status = open; em rascunho (draft) a fatura ainda não foi cobrada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que foi pago a mais na fatura. O valor pago a mais é creditado no saldo de crédito do cliente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que foi pago. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que foi pago na fatura fora da Stripe. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. A diferença entre amount_due e amount_paid. Só é valor a receber quando status = open; em rascunho (draft) a fatura ainda não foi cobrada e não é dívida. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os valores de envio. |
|
|
text |
[pt] ID do aplicativo Connect que criou a fatura. |
|
|
int |
[pt] Número de tentativas de pagamento feitas para esta fatura, do ponto de vista do cronograma de novas tentativas de pagamento. Qualquer tentativa de pagamento conta como a primeira tentativa e, depois disso, apenas as novas tentativas automáticas incrementam a contagem. |
|
|
boolean |
[pt] Se houve uma tentativa de pagar a fatura. Uma fatura não é tentada até 1 hora após o webhook invoice.created, por exemplo, então você pode não querer exibir essa fatura como não paga aos seus usuários. Valores: true (sim) ou false (não). |
|
|
boolean |
[pt] Controla se a Stripe realiza a cobrança automática da fatura. Se false, o estado da fatura não avança automaticamente sem uma ação explícita. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Se a Stripe desabilitou o imposto automático, este enum descreve o motivo. Valores possíveis: finalization_requires_location_inputs = finalização exige dados de localização; finalization_system_error = erro de sistema na finalização. |
|
|
boolean |
[pt] Se a Stripe calcula automaticamente o imposto nesta fatura. Observe que itens de fatura incompatíveis (itens de fatura com alíquotas especificadas manualmente, valores negativos ou tax_behavior=unspecified) não podem ser adicionados a faturas com imposto automático. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A conta conectada referenciada quando type é account. |
|
|
text |
[pt] Tipo da conta referenciada. Valores possíveis: account = a própria conta; self = o próprio dono. |
|
|
text |
[pt] O provedor de imposto que alimenta o imposto automático. |
|
|
text |
[pt] O status do cálculo automático de imposto mais recente desta fatura. Valores possíveis: complete = concluída; failed = falhou; requires_location_inputs = requer endereço válido do cliente. |
|
|
timestamp |
[pt] O momento em que esta fatura está atualmente agendada para ser finalizada automaticamente. O campo será null se a fatura não estiver agendada para ser finalizada no futuro. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Indica o motivo pelo qual a fatura foi criada. * manual: Não relacionada a uma assinatura, por exemplo, criada pelo editor de faturas. * subscription: Não está mais em uso. Aplica-se a assinaturas anteriores a maio de 2018, em que não havia distinção entre atualizações, ciclos e limites. Valores possíveis: automatic_pending_invoice_item_invoice = fatura automática de itens pendentes; manual = criada manualmente, fora de assinatura; quote_accept = gerada ao aceitar orçamento; subscription = assinatura (valor legado); subscription_create = criação de assinatura; subscription_cycle = renovação do ciclo da assinatura; subscription_threshold = limite de uso da assinatura atingido; subscription_update = alteração de assinatura; upcoming = prévia da próxima fatura. |
|
|
text |
[pt] charge_automatically ou send_invoice. Ao cobrar automaticamente, a Stripe tentará pagar esta fatura usando a fonte padrão vinculada ao cliente. Ao enviar uma fatura, a Stripe a enviará por e-mail ao cliente com as instruções de pagamento. Valores possíveis: charge_automatically = cobrança automática no meio de pagamento; send_invoice = fatura enviada ao cliente para pagar. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] O ID do cliente a ser cobrado. |
|
|
text |
[pt] O ID da conta que representa o cliente a ser cobrado. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] O e-mail do cliente. Até a fatura ser finalizada, este campo será igual a customer.email. Depois que a fatura é finalizada, este campo deixa de ser atualizado. |
|
|
text |
[pt] O nome do cliente. Até a fatura ser finalizada, este campo será igual a customer.name. Depois que a fatura é finalizada, este campo deixa de ser atualizado. |
|
|
text |
[pt] O número de telefone do cliente. Até a fatura ser finalizada, este campo será igual a customer.phone. Depois que a fatura é finalizada, este campo deixa de ser atualizado. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] A transportadora que enviou um produto físico, como Fedex, UPS, USPS etc. |
|
|
text |
[pt] Nome do destinatário. |
|
|
text |
[pt] Telefone do destinatário (incluindo ramal). |
|
|
text |
[pt] O código de rastreamento de um produto físico, obtido da transportadora. Se vários códigos de rastreamento foram gerados para esta compra, separe-os por vírgulas. |
|
|
text |
[pt] O status de isenção de imposto do cliente. Até a fatura ser finalizada, este campo será igual a customer.tax_exempt. Depois que a fatura é finalizada, este campo deixa de ser atualizado. Valores possíveis: exempt = cliente isento de impostos; none = cliente não isento; reverse = reverse charge: o comprador recolhe o imposto. |
|
|
text |
[pt] ID do método de pagamento padrão da fatura. Deve pertencer ao cliente associado à fatura. Se não definido, usa o método de pagamento padrão da assinatura, se houver, ou o método de pagamento padrão das configurações de fatura do cliente. |
|
|
text |
[pt] ID da fonte de pagamento padrão da fatura. Deve pertencer ao cliente associado à fatura e estar em estado cobrável. Se não definido, usa a fonte padrão da assinatura, se houver, ou a fonte padrão do cliente. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. Referenciada como 'memo' no Dashboard. |
|
|
timestamp |
[pt] A data de vencimento do pagamento desta fatura. Este valor será null para faturas com collection_method=charge_automatically. Vencimento: só existe em faturas enviadas para pagamento (collection_method = send_invoice); na cobrança automática fica vazio. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] A data em que esta fatura entra em vigor. Igual a finalized_at, a menos que seja sobrescrita. Quando definido, este valor substitui a 'Data de emissão' gerada pelo sistema impressa no PDF da fatura e no recibo. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Saldo final do cliente depois que a fatura é finalizada. As faturas são finalizadas aproximadamente uma hora após a entrega bem-sucedida do webhook ou quando é feita a tentativa de cobrança da fatura. Se a fatura ainda não foi finalizada, será nulo. |
|
|
text |
[pt] Rodapé exibido na fatura. |
|
|
text |
[pt] A relação entre esta fatura e a fatura clonada. |
|
|
text |
[pt] A fatura que foi clonada. |
|
|
text |
[pt] A URL da página hospedada da fatura, que permite aos clientes visualizar e pagar uma fatura. Se a fatura ainda não foi finalizada, será null. |
|
|
text |
[pt] O link para baixar o PDF da fatura. Se a fatura ainda não foi finalizada, será null. |
|
|
text |
[pt] A conta conectada referenciada quando type é account. |
|
|
text |
[pt] Tipo da conta referenciada. Valores possíveis: account = a própria conta; self = o próprio dono. |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, string curta que indica como proceder diante do erro, se o emissor a fornecer. |
|
|
text |
[pt] Para erros de cartão, o ID da cobrança que falhou. |
|
|
text |
[pt] Para alguns erros que podem ser tratados programaticamente, string curta que indica o código de erro informado. |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, string curta que indica o motivo da recusa segundo o emissor, se ele a fornecer. |
|
|
text |
[pt] URL com mais informações sobre o código de erro informado. |
|
|
text |
[pt] Mensagem legível por humanos com mais detalhes sobre o erro. Em erros de cartão, essas mensagens podem ser exibidas aos seus usuários. |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, código de 2 dígitos que indica a orientação dada ao comerciante pela rede do cartão sobre como proceder diante do erro. |
|
|
text |
[pt] Para pagamentos recusados pela rede, código alfanumérico que indica o motivo da falha do pagamento. |
|
|
text |
[pt] Se o erro for específico de um parâmetro, o parâmetro relacionado ao erro. Por exemplo, você pode usá-lo para exibir uma mensagem perto do campo de formulário correto. |
|
|
text |
[pt] Uma PaymentIntent guia você pelo processo de cobrança de um pagamento do seu cliente. Recomendamos criar exatamente uma PaymentIntent para cada pedido ou sessão de cliente no seu sistema. |
|
|
text |
[pt] Objetos PaymentMethod representam os instrumentos de pagamento do seu cliente. Você pode usá-los com PaymentIntents para cobrar pagamentos ou salvá-los em objetos Customer para guardar os dados do instrumento para pagamentos futuros. Guias relacionados: Payment Methods e More Payment Scenarios. |
|
|
text |
[pt] Se o erro for específico do tipo de meio de pagamento, o tipo de meio de pagamento que teve problema. Este campo só é preenchido em erros relacionados a faturas. |
|
|
text |
[pt] URL da entrada do log da requisição no seu dashboard. |
|
|
text |
[pt] Uma SetupIntent guia você pelo processo de configurar e salvar as credenciais de pagamento de um cliente para pagamentos futuros. Por exemplo, você pode usar uma SetupIntent para configurar e salvar o cartão do cliente sem cobrar um pagamento imediatamente. |
|
|
text |
[pt] O objeto de origem (source) dos erros retornados em uma requisição envolvendo uma source. |
|
|
text |
[pt] O tipo de erro retornado. Um entre api_error, card_error, idempotency_error ou invalid_request_error… Valores possíveis: api_error = erro interno da API Stripe; card_error = erro do cartão (ex.: recusa); idempotency_error = erro de chave de idempotência; invalid_request_error = requisição inválida. |
|
|
text |
[pt] O ID da revisão mais recente, que não seja rascunho, desta fatura. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
timestamp |
[pt] O momento em que o pagamento será tentado novamente. Este valor será null para faturas com collection_method=send_invoice. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string única de identificação que aparece nos e-mails enviados ao cliente para esta fatura. Começa com o invoice_prefix exclusivo do cliente, se especificado. |
|
|
text |
[pt] A conta (se houver) a que se destinam os fundos do pagamento da fatura. Se definida, a fatura será apresentada com a marca e as informações de suporte da conta especificada. |
|
|
text |
[pt] A cotação que gerou esta fatura. |
|
|
text |
[pt] A assinatura que gerou esta fatura. |
|
|
timestamp |
[pt] Definido apenas para faturas futuras (upcoming) que fazem uma prévia de rateios (prorations). O momento usado para calcular os rateios. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O tipo de origem (parent) que gerou esta fatura. Valores possíveis: quote_details = gerada por orçamento (quote); subscription_details = gerada por assinatura. |
|
|
text |
[pt] ID do mandato a ser usado nesta fatura. Deve corresponder ao método de pagamento usado para pagar a fatura, incluindo default_payment_method ou default_source da fatura, se definidos. |
|
|
timestamp |
[pt] O carimbo de data/hora mais recente em que itens de fatura podem ser associados a esta fatura. Use o período do item de linha para obter o período de serviço de cada preço. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O carimbo de data/hora mais antigo em que itens de fatura podem ser associados a esta fatura. Use o período do item de linha para obter o período de serviço de cada preço. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de todas as notas de crédito pós-pagamento emitidas para esta fatura. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de todas as notas de crédito pré-pagamento emitidas para esta fatura. |
|
|
text |
[pt] Este é o número da transação que aparece nos recibos enviados por e-mail para esta fatura. |
|
|
text |
[pt] Como os preços e valores dos itens de linha serão exibidos em relação aos impostos nos PDFs de fatura. |
|
|
text |
[pt] Tamanho de página do PDF da fatura. As opções incluem a4, letter e auto. Se definido como auto, o tamanho da página será alternado entre a4 ou letter com base no idioma/região (locale) do cliente. Valores possíveis: a4 = tamanho A4; auto = automático pela localidade do cliente; letter = tamanho carta (Letter). |
|
|
text |
[pt] ID do modelo de renderização com o qual a fatura é formatada. |
|
|
int |
[pt] Versão do modelo de renderização que a fatura está usando. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Custo total de envio antes da aplicação de quaisquer impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de imposto aplicado sobre os custos de envio. Se nenhum imposto foi aplicado, o padrão é 0. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Custo total de envio após a aplicação de impostos. |
|
|
text |
[pt] O ID da ShippingRate desta fatura. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] A transportadora que enviou um produto físico, como Fedex, UPS, USPS etc. |
|
|
text |
[pt] Nome do destinatário. |
|
|
text |
[pt] Telefone do destinatário (incluindo ramal). |
|
|
text |
[pt] O código de rastreamento de um produto físico, obtido da transportadora. Se vários códigos de rastreamento foram gerados para esta compra, separe-os por vírgulas. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Saldo inicial do cliente antes de a fatura ser finalizada. Se a fatura ainda não foi finalizada, será o saldo atual do cliente. Para faturas de revisão, também inclui qualquer saldo do cliente que tenha sido aplicado à fatura original. |
|
|
text |
[pt] Informações extras sobre uma fatura para a fatura do cartão de crédito do cliente. |
|
|
text |
[pt] O status da fatura, um entre draft, open, paid, uncollectible ou void. Para contas a receber: open = emitida e aguardando pagamento; paid = paga; uncollectible = dada como perdida (incobrável); void = cancelada, não deve ser cobrada; draft = rascunho, ainda não cobrada (não é dívida). |
|
|
text |
[pt] O motivo pelo qual a fatura é incobrável. Valores possíveis: max_payment_attempts = máximo de tentativas de pagamento atingido; payment_not_received = pagamento não recebido; subscription_canceled = assinatura cancelada; subscription_paused = assinatura pausada; user_forgiven = dívida perdoada pelo usuário. |
|
|
timestamp |
[pt] O momento em que o rascunho da fatura foi finalizado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O momento em que a fatura foi marcada como incobrável. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O momento em que a fatura foi paga. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O momento em que a fatura foi anulada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total de todas as assinaturas, itens de fatura e rateios (prorations) da fatura antes da aplicação de qualquer desconto em nível de fatura ou imposto exclusivo. Os descontos dos itens já estão incorporados. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o subtotal da fatura antes de qualquer desconto em nível de fatura ou imposto ser aplicado. Os descontos dos itens já estão incorporados. |
|
|
text |
[pt] ID do relógio de teste (test clock) ao qual esta fatura pertence. Só é preenchido em modo de teste (chave sk_test_/rk_test_), quando o registro foi criado preso a um relógio de teste para simular a passagem do tempo; em conta real fica sempre vazio. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O limite do valor total da fatura, se ele acionou a fatura de limite (threshold). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total após descontos e impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o valor total da fatura, incluindo todos os descontos, mas excluindo todos os impostos. |
|
|
timestamp |
[pt] As faturas são pagas ou enviadas automaticamente 1 hora após a entrega dos webhooks, ou até que todas as tentativas de entrega dos webhooks se esgotem. Este campo registra o momento em que os webhooks desta fatura foram entregues com sucesso. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
stripe_invoices_account_tax_ids
Faturas: account_tax_ids (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os IDs fiscais da conta associados à fatura. Editável apenas quando a fatura é um rascunho. |
stripe_invoices_custom_fields
Faturas: custom_fields (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do campo personalizado. |
|
|
text |
[pt] O valor do campo personalizado. |
stripe_invoices_customer_tax_ids
Faturas: customer_tax_ids (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O tipo do documento fiscal (tax ID), um entre ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn,… Valores possíveis: ad_nrt = NRT (Andorra); ae_trn = TRN (Emirados Árabes); al_tin = NIPT/TIN (Albânia); am_tin = TIN (Armênia); ao_tin = NIF (Angola); ar_cuit = CUIT (Argentina); au_abn = ABN (Austrália); au_arn = ARN (Austrália); aw_tin = TIN (Aruba); az_tin = TIN (Azerbaijão); ba_tin = TIN (Bósnia e Herzegovina); bb_tin = TIN (Barbados); bd_bin = BIN (Bangladesh); bf_ifu = IFU (Burkina Faso); bg_uic = UIC (Bulgária); bh_vat = VAT/IVA (Bahrein); bj_ifu = IFU (Benin); bo_tin = NIT (Bolívia); br_cnpj = CNPJ (Brasil); br_cpf = CPF (Brasil); bs_tin = TIN (Bahamas); by_tin = TIN (Belarus); ca_bn = BN (Canadá); ca_gst_hst = GST/HST (Canadá); ca_pst_bc = PST Colúmbia Britânica (Canadá); ca_pst_mb = PST Manitoba (Canadá); ca_pst_sk = PST Saskatchewan (Canadá); ca_qst = QST Quebec (Canadá); cd_nif = NIF (Rep. Dem. do Congo); ch_uid = UID (Suíça); ch_vat = VAT/IVA (Suíça); cl_tin = RUT (Chile); cm_niu = NIU (Camarões); cn_tin = TIN (China); co_nit = NIT (Colômbia); cr_tin = TIN (Costa Rica); cv_nif = NIF (Cabo Verde); de_stn = Steuernummer (Alemanha); do_rcn = RNC (Rep. Dominicana); ec_ruc = RUC (Equador); eg_tin = TIN (Egito); es_cif = CIF/NIF (Espanha); et_tin = TIN (Etiópia); eu_oss_vat = VAT/IVA regime OSS (União Europeia); eu_vat = VAT/IVA (União Europeia); fo_vat = VAT/IVA (Ilhas Faroé); gb_vat = VAT/IVA (Reino Unido); ge_vat = VAT/IVA (Geórgia); gi_tin = TIN (Gibraltar); gn_nif = NIF (Guiné); hk_br = BR (Hong Kong); hr_oib = OIB (Croácia); hu_tin = TIN (Hungria); ic_nif = NIF (Ilhas Canárias); id_npwp = NPWP (Indonésia); il_vat = VAT/IVA (Israel); in_gst = GSTIN (Índia); is_vat = VAT/IVA (Islândia); it_cf = Codice Fiscale (Itália); jp_cn = Corporate Number (Japão); jp_rn = RN para empresa estrangeira (Japão); jp_trn = TRN de consumo (Japão); ke_pin = KRA PIN (Quênia); kg_tin = TIN (Quirguistão); kh_tin = TIN (Camboja); kr_brn = BRN (Coreia do Sul); kz_bin = BIN (Cazaquistão); la_tin = TIN (Laos); li_uid = UID (Liechtenstein); li_vat = VAT/IVA (Liechtenstein); lk_vat = VAT/IVA (Sri Lanka); ma_vat = VAT/IVA (Marrocos); md_vat = VAT/IVA (Moldávia); me_pib = PIB (Montenegro); mk_vat = VAT/IVA (Macedônia do Norte); mr_nif = NIF (Mauritânia); mx_rfc = RFC (México); my_frp = FRP (Malásia); my_itn = ITN (Malásia); my_sst = SST (Malásia); ng_tin = TIN (Nigéria); no_vat = VAT/IVA (Noruega); no_voec = VOEC (Noruega); np_pan = PAN (Nepal); nz_gst = GST (Nova Zelândia); om_vat = VAT/IVA (Omã); pe_ruc = RUC (Peru); ph_tin = TIN (Filipinas); pl_nip = NIP (Polônia); py_ruc = RUC (Paraguai); ro_tin = TIN (Romênia); rs_pib = PIB (Sérvia); ru_inn = INN (Rússia); ru_kpp = KPP (Rússia); sa_vat = VAT/IVA (Arábia Saudita); sg_gst = GST (Singapura); sg_uen = UEN (Singapura); si_tin = TIN (Eslovênia); sn_ninea = NINEA (Senegal); sr_fin = FIN (Suriname); sv_nit = NIT (El Salvador); th_vat = VAT/IVA (Tailândia); tj_tin = TIN (Tajiquistão); tr_tin = TIN (Turquia); tw_vat = VAT/IVA (Taiwan); tz_vat = VAT/IVA (Tanzânia); ua_vat = VAT/IVA (Ucrânia); ug_tin = TIN (Uganda); unknown = tipo de ID fiscal desconhecido; us_ein = EIN (EUA); uy_ruc = RUC (Uruguai); uz_tin = TIN (Uzbequistão); uz_vat = VAT/IVA (Uzbequistão); ve_rif = RIF (Venezuela); vn_tin = TIN (Vietnã); za_vat = VAT/IVA (África do Sul); zm_tin = TIN (Zâmbia); zw_tin = TIN (Zimbábue). |
|
|
text |
[pt] O valor do documento fiscal (tax ID). |
stripe_invoices_default_tax_rates
Faturas: default_tax_rates (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
stripe_invoices_default_tax_rates_metadata
Faturas: default_tax_rates.metadata (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_invoices_default_tax_rates, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_invoices_discounts
Faturas: discounts (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os descontos aplicados à fatura. Os descontos dos itens de linha são aplicados antes dos descontos da fatura. Use expand[]=discounts para expandir cada desconto. |
stripe_invoices_metadata
Faturas: metadata (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_invoices_parent_subscription_details_metadata
Faturas: parent.subscription_details.metadata (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor definidos como metadados da assinatura quando uma fatura é criada. Torna-se um instantâneo imutável dos metadados da assinatura no momento da finalização da fatura. *Observação: este atributo só é preenchido para faturas criadas em ou após 29 de junho de 2023.* |
stripe_invoices_payment_settings_payment_method_options
Faturas: payment_settings.payment_method_options (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Determina se o valor inclui o imposto IOF. Valores possíveis: always = valor sempre inclui IOF; never = valor não inclui IOF. |
|
|
text |
[pt] O código de país desejado para as informações da conta bancária. Valores permitidos: DE, FR, IE ou NL. Valores possíveis: BE = Bélgica; DE = Alemanha; ES = Espanha; FR = França; IE = Irlanda; NL = Países Baixos. |
|
|
text |
[pt] Tipo de transferência bancária que pode ser usado para financiar. Valores permitidos: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer ou us_bank_transfer. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras. |
|
|
text |
[pt] Linha 1 do endereço (por exemplo, rua, caixa postal ou nome da empresa). |
|
|
text |
[pt] Linha 2 do endereço (por exemplo, apartamento, sala, unidade ou edifício). |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região. |
|
|
text |
[pt] Nome da empresa ou entidade. |
|
|
text |
[pt] O número oficial de registro para o tipo de registro informado. |
|
|
text |
[pt] Tipo de registro que a empresa ou entidade possui em seu país de registro. Valores possíveis: ch_ein = número de empresa (Suíça); de_hrb = registro comercial HRB (Alemanha); dk_cvr = número CVR (Dinamarca); es_cif = CIF fiscal (Espanha); fi_tunnus = Y-tunnus, ID empresarial (Finlândia); fr_siren = número SIREN (França); fr_siret = número SIRET (França); it_rea = registro REA (Itália); nl_kvk = número KvK (Holanda); no_org_number = número de organização (Noruega); no_pno = número pessoal (Noruega); se_org_number = número de organização (Suécia); se_pno = número pessoal (Suécia); uk_crn = número Companies House (Reino Unido). |
|
|
text |
[pt] Número do VAT ID. |
|
|
int |
[pt] O número de segundos (entre 10 e 1209600) após o qual o pagamento Pix expirará. O padrão é 86400 segundos. |
|
|
text |
[pt] O tipo de método de financiamento a ser usado quando não há fundos suficientes no saldo do cliente. Valores permitidos: bank_transfer. Valores possíveis: bank_transfer = transferência bancária. |
|
|
boolean |
[pt] Se o parcelamento (Installments) está habilitado para esta fatura. Valores: true (sim) ou false (não). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor máximo que pode ser cobrado numa única fatura. Sem máximo informado, não há limite. |
|
|
text |
[pt] Só maximum é suportado. Valores possíveis: fixed = valor exato a cobrar; maximum = valor máximo a cobrar. |
|
|
text |
[pt] Descrição do mandato ou da assinatura exibida ao cliente. |
|
|
timestamp |
[pt] Data de término do mandato ou da assinatura. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Finalidade dos pagamentos. Tem valor padrão conforme o código de categoria do comerciante (MCC). Valores possíveis: dependant_support = sustento de dependentes; government = pagamento governamental; loan = empréstimo; mortgage = financiamento imobiliário; other = outro propósito; pension = aposentadoria/pensão; personal = pagamento pessoal; retail = compra no varejo; salary = salário; tax = pagamento de impostos; utility = contas de consumo (água, luz etc.). |
|
|
text |
[pt] Tipo de transação do mandato. Valores possíveis: business = transação empresarial; personal = transação pessoal. |
|
|
text |
[pt] Idioma preferido da página de autorização do Bancontact para a qual o cliente é redirecionado. Valores possíveis: de = alemão; en = inglês; fr = francês; nl = holandês. |
|
|
text |
[pt] Identificador ou referência a que este pagamento corresponde. |
|
|
text |
[pt] Recomendamos fortemente que você use o nosso SCA Engine para solicitar automaticamente a autenticação dos seus clientes com base no nível de risco e em outros requisitos. No entanto, se quiser solicitar 3D Secure com base na lógica do seu próprio mecanismo antifraude, informe esta opção. Valores possíveis: any = solicita 3D Secure sempre que possível; automatic = Stripe decide quando exigir 3D Secure; challenge = força desafio 3D Secure. |
|
|
text |
[pt] Método de verificação da conta bancária. O valor padrão é automatic. Valores possíveis: automatic = automática (instantânea ou microdepósitos); instant = verificação instantânea; microdeposits = verificação por microdepósitos. |
stripe_invoices_pay_pay_fin_filter_account_subcategories
Faturas: payment_settings.payment_method_options.financial_connections.filters.account_subcategories (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_invoices_payment_settings_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Subcategorias de conta usadas para filtrar as possíveis contas a vincular. As subcategorias válidas são checking e savings. Valores possíveis: checking = conta corrente; savings = conta poupança. |
stripe_invoices_payment_settings_pay_financi_permissions
Faturas: payment_settings.payment_method_options.financial_connections.permissions (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_invoices_payment_settings_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de permissões a solicitar. A permissão payment_method deve ser incluída. Valores possíveis: balances = saldos da conta; ownership = titularidade da conta; payment_method = uso como meio de pagamento; transactions = transações da conta. |
stripe_invoices_payment_settings_pay_financial__prefetch
Faturas: payment_settings.payment_method_options.financial_connections.prefetch (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_invoices_payment_settings_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Recursos de dados solicitados para serem recuperados na criação da conta. Valores possíveis: balances = saldos; ownership = titularidade; transactions = transações. |
stripe_invoices_payment_settings_payment_method_types
Faturas: payment_settings.payment_method_types (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de tipos de método de pagamento (ex.: card) a fornecer ao PaymentIntent da fatura. Valores possíveis: ach_credit_transfer = transferência ACH a crédito (EUA); ach_debit = débito ACH (EUA); acss_debit = débito pré-autorizado ACSS (Canadá); affirm = Affirm (parcelamento, EUA); alipay = Alipay (carteira digital, China); amazon_pay = Amazon Pay (carteira digital); au_becs_debit = débito em conta BECS (Austrália); bacs_debit = débito em conta Bacs (Reino Unido); bancontact = Bancontact (Bélgica); billie = Billie (pagamento B2B a prazo); blik = BLIK (pagamento móvel, Polônia); boleto = boleto bancário (Brasil); card = cartão (online); cashapp = Cash App Pay (EUA); crypto = criptomoeda (stablecoin); custom = meio de pagamento personalizado; customer_balance = saldo do cliente (transferência bancária); eps = EPS (transferência, Áustria); fpx = FPX (transferência, Malásia); giropay = giropay (transferência, Alemanha); grabpay = GrabPay (carteira digital, Sudeste Asiático); ideal = iDEAL (transferência, Holanda); jp_credit_transfer = transferência bancária (Japão); kakao_pay = Kakao Pay (carteira digital, Coreia); klarna = Klarna (meio de pagamento); konbini = Konbini (pagamento em loja, Japão); kr_card = cartão coreano; link = Link (checkout salvo da Stripe); mb_way = MB WAY (pagamento móvel, Portugal); multibanco = Multibanco (referência bancária, Portugal); naver_pay = Naver Pay (carteira digital, Coreia); nz_bank_account = débito em conta (Nova Zelândia); p24 = Przelewy24 (transferência, Polônia); pay_by_bank = pagamento via banco (open banking); payco = PAYCO (carteira digital, Coreia); paynow = PayNow (QR code, Singapura); paypal = PayPal (carteira digital); payto = PayTo (débito em conta, Austrália); pix = Pix (pagamento instantâneo, Brasil); promptpay = PromptPay (QR code, Tailândia); revolut_pay = Revolut Pay (carteira digital); satispay = Satispay (pagamento móvel, Itália); sepa_credit_transfer = transferência SEPA a crédito; sepa_debit = débito em conta SEPA (Europa); sofort = Sofort (transferência, Europa); swish = Swish (pagamento móvel, Suécia); twint = TWINT (pagamento móvel, Suíça); upi = UPI (pagamento instantâneo, Índia); us_bank_account = débito em conta ACH (EUA); wechat_pay = WeChat Pay (carteira digital, China). |
stripe_invoices_shipping_cost_taxes
Faturas: shipping_cost.taxes (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Alíquotas de imposto podem ser aplicadas a faturas, assinaturas e sessões de checkout para cobrar imposto. Guia relacionado: Tax rates… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
stripe_invoices_threshold_reason_item_reasons
Faturas: threshold_reason.item_reasons (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
int |
[pt] O limite de quantidade (faixa) que se aplicou ao item de linha informado. |
stripe_invoices_threshold_rea_item_reasons_line_item_ids
Faturas: threshold_reason.item_reasons.line_item_ids (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_invoices_threshold_reason_item_reasons, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] IDs dos itens de linha que acionaram a fatura de limite (threshold). |
stripe_invoices_total_discount_amounts
Faturas: total_discount_amounts (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do desconto. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de desconto. |
stripe_invoices_total_pretax_credit_amounts
Faturas: total_pretax_credit_amounts (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do crédito antes de impostos. |
|
|
text |
[pt] A transação de saldo de crédito que foi aplicada para obter este valor de crédito antes de impostos. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de crédito antes de impostos. |
|
|
text |
[pt] Tipo do valor de crédito antes de impostos referenciado. Valores possíveis: credit_balance_transaction = transação de crédito de cobrança; discount = desconto. |
stripe_invoices_total_taxes
Faturas: total_taxes (uma linha por item; liga-se a stripe_invoices pela coluna invoice_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto. |
|
|
text |
[pt] Se este imposto é inclusivo ou exclusivo. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço. |
|
|
text |
[pt] ID da alíquota de imposto… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_available = motivo não disponível; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
|
|
text |
[pt] O tipo de informação fiscal. Valores possíveis: tax_rate_details = detalhes da alíquota de imposto. |
Faturas - Detalhes - Itens da fatura
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- invoice_id → Faturas > id
- invoice → Faturas > id
- subscription → Assinaturas > id
- invoice_id > _invoice_lines_discount_amounts → Faturas > id
- invoice_line_id > _invoice_lines_discount_amounts → Faturas - Detalhes - Itens da fatura > id
- invoice_id > _invoice_lines_discounts → Faturas > id
- invoice_line_id > _invoice_lines_discounts → Faturas - Detalhes - Itens da fatura > id
- invoice_id > _invoice_lines_metadata → Faturas > id
- invoice_line_id > _invoice_lines_metadata → Faturas - Detalhes - Itens da fatura > id
- invoice_id > _invoice_lines_pare_inv_pro_cre_invoice_line_items → Faturas > id
- invoice_line_id > _invoice_lines_pare_inv_pro_cre_invoice_line_items → Faturas - Detalhes - Itens da fatura > id
- invoice_id > _invoice_lines_pare_sub_pro_cre_invoice_line_items → Faturas > id
- invoice_line_id > _invoice_lines_pare_sub_pro_cre_invoice_line_items → Faturas - Detalhes - Itens da fatura > id
- invoice_id > _invoice_lines_pretax_credit_amounts → Faturas > id
- invoice_line_id > _invoice_lines_pretax_credit_amounts → Faturas - Detalhes - Itens da fatura > id
- invoice_id > _invoice_lines_taxes → Faturas > id
- invoice_line_id > _invoice_lines_taxes → Faturas - Detalhes - Itens da fatura > id
Objeto principal
Itens de cada fatura (todas as linhas, não só as 10 que a fatura traz embutidas), com valor, quantidade, período e preço.
stripe_invoice_lines_discount_amounts
Faturas - Detalhes - Itens da fatura: discount_amounts (uma linha por item; liga-se a stripe_invoice_lines pela coluna invoice_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do desconto. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de desconto. |
stripe_invoice_lines_discounts
Faturas - Detalhes - Itens da fatura: discounts (uma linha por item; liga-se a stripe_invoice_lines pela coluna invoice_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os descontos aplicados ao item de linha da fatura. Os descontos do item de linha são aplicados antes dos descontos da fatura. Use expand[]=discounts para expandir cada desconto. |
stripe_invoice_lines_metadata
Faturas - Detalhes - Itens da fatura: metadata (uma linha por item; liga-se a stripe_invoice_lines pela coluna invoice_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_lines). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_invoice_lines_pare_inv_pro_cre_invoice_line_items
Faturas - Detalhes - Itens da fatura: parent.invoice_item_details.proration_details.credited_items.invoice_line_items (uma linha por item; liga-se a stripe_invoice_lines pela coluna invoice_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Itens de linha da fatura creditados… |
stripe_invoice_lines_pare_sub_pro_cre_invoice_line_items
Faturas - Detalhes - Itens da fatura: parent.subscription_item_details.proration_details.credited_items.invoice_line_items (uma linha por item; liga-se a stripe_invoice_lines pela coluna invoice_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Itens de linha da fatura creditados… |
stripe_invoice_lines_pretax_credit_amounts
Faturas - Detalhes - Itens da fatura: pretax_credit_amounts (uma linha por item; liga-se a stripe_invoice_lines pela coluna invoice_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do crédito antes de impostos. |
|
|
text |
[pt] A transação de saldo de crédito que foi aplicada para obter este valor de crédito antes de impostos. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de crédito antes de impostos. |
|
|
text |
[pt] Tipo do valor de crédito antes de impostos referenciado. Valores possíveis: credit_balance_transaction = transação de crédito de cobrança; discount = desconto. |
stripe_invoice_lines_taxes
Faturas - Detalhes - Itens da fatura: taxes (uma linha por item; liga-se a stripe_invoice_lines pela coluna invoice_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_invoices). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto. |
|
|
text |
[pt] Se este imposto é inclusivo ou exclusivo. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço. |
|
|
text |
[pt] ID da alíquota de imposto… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_available = motivo não disponível; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
|
|
text |
[pt] O tipo de informação fiscal. Valores possíveis: tax_rate_details = detalhes da alíquota de imposto. |
Funcionalidades (entitlements)
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Funcionalidades que podem ser concedidas a clientes por produto (Entitlements).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Recursos inativos não podem ser vinculados a novos produtos e não serão retornados pelo endpoint de listagem de recursos. Valores: true (sim) ou false (não). |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Uma chave única que você fornece como identificador do seu próprio sistema. Pode ter até 80 caracteres. |
|
|
text |
[pt] O nome do recurso, para uso próprio, não destinado a ser exibido ao cliente. |
stripe_entitlements_features_metadata
Funcionalidades (entitlements): metadata (uma linha por item; liga-se a stripe_entitlements_features pela coluna feature_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_entitlements_features). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Intenções de configuração (SetupIntents)
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer → Clientes > id
- setup_intent_id > _setup_intents_allowed_payment_method_types → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_excluded_payment_method_types → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_flow_directions → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_metadata → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_payment_method_options → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_pay_fin_filte_account_subcategories → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_pay_financial_connectio_permissions → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_paym_financial_connections_prefetch → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_payment_mandate_options_default_for → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_pay_mandate_options_supported_types → Intenções de configuração (SetupIntents) > id
- setup_intent_id > _setup_intents_payment_method_types → Intenções de configuração (SetupIntents) > id
Objeto principal
Intenções de configuração (SetupIntents): só o cadastro de cartões ou outros meios de pagamento para cobrar depois. Não envolve dinheiro; uma falha aqui é falha ao CADASTRAR o cartão, não um pagamento recusado.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] ID do aplicativo Connect que criou o SetupIntent. |
|
|
boolean |
[pt] Se presente, o método de pagamento do SetupIntent será vinculado à Stripe Account do contexto. Só pode ser usado nos fluxos de movimentação de dinheiro próprios desta Stripe Account, como InboundTransfer e OutboundTransfers. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Controla se este SetupIntent aceitará métodos de pagamento baseados em redirecionamento. Métodos de pagamento baseados em redirecionamento podem exigir que o cliente seja redirecionado ao aplicativo ou site do método de pagamento para autenticação ou etapas adicionais. Valores possíveis: always = aceita métodos com redirecionamento; never = não aceita métodos com redirecionamento. |
|
|
boolean |
[pt] Calcula automaticamente os métodos de pagamento compatíveis… Valores: true (sim) ou false (não). |
|
|
text |
[pt] Motivo do cancelamento deste SetupIntent, um de abandoned, requested_by_customer ou duplicate. Valores possíveis: abandoned = abandonado pelo cliente; duplicate = pagamento duplicado; requested_by_customer = solicitado pelo cliente. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] ID do Customer ao qual este SetupIntent pertence, se existir. Se presente, o método de pagamento do SetupIntent será vinculado ao Customer após a configuração bem-sucedida. Métodos de pagamento vinculados a outros Customers não podem ser usados com este SetupIntent. |
|
|
text |
[pt] ID da Account à qual este SetupIntent pertence, se existir. Se presente, o método de pagamento do SetupIntent será vinculado à Account após a configuração bem-sucedida. Métodos de pagamento vinculados a outras Accounts não podem ser usados com este SetupIntent. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, string curta que indica como proceder diante do erro, se o emissor a fornecer. |
|
|
text |
[pt] Para erros de cartão, o ID da cobrança que falhou. |
|
|
text |
[pt] Para alguns erros que podem ser tratados programaticamente, string curta que indica o código de erro informado. |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, string curta que indica o motivo da recusa segundo o emissor, se ele a fornecer. |
|
|
text |
[pt] URL com mais informações sobre o código de erro informado. |
|
|
text |
[pt] Mensagem legível por humanos com mais detalhes sobre o erro. Em erros de cartão, essas mensagens podem ser exibidas aos seus usuários. |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, código de 2 dígitos que indica a orientação dada ao comerciante pela rede do cartão sobre como proceder diante do erro. |
|
|
text |
[pt] Para pagamentos recusados pela rede, código alfanumérico que indica o motivo da falha do pagamento. |
|
|
text |
[pt] Se o erro for específico de um parâmetro, o parâmetro relacionado ao erro. Por exemplo, você pode usá-lo para exibir uma mensagem perto do campo de formulário correto. |
|
|
text |
[pt] Uma PaymentIntent guia você pelo processo de cobrança de um pagamento do seu cliente. Recomendamos criar exatamente uma PaymentIntent para cada pedido ou sessão de cliente no seu sistema. |
|
|
text |
[pt] Objetos PaymentMethod representam os instrumentos de pagamento do seu cliente. Você pode usá-los com PaymentIntents para cobrar pagamentos ou salvá-los em objetos Customer para guardar os dados do instrumento para pagamentos futuros. Guias relacionados: Payment Methods e More Payment Scenarios. |
|
|
text |
[pt] Se o erro for específico do tipo de meio de pagamento, o tipo de meio de pagamento que teve problema. Este campo só é preenchido em erros relacionados a faturas. |
|
|
text |
[pt] URL da entrada do log da requisição no seu dashboard. |
|
|
text |
[pt] Uma SetupIntent guia você pelo processo de configurar e salvar as credenciais de pagamento de um cliente para pagamentos futuros. Por exemplo, você pode usar uma SetupIntent para configurar e salvar o cartão do cliente sem cobrar um pagamento imediatamente. |
|
|
text |
[pt] O objeto de origem (source) dos erros retornados em uma requisição envolvendo uma source. |
|
|
text |
[pt] O tipo de erro retornado. Um entre api_error, card_error, idempotency_error ou invalid_request_error… Valores possíveis: api_error = erro interno da API Stripe; card_error = erro do cartão (ex.: recusa); idempotency_error = erro de chave de idempotência; invalid_request_error = requisição inválida. |
|
|
text |
[pt] O SetupAttempt mais recente deste SetupIntent. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
boolean |
[pt] Defina como true para habilitar o Managed Payments, a solução de merchant of record da Stripe, para esta sessão. Valores: true (sim) ou false (não). |
|
|
text |
[pt] ID do Mandate de uso múltiplo (multi use) gerado pelo SetupIntent. |
|
|
text |
[pt] A conta (se houver) a que se destina a configuração (setup). |
|
|
text |
[pt] ID do método de pagamento usado com este SetupIntent. Se o método de pagamento for card_present e não for uma carteira digital, o generated_card associado ao latest_attempt é vinculado ao Customer. |
|
|
text |
[pt] ID da configuração de método de pagamento usada. |
|
|
text |
[pt] ID da configuração de método de pagamento pai usada. |
|
|
text |
[pt] ID do Mandate de uso único (single_use) gerado pelo SetupIntent. |
|
|
text |
[pt] Status deste SetupIntent, um de requires_payment_method, requires_confirmation, requires_action, processing, canceled ou succeeded. Valores possíveis: canceled = cancelado; processing = em processamento; requires_action = requer ação do cliente (ex.: 3D Secure); requires_confirmation = aguardando confirmação; requires_payment_method = aguardando meio de pagamento; succeeded = concluído com sucesso. |
|
|
text |
[pt] Indica como o método de pagamento deve ser usado no futuro. Use on_session se pretende reutilizar o método de pagamento apenas quando o cliente estiver no seu fluxo de checkout. Use off_session se o cliente pode ou não estar no seu fluxo de checkout. |
stripe_setup_intents_allowed_payment_method_types
Intenções de configuração (SetupIntents): allowed_payment_method_types (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de tipos de método de pagamento a permitir neste SetupIntent. A Stripe só usará métodos desta lista ao determinar quais métodos de pagamento oferecer. Valores possíveis: acss_debit = débito pré-autorizado ACSS (Canadá); affirm = Affirm (parcelamento, EUA); afterpay_clearpay = Afterpay/Clearpay (parcelamento); alipay = Alipay (carteira digital, China); alma = Alma (parcelamento, França); amazon_pay = Amazon Pay (carteira digital); au_becs_debit = débito em conta BECS (Austrália); bacs_debit = débito em conta Bacs (Reino Unido); bancontact = Bancontact (Bélgica); billie = Billie (pagamento B2B a prazo); bizum = Bizum (pagamento móvel, Espanha); blik = BLIK (pagamento móvel, Polônia); boku_promptpay = PromptPay via Boku (Tailândia); boleto = boleto bancário (Brasil); capchase_pay = Capchase Pay (financiamento B2B); card = cartão (online); card_present = cartão presencial (Terminal); cashapp = Cash App Pay (EUA); check_scan = cheque digitalizado; click_to_pay = Click to Pay (carteira das bandeiras); crypto = criptomoeda (stablecoin); customer_balance = saldo do cliente (transferência bancária); demo_pay = meio de demonstração (testes); duitnow = DuitNow (Malásia); dummy_auth_push = meio fictício de teste; dummy_passthrough_card = cartão fictício de teste; edenred = Edenred (vale-benefício); eps = EPS (transferência, Áustria); fpx = FPX (transferência, Malásia); gcash = GCash (carteira, Filipinas); getbalance = Balance (pagamento B2B); gift_card = vale-presente; giropay = giropay (transferência, Alemanha); gopay = GoPay (carteira, Indonésia); grabpay = GrabPay (carteira digital, Sudeste Asiático); id_bank_transfer = transferência bancária (Indonésia); ideal = iDEAL (transferência, Holanda); interac_present = cartão Interac presencial (Canadá); kakao_pay = Kakao Pay (carteira digital, Coreia); klarna = Klarna (meio de pagamento); knet = KNET (Kuwait); konbini = Konbini (pagamento em loja, Japão); kr_card = cartão coreano; kr_market = meios locais da Coreia do Sul; kriya = Kriya (B2B a prazo, Reino Unido); link = Link (checkout salvo da Stripe); mb_way = MB WAY (pagamento móvel, Portugal); mobilepay = MobilePay (carteira digital, Nórdicos); momo = MoMo (carteira, Vietnã); mondu = Mondu (B2B a prazo); multibanco = Multibanco (referência bancária, Portugal); naver_pay = Naver Pay (carteira digital, Coreia); netbanking = netbanking (Índia); ng_bank = banco (Nigéria); ng_bank_transfer = transferência bancária (Nigéria); ng_card = cartão (Nigéria); ng_market = meios locais da Nigéria; ng_ussd = USSD (Nigéria); ng_wallet = carteira digital (Nigéria); nz_bank_account = débito em conta (Nova Zelândia); octopus = Octopus (cartão, Hong Kong); oxxo = OXXO (pagamento em loja, México); p24 = Przelewy24 (transferência, Polônia); paper_check = cheque em papel; pay_by_bank = pagamento via banco (open banking); payco = PAYCO (carteira digital, Coreia); paynow = PayNow (QR code, Singapura); paypal = PayPal (carteira digital); paypay = PayPay (carteira digital, Japão); payto = PayTo (débito em conta, Austrália); pix = Pix (pagamento instantâneo, Brasil); promptpay = PromptPay (QR code, Tailândia); qris = QRIS (QR, Indonésia); rechnung = Rechnung (fatura, Alemanha); revolut_pay = Revolut Pay (carteira digital); samsung_pay = Samsung Pay (carteira digital); satispay = Satispay (pagamento móvel, Itália); scalapay = Scalapay (parcelamento, Europa); sepa_debit = débito em conta SEPA (Europa); sequra = SeQura (parcelamento, Espanha); shop_pay = Shop Pay (Shopify); shopeepay = ShopeePay (carteira); sofort = Sofort (transferência, Europa); south_korea_market = meios locais da Coreia do Sul; stripe_balance = saldo da conta Stripe; sunbit = Sunbit (parcelamento, EUA); swish = Swish (pagamento móvel, Suécia); tamara = Tamara (parcelado, Oriente Médio); test_pay = meio de teste; touch_n_go = Touch 'n Go (carteira, Malásia); truemoney = TrueMoney (carteira, Tailândia); twint = TWINT (pagamento móvel, Suíça); upi = UPI (pagamento instantâneo, Índia); us_bank_account = débito em conta ACH (EUA); us_cash_voucher = boleto de pagamento em dinheiro (EUA); vipps = Vipps (carteira, Noruega); wechat_pay = WeChat Pay (carteira digital, China); wero = Wero (carteira, Europa); zip = Zip (parcelamento). |
stripe_setup_intents_excluded_payment_method_types
Intenções de configuração (SetupIntents): excluded_payment_method_types (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Tipos de método de pagamento excluídos deste SetupIntent. Valores possíveis: acss_debit = débito pré-autorizado ACSS (Canadá); affirm = Affirm (parcelamento, EUA); afterpay_clearpay = Afterpay/Clearpay (parcelamento); alipay = Alipay (carteira digital, China); alma = Alma (parcelamento, França); amazon_pay = Amazon Pay (carteira digital); au_becs_debit = débito em conta BECS (Austrália); bacs_debit = débito em conta Bacs (Reino Unido); bancontact = Bancontact (Bélgica); billie = Billie (pagamento B2B a prazo); bizum = Bizum (pagamento móvel, Espanha); blik = BLIK (pagamento móvel, Polônia); boleto = boleto bancário (Brasil); card = cartão (online); cashapp = Cash App Pay (EUA); crypto = criptomoeda (stablecoin); customer_balance = saldo do cliente (transferência bancária); eps = EPS (transferência, Áustria); fpx = FPX (transferência, Malásia); giropay = giropay (transferência, Alemanha); grabpay = GrabPay (carteira digital, Sudeste Asiático); ideal = iDEAL (transferência, Holanda); kakao_pay = Kakao Pay (carteira digital, Coreia); klarna = Klarna (meio de pagamento); konbini = Konbini (pagamento em loja, Japão); kr_card = cartão coreano; mb_way = MB WAY (pagamento móvel, Portugal); mobilepay = MobilePay (carteira digital, Nórdicos); multibanco = Multibanco (referência bancária, Portugal); naver_pay = Naver Pay (carteira digital, Coreia); nz_bank_account = débito em conta (Nova Zelândia); oxxo = OXXO (pagamento em loja, México); p24 = Przelewy24 (transferência, Polônia); pay_by_bank = pagamento via banco (open banking); payco = PAYCO (carteira digital, Coreia); paynow = PayNow (QR code, Singapura); paypal = PayPal (carteira digital); paypay = PayPay (carteira digital, Japão); payto = PayTo (débito em conta, Austrália); pix = Pix (pagamento instantâneo, Brasil); promptpay = PromptPay (QR code, Tailândia); revolut_pay = Revolut Pay (carteira digital); samsung_pay = Samsung Pay (carteira digital); satispay = Satispay (pagamento móvel, Itália); scalapay = Scalapay (parcelamento, Europa); sepa_debit = débito em conta SEPA (Europa); sequra = SeQura (parcelamento, Espanha); sofort = Sofort (transferência, Europa); sunbit = Sunbit (parcelamento, EUA); swish = Swish (pagamento móvel, Suécia); twint = TWINT (pagamento móvel, Suíça); upi = UPI (pagamento instantâneo, Índia); us_bank_account = débito em conta ACH (EUA); wechat_pay = WeChat Pay (carteira digital, China); zip = Zip (parcelamento). |
stripe_setup_intents_flow_directions
Intenções de configuração (SetupIntents): flow_directions (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Indica as direções da movimentação de dinheiro para as quais este método de pagamento deve ser usado. Inclua inbound se pretende usar o método de pagamento como origem de onde retirar fundos. Inclua outbound se pretende usar o método de pagamento como destino para onde enviar fundos. Valores possíveis: inbound = entrada (recebimento); outbound = saída (envio). |
stripe_setup_intents_metadata
Intenções de configuração (SetupIntents): metadata (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_setup_intents_payment_method_options
Intenções de configuração (SetupIntents): payment_method_options (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] PayPal Billing Agreement ID (BAID). ID gerado pelo PayPal que representa o mandato entre o comerciante e o cliente. |
|
|
text |
[pt] Moeda suportada pela conta bancária… Valores possíveis: cad = dólar canadense; usd = dólar americano. |
|
|
text |
[pt] Somente para integrações webview. Ao concluir o login OAuth no navegador nativo, o usuário será redirecionado para esta URL para voltar ao seu app. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que será cobrado. Obrigatório quando amount_type é fixed. |
|
|
text |
[pt] Determina se o valor inclui o imposto IOF. Valores possíveis: always = valor sempre inclui IOF; never = valor não inclui IOF. |
|
|
text |
[pt] Tipo de valor cobrado: exato (fixed) ou até o valor de amount (maximum). Padrão maximum. Valores possíveis: fixed = valor exato a cobrar; maximum = valor máximo a cobrar. |
|
|
text |
[pt] Método de coleta do mandato. Valores possíveis: paper = mandato em papel. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] URL para o texto personalizado do mandato… |
|
|
text |
[pt] Descrição do mandato ou da assinatura exibida ao cliente. |
|
|
text |
[pt] Data, no formato AAAA-MM-DD, depois da qual os pagamentos não serão mais cobrados. Por padrão, sem data de término. |
|
|
timestamp |
[pt] Data em que o mandato expira. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Frequência de pagamento: day, week, month, year ou sporadic. Valores possíveis: day = diário; month = mensal; sporadic = esporádico; week = semanal; year = anual. |
|
|
int |
[pt] Número de intervalos entre pagamentos. Ex.: interval=month e interval_count=3 indicam um pagamento a cada três meses. Intervalo máximo de um ano (1 ano, 12 meses ou 52 semanas). Opcional quando interval=sporadic. |
|
|
text |
[pt] Descrição do intervalo. Obrigatório apenas se o parâmetro 'payment_schedule' for 'interval' ou 'combined'. |
|
|
text |
[pt] Cronograma de pagamento do mandato. Valores possíveis: combined = combinado: periódico e esporádico; interval = em intervalos fixos; sporadic = esporádico, sob demanda. |
|
|
int |
[pt] Número de pagamentos feitos em um período de pagamento. Padrão 1, exceto quando payment_schedule é adhoc; nesse caso, sem limite. |
|
|
text |
[pt] Finalidade dos pagamentos. Tem valor padrão conforme o código de categoria do comerciante (MCC). Valores possíveis: dependant_support = sustento de dependentes; government = pagamento governamental; loan = empréstimo; mortgage = financiamento imobiliário; other = outro propósito; pension = aposentadoria/pensão; personal = pagamento pessoal; retail = compra no varejo; salary = salário; tax = pagamento de impostos; utility = contas de consumo (água, luz etc.). |
|
|
text |
[pt] Identificador único do mandato ou da assinatura. |
|
|
text |
[pt] Prefixo usado para gerar a referência do mandato. No máximo 12 caracteres: letras maiúsculas, números, espaços ou os caracteres '/', '_', '-', '&', '.'. Não pode começar com 'DDIC' nem 'STRIPE'. |
|
|
text |
[pt] Data, no formato AAAA-MM-DD, a partir da qual os pagamentos serão cobrados. Por padrão, o momento da confirmação. |
|
|
text |
[pt] Tipo de transação do mandato. Valores possíveis: business = transação empresarial; personal = transação pessoal. |
|
|
text |
[pt] Tipo do mandato. Valores possíveis: off_session = cliente ausente (off-session). |
|
|
text |
[pt] Rede selecionada para processar esta SetupIntent. Depende das redes disponíveis do cartão anexado à intenção de configuração. Só pode ser definida no momento da confirmação. Valores possíveis: amex; cartes_bancaires; diners; discover; eftpos_au; girocard; interac; jcb; link; mastercard; unionpay; unknown; visa. |
|
|
text |
[pt] Localidade (locale) preferida da página de checkout da Klarna para a qual o cliente é redirecionado. |
|
|
text |
[pt] Recomendamos fortemente que você use o nosso SCA Engine para solicitar automaticamente a autenticação dos seus clientes com base no nível de risco e em outros requisitos. No entanto, se quiser solicitar 3D Secure com base na lógica do seu próprio mecanismo antifraude, informe esta opção. Valores possíveis: any = solicita 3D Secure sempre que possível; automatic = Stripe decide quando exigir 3D Secure; challenge = força desafio 3D Secure. |
|
|
text |
[pt] Método de verificação da conta bancária. O valor padrão é automatic. Valores possíveis: automatic = automática (instantânea ou microdepósitos); instant = verificação instantânea; microdeposits = verificação por microdepósitos. |
stripe_setup_intents_pay_fin_filte_account_subcategories
Intenções de configuração (SetupIntents): payment_method_options.financial_connections.filters.account_subcategories (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_setup_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Subcategorias de conta usadas para filtrar as possíveis contas a vincular. As subcategorias válidas são checking e savings. Valores possíveis: checking = conta corrente; savings = conta poupança. |
stripe_setup_intents_pay_financial_connectio_permissions
Intenções de configuração (SetupIntents): payment_method_options.financial_connections.permissions (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_setup_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de permissões a solicitar. A permissão payment_method deve ser incluída. Valores possíveis: balances = saldos da conta; ownership = titularidade da conta; payment_method = uso como meio de pagamento; transactions = transações da conta. |
stripe_setup_intents_paym_financial_connections_prefetch
Intenções de configuração (SetupIntents): payment_method_options.financial_connections.prefetch (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_setup_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Recursos de dados solicitados para serem recuperados na criação da conta. Valores possíveis: balances = saldos; ownership = titularidade; transactions = transações. |
stripe_setup_intents_payment_mandate_options_default_for
Intenções de configuração (SetupIntents): payment_method_options.mandate_options.default_for (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_setup_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista de produtos da Stripe em que este mandato pode ser selecionado automaticamente. Valores possíveis: invoice = padrão para faturas; subscription = padrão para assinaturas. |
stripe_setup_intents_pay_mandate_options_supported_types
Intenções de configuração (SetupIntents): payment_method_options.mandate_options.supported_types (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_setup_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Tipo de mandato suportado. Valor possível: india. Valores possíveis: india = mandato da Índia. |
stripe_setup_intents_payment_method_types
Intenções de configuração (SetupIntents): payment_method_types (uma linha por item; liga-se a stripe_setup_intents pela coluna setup_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_setup_intents). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de tipos de método de pagamento (ex.: card) que este SetupIntent tem permissão de configurar. Uma lista dos tipos de método de pagamento válidos pode ser encontrada aqui. |
Intenções de pagamento (PaymentIntents)
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer → Clientes > id
- payment_intent_id > _payment_intents_allowed_payment_method_types → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_excluded_payment_method_types → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_metadata → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_payment_method_options → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_pay_bank__requested_address_types → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_pay_fin_fil_account_subcategories → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_pay_financial_connect_permissions → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_pay_financial_connection_prefetch → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_paym_installments_available_plans → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_pay_mandate_optio_supported_types → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_payment_method_types → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_transfer_data_metadata → Intenções de pagamento (PaymentIntents) > id
- payment_intent_id > _payment_intents_transfer_da_payment_data_metadata → Intenções de pagamento (PaymentIntents) > id
Objeto principal
Intenções de pagamento (PaymentIntents): o pedido de pagamento do começo ao fim (uma intenção pode ter várias tentativas de cobrança). Status requires_payment_method depois de uma tentativa = pagamento recusado, aguardando outro cartão. Para valores recebidos e falhas, a tabela de Cobranças é mais simples.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que se pretende cobrar por este PaymentIntent. Valor que representa quanto cobrar. O valor mínimo é US$ 0,50 ou o equivalente na moeda da cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que pode ser capturado deste PaymentIntent. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O desconto total aplicado à transação, representado. Um inteiro maior que 0. Este campo é mutuamente exclusivo com o campo amount_details[line_items][#][discount_amount]. |
|
|
text |
[pt] O código do erro ocorrido ao validar os detalhes do valor atual. Valores possíveis: amount_details_amount_mismatch = soma dos itens difere do valor total; amount_details_tax_shipping_discount_greater_than_amount = imposto/frete/desconto maior que o valor. |
|
|
text |
[pt] Mensagem com mais detalhes sobre o erro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Se um bem físico estiver sendo enviado, o custo do frete representado. Um inteiro maior ou igual a 0. |
|
|
text |
[pt] Se um bem físico estiver sendo enviado, o CEP de origem do envio. No máximo 10 caracteres alfanuméricos; hifens e espaços são permitidos. |
|
|
text |
[pt] Se um bem físico estiver sendo enviado, o CEP de destino do envio. No máximo 10 caracteres alfanuméricos; hifens e espaços são permitidos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor total de imposto da transação, representado. Obrigatório para taxas L2. Um inteiro maior ou igual a 0. Este campo é mutuamente exclusivo com o campo amount_details[line_items][#][tax][total_tax_amount]. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Parcela do valor que corresponde a uma gorjeta. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que este PaymentIntent coleta. |
|
|
text |
[pt] ID do aplicativo Connect que criou o PaymentIntent. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor da taxa de aplicação (se houver) que será solicitada para ser aplicada ao pagamento e transferida para a conta Stripe do proprietário do aplicativo. O valor da taxa de aplicação coletada será limitado ao total capturado. |
|
|
text |
[pt] Controla se este PaymentIntent aceitará métodos de pagamento baseados em redirecionamento. Métodos de pagamento baseados em redirecionamento podem exigir que o cliente seja redirecionado ao aplicativo ou site do método de pagamento para autenticação ou etapas adicionais. Valores possíveis: always = aceita métodos com redirecionamento; never = não aceita métodos com redirecionamento. |
|
|
boolean |
[pt] Calcula automaticamente os métodos de pagamento compatíveis… Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Preenchido quando o status é canceled; é o momento em que o PaymentIntent foi cancelado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Motivo do cancelamento deste PaymentIntent, fornecido pelo usuário (duplicate, fraudulent, requested_by_customer ou abandoned) ou gerado internamente pela Stripe (failed_invoice, void_invoice, automatic ou expired). Valores possíveis: abandoned = abandonado pelo cliente; automatic = cancelado automaticamente pela Stripe; duplicate = pagamento duplicado; expired = expirado; failed_invoice = fatura associada falhou; fraudulent = suspeita de fraude; requested_by_customer = solicitado pelo cliente; void_invoice = fatura associada anulada. |
|
|
text |
[pt] Controla quando os fundos serão capturados da conta do cliente. Valores possíveis: automatic = captura automática na autorização; automatic_async = captura automática assíncrona; manual = captura manual posterior. |
|
|
text |
[pt] Descreve se podemos confirmar este PaymentIntent automaticamente ou se ele exige uma ação do cliente para confirmar o pagamento. Valores possíveis: automatic = confirmação automática do PaymentIntent; manual = confirmação manual pelo servidor. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] ID do Customer ao qual este PaymentIntent pertence, se existir. Métodos de pagamento vinculados a outros Customers não podem ser usados com este PaymentIntent. |
|
|
text |
[pt] ID da Account que representa o cliente ao qual este PaymentIntent pertence, se existir. Métodos de pagamento vinculados a outras Accounts não podem ser usados com este PaymentIntent. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] ID do TaxCalculation… |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, string curta que indica como proceder diante do erro, se o emissor a fornecer. |
|
|
text |
[pt] Para erros de cartão, o ID da cobrança que falhou. |
|
|
text |
[pt] Para alguns erros que podem ser tratados programaticamente, string curta que indica o código de erro informado. |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, string curta que indica o motivo da recusa segundo o emissor, se ele a fornecer. |
|
|
text |
[pt] URL com mais informações sobre o código de erro informado. |
|
|
text |
[pt] Mensagem legível por humanos com mais detalhes sobre o erro. Em erros de cartão, essas mensagens podem ser exibidas aos seus usuários. |
|
|
text |
[pt] Para erros de cartão decorrentes de recusa do emissor, código de 2 dígitos que indica a orientação dada ao comerciante pela rede do cartão sobre como proceder diante do erro. |
|
|
text |
[pt] Para pagamentos recusados pela rede, código alfanumérico que indica o motivo da falha do pagamento. |
|
|
text |
[pt] Se o erro for específico de um parâmetro, o parâmetro relacionado ao erro. Por exemplo, você pode usá-lo para exibir uma mensagem perto do campo de formulário correto. |
|
|
text |
[pt] Uma PaymentIntent guia você pelo processo de cobrança de um pagamento do seu cliente. Recomendamos criar exatamente uma PaymentIntent para cada pedido ou sessão de cliente no seu sistema. |
|
|
text |
[pt] Objetos PaymentMethod representam os instrumentos de pagamento do seu cliente. Você pode usá-los com PaymentIntents para cobrar pagamentos ou salvá-los em objetos Customer para guardar os dados do instrumento para pagamentos futuros. Guias relacionados: Payment Methods e More Payment Scenarios. |
|
|
text |
[pt] Se o erro for específico do tipo de meio de pagamento, o tipo de meio de pagamento que teve problema. Este campo só é preenchido em erros relacionados a faturas. |
|
|
text |
[pt] URL da entrada do log da requisição no seu dashboard. |
|
|
text |
[pt] Uma SetupIntent guia você pelo processo de configurar e salvar as credenciais de pagamento de um cliente para pagamentos futuros. Por exemplo, você pode usar uma SetupIntent para configurar e salvar o cartão do cliente sem cobrar um pagamento imediatamente. |
|
|
text |
[pt] O objeto de origem (source) dos erros retornados em uma requisição envolvendo uma source. |
|
|
text |
[pt] O tipo de erro retornado. Um entre api_error, card_error, idempotency_error ou invalid_request_error… Valores possíveis: api_error = erro interno da API Stripe; card_error = erro do cartão (ex.: recusa); idempotency_error = erro de chave de idempotência; invalid_request_error = requisição inválida. |
|
|
text |
[pt] ID do objeto Charge mais recente criado por este PaymentIntent. Esta propriedade é nula até que a confirmação do PaymentIntent seja tentada. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
boolean |
[pt] Defina como true para habilitar o Managed Payments, a solução de merchant of record da Stripe, para esta sessão. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Você pode especificar o comerciante de liquidação (settlement merchant) como a conta conectada usando o atributo on_behalf_of na cobrança. Veja o caso de uso de PaymentIntents para contas conectadas para detalhes. |
|
|
text |
[pt] Um valor único para identificar o cliente. Este campo está disponível apenas para pagamentos com cartão. Este campo é truncado em 25 caracteres alfanuméricos, excluindo espaços, antes de ser enviado às bandeiras. |
|
|
text |
[pt] Um valor único atribuído pelo negócio para identificar a transação. Obrigatório para taxas L2 e L3. Para cartões, este campo é truncado em 25 caracteres alfanuméricos, excluindo espaços, antes de ser enviado às bandeiras. |
|
|
text |
[pt] ID do método de pagamento usado neste PaymentIntent. |
|
|
text |
[pt] ID da configuração de método de pagamento usada. |
|
|
text |
[pt] ID da configuração de método de pagamento pai usada. |
|
|
text |
[pt] ID do objeto Payment Record criado por este PaymentIntent. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que se pretende cobrar por este pagamento, denominado em presentment_currency. |
|
|
text |
[pt] Moeda apresentada ao cliente durante o pagamento. |
|
|
boolean |
[pt] Se a aprovação do cliente foi solicitada para este pagamento. Para pagamentos acima de INR 15000 ou do valor do mandato, o cliente deve fornecer aprovação explícita do pagamento junto ao seu banco. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Se for necessária a aprovação do cliente, ele precisa aprovar antes deste momento. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Tipo do método de pagamento cujo pagamento está em processamento, um entre card. Valores possíveis: card = cartão (online). |
|
|
text |
[pt] Endereço de e-mail para o qual será enviado o recibo do pagamento resultante. Se receipt_email for especificado para um pagamento em modo de produção (live mode), um recibo será enviado independentemente das suas configurações de e-mail. |
|
|
text |
[pt] ID da revisão associada a este PaymentIntent, se houver. |
|
|
text |
[pt] Indica que você pretende fazer pagamentos futuros com o método de pagamento deste PaymentIntent. Se você fornecer um Customer ao PaymentIntent, pode usar este parâmetro para vincular o método de pagamento ao Customer depois que o PaymentIntent for confirmado e o cliente concluir quaisquer ações necessárias. Valores possíveis: off_session = uso futuro sem o cliente presente; on_session = uso futuro com o cliente presente. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] A transportadora que enviou um produto físico, como Fedex, UPS, USPS etc. |
|
|
text |
[pt] Nome do destinatário. |
|
|
text |
[pt] Telefone do destinatário (incluindo ramal). |
|
|
text |
[pt] O código de rastreamento de um produto físico, obtido da transportadora. Se vários códigos de rastreamento foram gerados para esta compra, separe-os por vírgulas. |
|
|
text |
[pt] Texto que aparece no extrato do cliente como descritor de extrato em uma cobrança que não seja de cartão. Este valor substitui o descritor de extrato padrão da conta. Para informações sobre os requisitos, incluindo o limite de 22 caracteres, consulte a documentação de Statement Descriptor. |
|
|
text |
[pt] Fornece informações sobre uma cobrança de cartão. Concatenado ao prefixo do descritor de extrato da conta para formar o descritor de extrato completo que aparece no extrato do cliente. |
|
|
text |
[pt] Status deste PaymentIntent, um de requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled ou succeeded. Valores possíveis: canceled = cancelado; processing = em processamento; requires_action = requer ação do cliente (ex.: 3D Secure); requires_capture = autorizado, aguardando captura; requires_confirmation = aguardando confirmação; requires_payment_method = aguardando meio de pagamento; succeeded = concluído com sucesso. requires_payment_method depois de uma tentativa = pagamento recusado, aguardando outro cartão (o motivo está na tabela de Cobranças). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor transferido para a conta de destino. Esta transferência ocorrerá automaticamente após o sucesso do pagamento. Se nenhum valor for especificado, por padrão o valor total do pagamento é transferido para a conta de destino. |
|
|
text |
[pt] Uma string arbitrária anexada à transferência. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] A conta (se houver) à qual o pagamento é atribuído para fins de relatório fiscal e para onde os fundos do pagamento são transferidos após o sucesso do pagamento. |
|
|
text |
[pt] Uma string arbitrária anexada ao pagamento de destino. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] Uma string que identifica o pagamento resultante como parte de um grupo. |
stripe_payment_intents_allowed_payment_method_types
Intenções de pagamento (PaymentIntents): allowed_payment_method_types (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de tipos de método de pagamento permitidos para uso neste pagamento. A Stripe retorna automaticamente os métodos de pagamento compatíveis desta lista no campo payment_method_types da resposta, com base nos demais parâmetros do PaymentIntent, como moeda, valor e cliente. Valores possíveis: acss_debit = débito pré-autorizado ACSS (Canadá); affirm = Affirm (parcelamento, EUA); afterpay_clearpay = Afterpay/Clearpay (parcelamento); alipay = Alipay (carteira digital, China); alma = Alma (parcelamento, França); amazon_pay = Amazon Pay (carteira digital); au_becs_debit = débito em conta BECS (Austrália); bacs_debit = débito em conta Bacs (Reino Unido); bancontact = Bancontact (Bélgica); billie = Billie (pagamento B2B a prazo); bizum = Bizum (pagamento móvel, Espanha); blik = BLIK (pagamento móvel, Polônia); boku_promptpay = PromptPay via Boku (Tailândia); boleto = boleto bancário (Brasil); capchase_pay = Capchase Pay (financiamento B2B); card = cartão (online); card_present = cartão presencial (Terminal); cashapp = Cash App Pay (EUA); check_scan = cheque digitalizado; click_to_pay = Click to Pay (carteira das bandeiras); crypto = criptomoeda (stablecoin); customer_balance = saldo do cliente (transferência bancária); demo_pay = meio de demonstração (testes); duitnow = DuitNow (Malásia); dummy_auth_push = meio fictício de teste; dummy_passthrough_card = cartão fictício de teste; edenred = Edenred (vale-benefício); eps = EPS (transferência, Áustria); fpx = FPX (transferência, Malásia); gcash = GCash (carteira, Filipinas); getbalance = Balance (pagamento B2B); gift_card = vale-presente; giropay = giropay (transferência, Alemanha); gopay = GoPay (carteira, Indonésia); grabpay = GrabPay (carteira digital, Sudeste Asiático); id_bank_transfer = transferência bancária (Indonésia); ideal = iDEAL (transferência, Holanda); interac_present = cartão Interac presencial (Canadá); kakao_pay = Kakao Pay (carteira digital, Coreia); klarna = Klarna (meio de pagamento); knet = KNET (Kuwait); konbini = Konbini (pagamento em loja, Japão); kr_card = cartão coreano; kr_market = meios locais da Coreia do Sul; kriya = Kriya (B2B a prazo, Reino Unido); link = Link (checkout salvo da Stripe); mb_way = MB WAY (pagamento móvel, Portugal); mobilepay = MobilePay (carteira digital, Nórdicos); momo = MoMo (carteira, Vietnã); mondu = Mondu (B2B a prazo); multibanco = Multibanco (referência bancária, Portugal); naver_pay = Naver Pay (carteira digital, Coreia); netbanking = netbanking (Índia); ng_bank = banco (Nigéria); ng_bank_transfer = transferência bancária (Nigéria); ng_card = cartão (Nigéria); ng_market = meios locais da Nigéria; ng_ussd = USSD (Nigéria); ng_wallet = carteira digital (Nigéria); nz_bank_account = débito em conta (Nova Zelândia); octopus = Octopus (cartão, Hong Kong); oxxo = OXXO (pagamento em loja, México); p24 = Przelewy24 (transferência, Polônia); paper_check = cheque em papel; pay_by_bank = pagamento via banco (open banking); payco = PAYCO (carteira digital, Coreia); paynow = PayNow (QR code, Singapura); paypal = PayPal (carteira digital); paypay = PayPay (carteira digital, Japão); payto = PayTo (débito em conta, Austrália); pix = Pix (pagamento instantâneo, Brasil); promptpay = PromptPay (QR code, Tailândia); qris = QRIS (QR, Indonésia); rechnung = Rechnung (fatura, Alemanha); revolut_pay = Revolut Pay (carteira digital); samsung_pay = Samsung Pay (carteira digital); satispay = Satispay (pagamento móvel, Itália); scalapay = Scalapay (parcelamento, Europa); sepa_debit = débito em conta SEPA (Europa); sequra = SeQura (parcelamento, Espanha); shop_pay = Shop Pay (Shopify); shopeepay = ShopeePay (carteira); sofort = Sofort (transferência, Europa); south_korea_market = meios locais da Coreia do Sul; stripe_balance = saldo da conta Stripe; sunbit = Sunbit (parcelamento, EUA); swish = Swish (pagamento móvel, Suécia); tamara = Tamara (parcelado, Oriente Médio); test_pay = meio de teste; touch_n_go = Touch 'n Go (carteira, Malásia); truemoney = TrueMoney (carteira, Tailândia); twint = TWINT (pagamento móvel, Suíça); upi = UPI (pagamento instantâneo, Índia); us_bank_account = débito em conta ACH (EUA); us_cash_voucher = boleto de pagamento em dinheiro (EUA); vipps = Vipps (carteira, Noruega); wechat_pay = WeChat Pay (carteira digital, China); wero = Wero (carteira, Europa); zip = Zip (parcelamento). |
stripe_payment_intents_excluded_payment_method_types
Intenções de pagamento (PaymentIntents): excluded_payment_method_types (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de tipos de método de pagamento a excluir do uso neste pagamento. Valores possíveis: acss_debit = débito pré-autorizado ACSS (Canadá); affirm = Affirm (parcelamento, EUA); afterpay_clearpay = Afterpay/Clearpay (parcelamento); alipay = Alipay (carteira digital, China); alma = Alma (parcelamento, França); amazon_pay = Amazon Pay (carteira digital); au_becs_debit = débito em conta BECS (Austrália); bacs_debit = débito em conta Bacs (Reino Unido); bancontact = Bancontact (Bélgica); billie = Billie (pagamento B2B a prazo); bizum = Bizum (pagamento móvel, Espanha); blik = BLIK (pagamento móvel, Polônia); boleto = boleto bancário (Brasil); card = cartão (online); cashapp = Cash App Pay (EUA); crypto = criptomoeda (stablecoin); customer_balance = saldo do cliente (transferência bancária); eps = EPS (transferência, Áustria); fpx = FPX (transferência, Malásia); giropay = giropay (transferência, Alemanha); grabpay = GrabPay (carteira digital, Sudeste Asiático); ideal = iDEAL (transferência, Holanda); kakao_pay = Kakao Pay (carteira digital, Coreia); klarna = Klarna (meio de pagamento); konbini = Konbini (pagamento em loja, Japão); kr_card = cartão coreano; mb_way = MB WAY (pagamento móvel, Portugal); mobilepay = MobilePay (carteira digital, Nórdicos); multibanco = Multibanco (referência bancária, Portugal); naver_pay = Naver Pay (carteira digital, Coreia); nz_bank_account = débito em conta (Nova Zelândia); oxxo = OXXO (pagamento em loja, México); p24 = Przelewy24 (transferência, Polônia); pay_by_bank = pagamento via banco (open banking); payco = PAYCO (carteira digital, Coreia); paynow = PayNow (QR code, Singapura); paypal = PayPal (carteira digital); paypay = PayPay (carteira digital, Japão); payto = PayTo (débito em conta, Austrália); pix = Pix (pagamento instantâneo, Brasil); promptpay = PromptPay (QR code, Tailândia); revolut_pay = Revolut Pay (carteira digital); samsung_pay = Samsung Pay (carteira digital); satispay = Satispay (pagamento móvel, Itália); scalapay = Scalapay (parcelamento, Europa); sepa_debit = débito em conta SEPA (Europa); sequra = SeQura (parcelamento, Espanha); sofort = Sofort (transferência, Europa); sunbit = Sunbit (parcelamento, EUA); swish = Swish (pagamento móvel, Suécia); twint = TWINT (pagamento móvel, Suíça); upi = UPI (pagamento instantâneo, Índia); us_bank_account = débito em conta ACH (EUA); wechat_pay = WeChat Pay (carteira digital, China); zip = Zip (parcelamento). |
stripe_payment_intents_metadata
Intenções de pagamento (PaymentIntents): metadata (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que podem ser anexados a um objeto, útil para guardar informações adicionais sobre ele em formato estruturado (em JSON; a tabela-filha _metadata traz um par por linha). |
stripe_payment_intents_payment_method_options
Intenções de pagamento (PaymentIntents): payment_method_options (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Determina se o valor inclui o imposto IOF. Valores possíveis: always = valor sempre inclui IOF; never = valor não inclui IOF. |
|
|
text |
[pt] ID do app registrado no WeChat Pay. Obrigatório apenas quando o cliente é ios, android ou mini_program. |
|
|
text |
[pt] O código de país desejado para as informações da conta bancária. Valores permitidos: DE, FR, IE ou NL. Valores possíveis: BE = Bélgica; DE = Alemanha; ES = Espanha; FR = França; IE = Irlanda; NL = Países Baixos. |
|
|
text |
[pt] Tipo de transferência bancária que esta PaymentIntent pode usar para financiar. Valores permitidos: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer ou us_bank_transfer. Valores possíveis: eu_bank_transfer = transferência bancária (zona do euro); gb_bank_transfer = transferência bancária (Reino Unido); jp_bank_transfer = transferência bancária (Japão); mx_bank_transfer = transferência bancária (México); us_bank_transfer = transferência bancária (EUA). |
|
|
text |
[pt] Controla quando os fundos serão capturados da conta do cliente. Valores possíveis: automatic_delayed = captura automática com atraso; manual = captura manual posterior; manual_preferred = manual quando suportado, senão automática. |
|
|
text |
[pt] O tipo de cliente a partir do qual o consumidor final pagará… Valores possíveis: android = app Android; ios = app iOS; web = navegador web. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras. |
|
|
text |
[pt] Linha 1 do endereço (p. ex., rua, caixa postal ou nome da empresa). |
|
|
text |
[pt] Linha 2 do endereço (p. ex., apartamento, sala, unidade ou edifício). |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região. |
|
|
text |
[pt] Nome da empresa ou entidade. |
|
|
text |
[pt] O número oficial de registro para o tipo de registro informado. |
|
|
text |
[pt] Tipo de registro que a empresa ou entidade possui em seu país de registro. Valores possíveis: ch_ein = número de empresa (Suíça); de_hrb = registro comercial HRB (Alemanha); dk_cvr = número CVR (Dinamarca); es_cif = CIF fiscal (Espanha); fi_tunnus = Y-tunnus, ID empresarial (Finlândia); fr_siren = número SIREN (França); fr_siret = número SIRET (França); it_rea = registro REA (Itália); nl_kvk = número KvK (Holanda); no_org_number = número de organização (Noruega); no_pno = número pessoal (Noruega); se_org_number = número de organização (Suécia); se_pno = número pessoal (Suécia); uk_crn = número Companies House (Reino Unido). |
|
|
text |
[pt] Número do VAT id… |
|
|
text |
[pt] String opcional, somente numérica, de 10 a 11 dígitos, que determina o código de confirmação nas lojas de conveniência aplicáveis. |
|
|
int |
[pt] O número de dias corridos antes de um voucher de Boleto expirar. Por exemplo, se você criar um voucher de Boleto na segunda-feira e definir expires_after_days como 2, o voucher expirará na quarta-feira às 23:59, horário de America/Sao_Paulo. |
|
|
int |
[pt] O número de segundos (entre 10 e 1209600) após o qual o pagamento Pix expirará. |
|
|
text |
[pt] O timestamp em que as instruções de pagamento Konbini expirarão. Apenas um entre expires_after_days ou expires_at pode ser definido. |
|
|
text |
[pt] Somente para integrações webview. Ao concluir o login OAuth no navegador nativo, o usuário será redirecionado para esta URL para voltar ao seu app. |
|
|
text |
[pt] O tipo de método de financiamento a ser usado quando não há fundos suficientes no saldo do cliente. Valores permitidos: bank_transfer. Valores possíveis: bank_transfer = transferência bancária. |
|
|
boolean |
[pt] Se o parcelamento está habilitado para este meio de pagamento. Valores: true (sim) ou false (não). |
|
|
int |
[pt] Em planos de parcelamento fixed_count, é o número de parcelas que o cliente pagará no cartão de crédito. |
|
|
text |
[pt] Em planos de parcelamento fixed_count, é o intervalo entre as parcelas que o cliente pagará no cartão de crédito. Um de month. Valores possíveis: month = mensal. |
|
|
text |
[pt] Tipo de plano de parcelamento, um entre fixed_count, bonus ou revolving. Valores possíveis: bonus = parcelamento bônus; fixed_count = número fixo de parcelas; revolving = crédito rotativo. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que será cobrado. Obrigatório quando amount_type é fixed. |
|
|
text |
[pt] Determina se o valor inclui o imposto IOF. Valores possíveis: always = valor sempre inclui IOF; never = valor não inclui IOF. |
|
|
text |
[pt] Tipo de valor cobrado: exato (fixed) ou até o valor de amount (maximum). Padrão maximum. Valores possíveis: fixed = valor exato a cobrar; maximum = valor máximo a cobrar. |
|
|
text |
[pt] Método de coleta do mandato. Valores possíveis: paper = mandato em papel. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
text |
[pt] URL para o texto personalizado do mandato… |
|
|
text |
[pt] Descrição do mandato ou da assinatura exibida ao cliente. |
|
|
text |
[pt] Data, no formato AAAA-MM-DD, depois da qual os pagamentos não serão mais cobrados. Por padrão, sem data de término. |
|
|
timestamp |
[pt] Data em que o mandato expira. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Frequência de pagamento: day, week, month, year ou sporadic. Valores possíveis: day = diário; month = mensal; sporadic = esporádico; week = semanal; year = anual. |
|
|
int |
[pt] Número de intervalos entre pagamentos. Ex.: interval=month e interval_count=3 indicam um pagamento a cada três meses. Intervalo máximo de um ano (1 ano, 12 meses ou 52 semanas). Opcional quando interval=sporadic. |
|
|
text |
[pt] Descrição do intervalo. Obrigatório apenas se o parâmetro 'payment_schedule' for 'interval' ou 'combined'. |
|
|
text |
[pt] Cronograma de pagamento do mandato. Valores possíveis: combined = combinado: periódico e esporádico; interval = em intervalos fixos; sporadic = esporádico, sob demanda. |
|
|
int |
[pt] Número de pagamentos feitos em um período de pagamento. Padrão 1, exceto quando payment_schedule é adhoc; nesse caso, sem limite. |
|
|
text |
[pt] Finalidade dos pagamentos. Tem valor padrão conforme o código de categoria do comerciante (MCC). Valores possíveis: dependant_support = sustento de dependentes; government = pagamento governamental; loan = empréstimo; mortgage = financiamento imobiliário; other = outro propósito; pension = aposentadoria/pensão; personal = pagamento pessoal; retail = compra no varejo; salary = salário; tax = pagamento de impostos; utility = contas de consumo (água, luz etc.). |
|
|
text |
[pt] Identificador único do mandato ou da assinatura. |
|
|
text |
[pt] Prefixo usado para gerar a referência do mandato. No máximo 12 caracteres: letras maiúsculas, números, espaços ou os caracteres '/', '_', '-', '&', '.'. Não pode começar com 'DDIC' nem 'STRIPE'. |
|
|
text |
[pt] Data de início do mandato ou da assinatura. Não pode ser anterior a ontem. |
|
|
text |
[pt] Tipo de transação do mandato. Valores possíveis: business = transação empresarial; personal = transação pessoal. |
|
|
text |
[pt] Tipo do mandato. Valores possíveis: off_session = cliente ausente (off-session). |
|
|
text |
[pt] Rede selecionada para processar esta intenção de pagamento. Depende das redes disponíveis do cartão anexado à intenção de pagamento. Só pode ser definida no momento da confirmação. Valores possíveis: amex; cartes_bancaires; diners; discover; eftpos_au; girocard; interac; jcb; link; mastercard; unionpay; unknown; visa. |
|
|
text |
[pt] Idioma preferido da página de autorização do Bancontact para a qual o cliente é redirecionado. Valores possíveis: de = alemão; en = inglês; fr = francês; nl = holandês. |
|
|
text |
[pt] Idioma preferido da página de autorização da Affirm para a qual o cliente é redirecionado. |
|
|
text |
[pt] Descritor do produto com até 22 caracteres, que aparecerá para os clientes na loja de conveniência. |
|
|
text |
[pt] Identificador ou referência interna a que este pagamento corresponde. O identificador deve ter no máximo 128 caracteres e pode conter apenas letras, números, sublinhados, barras invertidas e hifens. Este campo difere do descritor da fatura e do nome do item. |
|
|
text |
[pt] Solicita a capacidade de capturar além da janela de validade padrão da autorização nesta PaymentIntent. Valores possíveis: if_available = pede autorização estendida se disponível; never = nunca pede autorização estendida. |
|
|
text |
[pt] Solicita a capacidade de incrementar a autorização nesta PaymentIntent. Valores possíveis: if_available = solicitar autorização incremental se disponível; never = não solicitar autorização incremental. |
|
|
boolean |
[pt] Solicita a capacidade de incrementar esta PaymentIntent se a combinação de MCC e bandeira do cartão for elegível. Verifique incremental_authorization_supported na resposta do Confirm para confirmar o suporte. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Solicita a capacidade de fazer múltiplas capturas nesta PaymentIntent. Valores possíveis: if_available = solicita multicaptura se disponível; never = nunca solicita multicaptura. |
|
|
text |
[pt] Solicita a capacidade de fazer over-capture nesta PaymentIntent. Valores possíveis: if_available = sobrecaptura se disponível; never = nunca permitir sobrecaptura. |
|
|
text |
[pt] Recomendamos fortemente que você use o nosso SCA Engine para solicitar automaticamente a autenticação dos seus clientes com base no nível de risco e em outros requisitos. No entanto, se quiser solicitar 3D Secure com base na lógica do seu próprio mecanismo antifraude, informe esta opção. Valores possíveis: any = solicita 3D Secure sempre que possível; automatic = Stripe decide quando exigir 3D Secure; challenge = força desafio 3D Secure. |
|
|
boolean |
[pt] Quando habilitado, usar um cartão associado a um cliente exigirá que o CVC seja informado novamente (ou seja, usando o parâmetro cvc_token). Valores: true (sim) ou false (não). |
|
|
text |
[pt] Prioridade de roteamento solicitada… Valores possíveis: domestic = roteamento pela rede doméstica; international = roteamento pela rede internacional. |
|
|
text |
[pt] Indica que você pretende fazer pagamentos futuros com o método de pagamento deste PaymentIntent. Se você fornecer um Customer ao PaymentIntent, pode usar este parâmetro para vincular o método de pagamento ao Customer depois que o PaymentIntent for confirmado e o cliente concluir quaisquer ações necessárias. Valores possíveis: none = não salvar para uso futuro; off_session = uso futuro sem o cliente presente; on_session = uso futuro com o cliente presente. |
|
|
text |
[pt] Fornece informações sobre um pagamento com cartão que os clientes veem em suas faturas. É concatenado ao prefixo Kana (descritor Kana abreviado) ou ao descritor de fatura Kana definido na conta para formar o descritor completo. Máximo de 22 caracteres. |
|
|
text |
[pt] Fornece informações sobre um pagamento com cartão que os clientes veem em suas faturas. É concatenado ao prefixo Kanji (descritor Kanji abreviado) ou ao descritor de fatura Kanji definido na conta para formar o descritor completo. Máximo de 17 caracteres. |
|
|
text |
[pt] Controla quando a Stripe tentará debitar os fundos da conta do cliente. A data deve ser uma string no formato YYYY-MM-DD, no futuro e entre 3 e 15 dias corridos a partir de hoje. |
|
|
text |
[pt] A finalidade da transação. Valores possíveis: goods = compra de bens; other = outra finalidade; services = compra de serviços; unspecified = finalidade não especificada. |
|
|
text |
[pt] Método de verificação da conta bancária. O valor padrão é automatic. Valores possíveis: automatic = automática (instantânea ou microdepósitos); instant = verificação instantânea; microdeposits = verificação por microdepósitos. |
stripe_payment_intents_pay_bank__requested_address_types
Intenções de pagamento (PaymentIntents): payment_method_options.bank_transfer.requested_address_types (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista de tipos de endereço que devem ser retornados na resposta financial_addresses. Se não especificada, todos os tipos válidos serão retornados. Valores permitidos: sort_code, zengin, iban ou spei. Valores possíveis: aba = ABA (EUA); iban = IBAN; sepa = SEPA (Europa); sort_code = sort code (Reino Unido); spei = SPEI (México); swift = SWIFT (internacional); zengin = Zengin (Japão). |
stripe_payment_intents_pay_fin_fil_account_subcategories
Intenções de pagamento (PaymentIntents): payment_method_options.financial_connections.filters.account_subcategories (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Subcategorias de conta usadas para filtrar as possíveis contas a vincular. As subcategorias válidas são checking e savings. Valores possíveis: checking = conta corrente; savings = conta poupança. |
stripe_payment_intents_pay_financial_connect_permissions
Intenções de pagamento (PaymentIntents): payment_method_options.financial_connections.permissions (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de permissões a solicitar. A permissão payment_method deve ser incluída. Valores possíveis: balances = saldos da conta; ownership = titularidade da conta; payment_method = uso como meio de pagamento; transactions = transações da conta. |
stripe_payment_intents_pay_financial_connection_prefetch
Intenções de pagamento (PaymentIntents): payment_method_options.financial_connections.prefetch (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Recursos de dados solicitados para serem recuperados na criação da conta. Valores possíveis: balances = saldos; ownership = titularidade; transactions = transações. |
stripe_payment_intents_paym_installments_available_plans
Intenções de pagamento (PaymentIntents): payment_method_options.installments.available_plans (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
int |
[pt] Em planos de parcelamento fixed_count, é o número de parcelas que o cliente pagará no cartão de crédito. |
|
|
text |
[pt] Em planos de parcelamento fixed_count, é o intervalo entre as parcelas que o cliente pagará no cartão de crédito. Um de month. Valores possíveis: month = mensal. |
|
|
text |
[pt] Tipo de plano de parcelamento, um entre fixed_count, bonus ou revolving. Valores possíveis: bonus = parcelamento bônus; fixed_count = número fixo de parcelas; revolving = crédito rotativo. |
stripe_payment_intents_pay_mandate_optio_supported_types
Intenções de pagamento (PaymentIntents): payment_method_options.mandate_options.supported_types (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_intents_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Tipo de mandato suportado. Valor possível: india. Valores possíveis: india = mandato da Índia. |
stripe_payment_intents_payment_method_types
Intenções de pagamento (PaymentIntents): payment_method_types (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de tipos de método de pagamento (ex.: card) que este PaymentIntent tem permissão de usar. Uma lista completa dos tipos de método de pagamento válidos pode ser encontrada aqui. |
stripe_payment_intents_transfer_data_metadata
Intenções de pagamento (PaymentIntents): transfer_data.metadata (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_payment_intents_transfer_da_payment_data_metadata
Intenções de pagamento (PaymentIntents): transfer_data.payment_data.metadata (uma linha por item; liga-se a stripe_payment_intents pela coluna payment_intent_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_intents). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Itens avulsos de fatura
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer → Clientes > id
- invoice → Faturas > id
- invoice_item_id > _invoice_items_discounts → Itens avulsos de fatura > id
- invoice_item_id > _invoice_items_frozen_fields → Itens avulsos de fatura > id
- invoice_item_id > _invoice_items_invoicing_rules → Itens avulsos de fatura > id
- invoice_item_id > _invoice_items_metadata → Itens avulsos de fatura > id
- invoice_item_id > _invoice_items_pro_credited_inv_invoice_line_items → Itens avulsos de fatura > id
- invoice_item_id > _invoice_items_proration_details_discount_amounts → Itens avulsos de fatura > id
- invoice_item_id > _invoice_items_tax_rates → Itens avulsos de fatura > id
- invoice_item_id > _invoice_items_tax_rates_metadata → Itens avulsos de fatura > id
Objeto principal
Itens avulsos de fatura (invoice items) lançados para clientes, pendentes ou já faturados.
stripe_invoice_items_discounts
Itens avulsos de fatura: discounts (uma linha por item; liga-se a stripe_invoice_items pela coluna invoice_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os descontos que se aplicam ao item de fatura. Os descontos do item são aplicados antes dos descontos da fatura. Use expand[]=discounts para expandir cada desconto. |
stripe_invoice_items_frozen_fields
Itens avulsos de fatura: frozen_fields (uma linha por item; liga-se a stripe_invoice_items pela coluna invoice_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Array de nomes de campos que não podem ser modificados. Tentar atualizar um campo congelado retorna um erro. Valores possíveis: discounts = descontos travados; pricing = preço travado; quantity = quantidade travada. |
stripe_invoice_items_invoicing_rules
Itens avulsos de fatura: invoicing_rules (uma linha por item; liga-se a stripe_invoice_items pela coluna invoice_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O tipo de regra de faturamento. Valores possíveis: defer_until_credited_items_resolved = adiar até itens creditados se resolverem. |
stripe_invoice_items_metadata
Itens avulsos de fatura: metadata (uma linha por item; liga-se a stripe_invoice_items pela coluna invoice_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_invoice_items_pro_credited_inv_invoice_line_items
Itens avulsos de fatura: proration_details.credited_items.invoice_line_item_details.invoice_line_items (uma linha por item; liga-se a stripe_invoice_items pela coluna invoice_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] IDs dos itens de linha de fatura debitados na fatura que correspondem ao rateio de crédito. |
stripe_invoice_items_proration_details_discount_amounts
Itens avulsos de fatura: proration_details.discount_amounts (uma linha por item; liga-se a stripe_invoice_items pela coluna invoice_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do desconto. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de desconto. |
stripe_invoice_items_tax_rates
Itens avulsos de fatura: tax_rates (uma linha por item; liga-se a stripe_invoice_items pela coluna invoice_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
stripe_invoice_items_tax_rates_metadata
Itens avulsos de fatura: tax_rates.metadata (uma linha por item; liga-se a stripe_invoice_items pela coluna invoice_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_invoice_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_invoice_items_tax_rates, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Links de pagamento
Tipo de replicação: Integral
Relacionamentos:
- payment_link_id > _payment_links_custom_fields → Links de pagamento > id
- payment_link_id > _payment_links_custom_fields_dropdown_options → Links de pagamento > id
- payment_link_id > _payment_links_invoic_invoice_data_account_tax_ids → Links de pagamento > id
- payment_link_id > _payment_links_invoice__invoice_data_custom_fields → Links de pagamento > id
- payment_link_id > _payment_links_invoice_creat_invoice_data_metadata → Links de pagamento > id
- payment_link_id > _payment_links_metadata → Links de pagamento > id
- payment_link_id > _payment_links_optional_items → Links de pagamento > id
- payment_link_id > _payment_links_payment_intent_data_metadata → Links de pagamento > id
- payment_link_id > _payment_links_payment_method_options → Links de pagamento > id
- payment_link_id > _payment_links_payment_restrictions_brands_blocked → Links de pagamento > id
- payment_link_id > _payment_links_payment_method_types → Links de pagamento > id
- payment_link_id > _payment_links_shipping_address__allowed_countries → Links de pagamento > id
- payment_link_id > _payment_links_shipping_options → Links de pagamento > id
- payment_link_id > _payment_links_subscription_data_metadata → Links de pagamento > id
Objeto principal
Links de pagamento criados no Stripe.
stripe_payment_links_custom_fields
Links de pagamento: custom_fields (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O valor que vem pré-preenchido na página de pagamento. |
|
|
text |
[pt] String de sua escolha que sua integração pode usar para reconciliar este campo. Deve ser única para este campo, alfanumérica e ter até 200 caracteres. |
|
|
text |
[pt] Texto personalizado do rótulo, exibido ao cliente. Até 100 caracteres. |
|
|
text |
[pt] O tipo do rótulo. Valores possíveis: custom = meio de pagamento personalizado. |
|
|
text |
[pt] O valor que pré-preenche o campo na página de pagamento. |
|
|
int |
[pt] A restrição de comprimento máximo de caracteres para a entrada do cliente. |
|
|
int |
[pt] A exigência de comprimento mínimo de caracteres para a entrada do cliente. |
|
|
boolean |
[pt] Se o cliente precisa preencher o campo antes de concluir a sessão de checkout. O padrão é false. Valores: true (sim) ou false (não). |
|
|
text |
[pt] O valor que pré-preenche o campo na página de pagamento. |
|
|
int |
[pt] A restrição de comprimento máximo de caracteres para a entrada do cliente. |
|
|
int |
[pt] A exigência de comprimento mínimo de caracteres para a entrada do cliente. |
|
|
text |
[pt] O tipo do campo. Valores possíveis: dropdown = lista suspensa; numeric = campo numérico; text = campo de texto. |
stripe_payment_links_custom_fields_dropdown_options
Links de pagamento: custom_fields.dropdown.options (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_links_custom_fields, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O rótulo da opção, exibido ao cliente. Até 100 caracteres. |
|
|
text |
[pt] O valor desta opção, não exibido ao cliente, usado pela sua integração para conciliar a opção selecionada pelo cliente. Deve ser único para esta opção, alfanumérico e ter até 100 caracteres. |
stripe_payment_links_invoic_invoice_data_account_tax_ids
Links de pagamento: invoice_creation.invoice_data.account_tax_ids (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os IDs fiscais da conta associados à fatura. |
stripe_payment_links_invoice__invoice_data_custom_fields
Links de pagamento: invoice_creation.invoice_data.custom_fields (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do campo personalizado. |
|
|
text |
[pt] O valor do campo personalizado. |
stripe_payment_links_invoice_creat_invoice_data_metadata
Links de pagamento: invoice_creation.invoice_data.metadata (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_payment_links_metadata
Links de pagamento: metadata (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_payment_links_optional_items
Links de pagamento: optional_items (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
boolean |
[pt] Defina como true se a quantidade puder ser ajustada para qualquer inteiro não negativo. Valores: true (sim) ou false (não). |
|
|
int |
[pt] A quantidade máxima deste item que o cliente pode comprar. Por padrão, este valor é 99. |
|
|
int |
[pt] A quantidade mínima deste item que o cliente deve comprar, caso escolha comprá-lo. Como este item é opcional, o cliente sempre poderá removê-lo do pedido, mesmo que o mínimo configurado aqui seja maior que 0. Por padrão, este valor é 0. |
|
|
text |
[pt] Identificador do preço do item opcional oferecido no Checkout. |
|
|
int |
[pt] Quantidade inicial do item opcional oferecido no Checkout. |
stripe_payment_links_payment_intent_data_metadata
Links de pagamento: payment_intent_data.metadata (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que definirá metadados nos Payment Intents gerados a partir deste link de pagamento. |
stripe_payment_links_payment_method_options
Links de pagamento: payment_method_options (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
stripe_payment_links_payment_restrictions_brands_blocked
Links de pagamento: payment_method_options.restrictions.brands_blocked (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_links_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Bandeiras de cartão a bloquear. Se um cliente informar ou selecionar um cartão de uma bandeira bloqueada, ele não conseguirá concluir o pagamento. Valores possíveis: american_express = American Express (bandeira); discover_global_network = Discover Global Network (bandeira); mastercard = Mastercard (bandeira); visa = Visa (bandeira). |
stripe_payment_links_payment_method_types
Links de pagamento: payment_method_types (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de tipos de método de pagamento que os clientes podem usar. Quando null, a Stripe exibirá dinamicamente os métodos de pagamento relevantes que você habilitou nas configurações de métodos de pagamento. Valores possíveis: affirm = Affirm (parcelamento, EUA); afterpay_clearpay = Afterpay/Clearpay (parcelamento); alipay = Alipay (carteira digital, China); alma = Alma (parcelamento, França); au_becs_debit = débito em conta BECS (Austrália); bacs_debit = débito em conta Bacs (Reino Unido); bancontact = Bancontact (Bélgica); billie = Billie (pagamento B2B a prazo); bizum = Bizum (pagamento móvel, Espanha); blik = BLIK (pagamento móvel, Polônia); boleto = boleto bancário (Brasil); card = cartão (online); cashapp = Cash App Pay (EUA); eps = EPS (transferência, Áustria); fpx = FPX (transferência, Malásia); giropay = giropay (transferência, Alemanha); grabpay = GrabPay (carteira digital, Sudeste Asiático); ideal = iDEAL (transferência, Holanda); klarna = Klarna (meio de pagamento); konbini = Konbini (pagamento em loja, Japão); link = Link (checkout salvo da Stripe); mb_way = MB WAY (pagamento móvel, Portugal); mobilepay = MobilePay (carteira digital, Nórdicos); multibanco = Multibanco (referência bancária, Portugal); oxxo = OXXO (pagamento em loja, México); p24 = Przelewy24 (transferência, Polônia); pay_by_bank = pagamento via banco (open banking); paynow = PayNow (QR code, Singapura); paypal = PayPal (carteira digital); paypay = PayPay (carteira digital, Japão); payto = PayTo (débito em conta, Austrália); pix = Pix (pagamento instantâneo, Brasil); promptpay = PromptPay (QR code, Tailândia); satispay = Satispay (pagamento móvel, Itália); sepa_debit = débito em conta SEPA (Europa); sequra = SeQura (parcelamento, Espanha); sofort = Sofort (transferência, Europa); sunbit = Sunbit (parcelamento, EUA); swish = Swish (pagamento móvel, Suécia); twint = TWINT (pagamento móvel, Suíça); upi = UPI (pagamento instantâneo, Índia); us_bank_account = débito em conta ACH (EUA); wechat_pay = WeChat Pay (carteira digital, China); zip = Zip (parcelamento). |
stripe_payment_links_shipping_address__allowed_countries
Links de pagamento: shipping_address_collection.allowed_countries (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Um array de códigos de país ISO de duas letras que representam os países que o Checkout deve oferecer como opções de local de entrega. Códigos de país não suportados: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI. Valores possíveis: código de país ISO 3166-1 alfa-2 (ex.: BR = Brasil, US = Estados Unidos, PT = Portugal), entre os 238 países e territórios aceitos pelo Stripe. |
stripe_payment_links_shipping_options
Links de pagamento: shipping_options (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. |
|
|
text |
[pt] ID da taxa de frete (Shipping Rate) a usar nesta opção de envio. |
stripe_payment_links_subscription_data_metadata
Links de pagamento: subscription_data.metadata (uma linha por item; liga-se a stripe_payment_links pela coluna payment_link_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que definirá metadados nas assinaturas geradas a partir deste link de pagamento. |
Links de pagamento - Detalhes - Itens
Tipo de replicação: Integral
Relacionamentos:
- payment_link_id → Links de pagamento > id
- payment_link_id > _payment_link_line_items_discounts → Links de pagamento > id
- payment_link_line_item_id > _payment_link_line_items_discounts → Links de pagamento - Detalhes - Itens > id
- payment_link_id > _payment_link_line_items_metadata → Links de pagamento > id
- payment_link_line_item_id > _payment_link_line_items_metadata → Links de pagamento - Detalhes - Itens > id
- payment_link_id > _payment_link_line_items_price_currency_options → Links de pagamento > id
- payment_link_line_item_id > _payment_link_line_items_price_currency_options → Links de pagamento - Detalhes - Itens > id
- payment_link_id > _payment_link_line_items_price_currency_opti_tiers → Links de pagamento > id
- payment_link_line_item_id > _payment_link_line_items_price_currency_opti_tiers → Links de pagamento - Detalhes - Itens > id
- payment_link_id > _payment_link_line_items_price_metadata → Links de pagamento > id
- payment_link_line_item_id > _payment_link_line_items_price_metadata → Links de pagamento - Detalhes - Itens > id
- payment_link_id > _payment_link_line_items_price_tiers → Links de pagamento > id
- payment_link_line_item_id > _payment_link_line_items_price_tiers → Links de pagamento - Detalhes - Itens > id
- payment_link_id > _payment_link_line_items_taxes → Links de pagamento > id
- payment_link_line_item_id > _payment_link_line_items_taxes → Links de pagamento - Detalhes - Itens > id
- payment_link_id > _payment_link_line_items_taxes_rate_metadata → Links de pagamento > id
- payment_link_line_item_id > _payment_link_line_items_taxes_rate_metadata → Links de pagamento - Detalhes - Itens > id
Objeto principal
Itens de cada link de pagamento.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o cliente pode ajustar a quantidade deste item no Checkout. Valores: true (sim) ou false (não). |
|
|
int |
[pt] Quantidade máxima que o cliente pode escolher para este item no Checkout. |
|
|
int |
[pt] Quantidade mínima que o cliente pode escolher para este item no Checkout. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de desconto aplicado. Se nenhum desconto foi aplicado, o padrão é 0. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total antes da aplicação de quaisquer descontos ou impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de imposto aplicado. Se nenhum imposto foi aplicado, o padrão é 0. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total após descontos e impostos. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. O padrão é o nome do produto. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o preço pode ser usado em novas compras. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Descreve como calcular o preço por período. per_unit ou tiered. Valores possíveis: per_unit = preço fixo por unidade; tiered = preço por faixas. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Uma chave de consulta usada para recuperar preços dinamicamente a partir de uma string estática. Pode ter até 200 caracteres. |
|
|
text |
[pt] Uma breve descrição do preço, oculta dos clientes. |
|
|
text |
[pt] O ID do produto ao qual este preço está associado. |
|
|
text |
[pt] A frequência com que uma assinatura é cobrada. Um entre day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O número de intervalos (especificados no atributo interval) entre as cobranças da assinatura. Por exemplo, interval=month e interval_count=3 cobra a cada 3 meses. |
|
|
text |
[pt] O medidor que rastreia o uso de um preço medido. |
|
|
text |
[pt] Configura como a quantidade por período deve ser determinada. Pode ser metered ou licensed. licensed cobra automaticamente a quantidade definida ao adicioná-la a uma assinatura. metered agrega o uso total com base nos registros de uso. O padrão é licensed. Valores possíveis: licensed = cobra a quantidade contratada; metered = cobra pelo uso medido. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
text |
[pt] Define se o preço escalonado deve ser graduated ou baseado em volume. No escalonamento baseado em volume, a quantidade máxima dentro de um período determina o preço por unidade. No escalonamento graduated, o preço pode mudar à medida que a quantidade cresce. Valores possíveis: graduated = graduado: cada faixa com seu preço; volume = por volume: faixa total define preço. |
|
|
int |
[pt] Divida o uso por este número. |
|
|
text |
[pt] Após a divisão, arredonde o resultado para cima ou para baixo. Valores possíveis: down = arredonda para baixo; up = arredonda para cima. |
|
|
text |
[pt] Um de one_time ou recurring, dependendo de o preço ser de uma compra única ou de uma compra recorrente (assinatura). Valores possíveis: one_time = preço avulso (compra única); recurring = preço recorrente (assinatura). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
|
|
int |
[pt] A quantidade de produtos sendo comprada. |
stripe_payment_link_line_items_discounts
Links de pagamento - Detalhes - Itens: discounts (uma linha por item; liga-se a stripe_payment_link_line_items pela coluna payment_link_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_link_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor descontado. |
|
|
text |
[pt] O ID do objeto de desconto. Descontos não podem ser consultados por ID. Use expand[]=discounts nas chamadas de API para expandir os IDs de desconto em um array. |
|
|
text |
[pt] A sessão de checkout à qual este cupom é aplicado, se for aplicado a uma sessão específica no modo payment. Não presente no modo subscription. |
|
|
text |
[pt] O ID do cliente associado a este desconto. |
|
|
text |
[pt] O ID da conta que representa o cliente associado a este desconto. |
|
|
timestamp |
[pt] Se o cupom tem duração repeating, a data em que este desconto terminará. Se o cupom tem duração once ou forever, este atributo será nulo. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A fatura à qual o cupom do desconto foi aplicado, se foi aplicado diretamente a uma fatura específica. |
|
|
text |
[pt] O ID do item de fatura (ou do item de linha de fatura, para itens de linha do tipo type='subscription') ao qual o cupom do desconto foi aplicado, se foi aplicado diretamente a um item de fatura ou item de linha de fatura específico. |
|
|
text |
[pt] O código promocional aplicado para criar este desconto. |
|
|
text |
[pt] O cupom que foi resgatado para criar este desconto. |
|
|
text |
[pt] O tipo de origem do desconto. Valores possíveis: coupon = cupom. |
|
|
timestamp |
[pt] Data em que o cupom foi aplicado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A assinatura à qual este cupom é aplicado, se for aplicado a uma assinatura específica. |
|
|
text |
[pt] O item de assinatura ao qual este cupom é aplicado, se for aplicado a um item de assinatura específico. |
stripe_payment_link_line_items_metadata
Links de pagamento - Detalhes - Itens: metadata (uma linha por item; liga-se a stripe_payment_link_line_items pela coluna payment_link_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_link_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_payment_link_line_items_price_currency_options
Links de pagamento - Detalhes - Itens: price.currency_options (uma linha por item; liga-se a stripe_payment_link_line_items pela coluna payment_link_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_link_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
stripe_payment_link_line_items_price_currency_opti_tiers
Links de pagamento - Detalhes - Itens: price.currency_options.tiers (uma linha por item; liga-se a stripe_payment_link_line_items pela coluna payment_link_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_link_line_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_link_line_items_price_currency_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_payment_link_line_items_price_metadata
Links de pagamento - Detalhes - Itens: price.metadata (uma linha por item; liga-se a stripe_payment_link_line_items pela coluna payment_link_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_link_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_payment_link_line_items_price_tiers
Links de pagamento - Detalhes - Itens: price.tiers (uma linha por item; liga-se a stripe_payment_link_line_items pela coluna payment_link_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_link_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_payment_link_line_items_taxes
Links de pagamento - Detalhes - Itens: taxes (uma linha por item; liga-se a stripe_payment_link_line_items pela coluna payment_link_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_link_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
stripe_payment_link_line_items_taxes_rate_metadata
Links de pagamento - Detalhes - Itens: taxes.rate.metadata (uma linha por item; liga-se a stripe_payment_link_line_items pela coluna payment_link_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payment_links). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payment_link_line_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_payment_link_line_items_taxes, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Listas do Radar
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Listas de valores do Radar (bloqueio/liberação de e-mails, cartões, IPs...) usadas nas regras antifraude.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] O nome da lista de valores para uso em regras. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O nome ou endereço de e-mail do usuário que criou esta lista de valores. |
|
|
text |
[pt] O tipo dos itens na lista de valores. Um entre card_fingerprint, card_bin, crypto_fingerprint, email, ip_address, country, string, case_sensitive_string, customer_id, account, sepa_debit_fingerprint ou us_bank_account_fingerprint. Valores possíveis: account = ID de conta; card_bin = BIN do cartão (primeiros dígitos); card_fingerprint = impressão digital do cartão; case_sensitive_string = texto sensível a maiúsculas; country = país; crypto_fingerprint = impressão digital de carteira cripto; customer_id = ID do cliente; email = e-mail; ip_address = endereço IP; sepa_debit_fingerprint = impressão digital de conta SEPA Debit; string = texto (sem diferenciar maiúsculas); us_bank_account_fingerprint = impressão digital de conta bancária dos EUA. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O nome da lista de valores. |
stripe_radar_value_lists_metadata
Listas do Radar: metadata (uma linha por item; liga-se a stripe_radar_value_lists pela coluna value_list_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_radar_value_lists). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Listas do Radar - Detalhes - Itens
Tipo de replicação: Integral
Relacionamentos:
Valores de cada lista do Radar.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_radar_value_lists). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O nome ou endereço de e-mail do usuário que adicionou este item à lista de valores. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O valor do item. |
|
|
text |
[pt] O identificador da lista de valores à qual este item pertence. |
Medidores de uso (billing meters)
Tipo de replicação: Integral
Medidores de uso para cobrança baseada em consumo (ativos e inativos).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A chave no payload do evento do medidor a ser usada para mapear o evento a um cliente. |
|
|
text |
[pt] O método para mapear um evento do medidor a um cliente. Valores possíveis: by_id = mapeado pelo ID do cliente. |
|
|
text |
[pt] Especifica como os eventos são agregados. Valores possíveis: count = contagem de eventos; last = último valor reportado; sum = soma dos valores. |
|
|
text |
[pt] O nome do medidor. |
|
|
text |
[pt] O nome do evento do medidor para o qual registrar o uso. Corresponde ao campo event_name dos eventos do medidor. |
|
|
text |
[pt] A janela de tempo para a qual os eventos do medidor foram pré-agregados, se houver. Valores possíveis: day = pré-agregado por dia; hour = pré-agregado por hora. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O status do medidor. Valores possíveis: active = ativo, em vigor; inactive = inativo. |
|
|
timestamp |
[pt] O momento em que o medidor foi desativado, se houver. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] Momento em que o objeto foi atualizado pela última vez. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A chave no payload do evento do medidor a ser usada como valor deste medidor. |
Notas de crédito
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer → Clientes > id
- invoice → Faturas > id
- credit_note_id > _credit_notes_discount_amounts → Notas de crédito > id
- credit_note_id > _credit_notes_metadata → Notas de crédito > id
- credit_note_id > _credit_notes_pretax_credit_amounts → Notas de crédito > id
- credit_note_id > _credit_notes_refunds → Notas de crédito > id
- credit_note_id > _credit_notes_shipping_cost_taxes → Notas de crédito > id
- credit_note_id > _credit_notes_total_taxes → Notas de crédito > id
Objeto principal
Notas de crédito emitidas sobre faturas, com valores, motivo e status.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o valor total da nota de crédito, incluindo impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os valores de envio. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] ID do cliente. |
|
|
text |
[pt] ID da conta que representa o cliente. |
|
|
text |
[pt] Transação de saldo do cliente relacionada a esta nota de crédito. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o valor total de desconto que foi creditado. |
|
|
timestamp |
[pt] A data em que esta nota de crédito entra em vigor. Igual a created, a menos que seja sobrescrita. Quando definido, este valor substitui a 'Data de emissão' gerada pelo sistema impressa no PDF da nota de crédito. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] ID da fatura. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Texto voltado ao cliente que aparece no PDF da nota de crédito. |
|
|
text |
[pt] Um número único que identifica esta nota de crédito específica e aparece no PDF da nota de crédito e da fatura associada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que foi creditado fora da Stripe. |
|
|
text |
[pt] O link para baixar o PDF da nota de crédito. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor da nota de crédito que foi reembolsado ao cliente, creditado no saldo do cliente, creditado fora da Stripe, ou qualquer combinação desses. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor da nota de crédito pelo qual amount_remaining e amount_due da fatura foram reduzidos. |
|
|
text |
[pt] Motivo da emissão desta nota de crédito, um de duplicate, fraudulent, order_change ou product_unsatisfactory… Valores possíveis: duplicate = cobrança duplicada; fraudulent = fraude; order_change = alteração no pedido; product_unsatisfactory = produto insatisfatório. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Custo total de envio antes da aplicação de quaisquer impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de imposto aplicado sobre os custos de envio. Se nenhum imposto foi aplicado, o padrão é 0. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Custo total de envio após a aplicação de impostos. |
|
|
text |
[pt] O ID da ShippingRate desta fatura. |
|
|
text |
[pt] Status desta nota de crédito, um de issued ou void. Valores possíveis: issued = emitida; void = anulada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o valor da nota de crédito, excluindo impostos exclusivos e descontos em nível de fatura. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o valor da nota de crédito, excluindo todos os impostos e descontos em nível de fatura. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o valor total da nota de crédito, incluindo impostos e todos os descontos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o valor total da nota de crédito, excluindo impostos, mas incluindo descontos. |
|
|
text |
[pt] Tipo desta nota de crédito, um entre pre_payment ou post_payment. Uma nota de crédito pre_payment significa que foi emitida quando a fatura estava aberta. Uma nota de crédito post_payment significa que foi emitida quando a fatura estava paga. Valores possíveis: mixed = antes e depois do pagamento; post_payment = emitida após o pagamento da fatura; pre_payment = emitida antes do pagamento da fatura. |
|
|
timestamp |
[pt] O momento em que a nota de crédito foi anulada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
stripe_credit_notes_discount_amounts
Notas de crédito: discount_amounts (uma linha por item; liga-se a stripe_credit_notes pela coluna credit_note_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_notes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do desconto. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de desconto. |
stripe_credit_notes_metadata
Notas de crédito: metadata (uma linha por item; liga-se a stripe_credit_notes pela coluna credit_note_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_notes). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_credit_notes_pretax_credit_amounts
Notas de crédito: pretax_credit_amounts (uma linha por item; liga-se a stripe_credit_notes pela coluna credit_note_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_notes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do crédito antes de impostos. |
|
|
text |
[pt] A transação de saldo de crédito que foi aplicada para obter este valor de crédito antes de impostos. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de crédito antes de impostos. |
|
|
text |
[pt] Tipo do valor de crédito antes de impostos referenciado. Valores possíveis: credit_balance_transaction = transação de crédito de cobrança; discount = desconto. |
stripe_credit_notes_refunds
Notas de crédito: refunds (uma linha por item; liga-se a stripe_credit_notes pela coluna credit_note_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_notes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do reembolso que se aplica a esta nota de crédito. |
|
|
text |
[pt] ID do registro de pagamento. |
|
|
text |
[pt] ID do grupo de reembolsos. |
|
|
text |
[pt] ID do reembolso. |
|
|
text |
[pt] Tipo do reembolso, um entre refund ou payment_record_refund. Valores possíveis: payment_record_refund = reembolso de registro de pagamento; refund = reembolso. |
stripe_credit_notes_shipping_cost_taxes
Notas de crédito: shipping_cost.taxes (uma linha por item; liga-se a stripe_credit_notes pela coluna credit_note_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_notes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Alíquotas de imposto podem ser aplicadas a faturas, assinaturas e sessões de checkout para cobrar imposto. Guia relacionado: Tax rates… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
stripe_credit_notes_total_taxes
Notas de crédito: total_taxes (uma linha por item; liga-se a stripe_credit_notes pela coluna credit_note_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_notes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto. |
|
|
text |
[pt] Se este imposto é inclusivo ou exclusivo. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço. |
|
|
text |
[pt] ID da alíquota de imposto… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_available = motivo não disponível; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
|
|
text |
[pt] O tipo de informação fiscal. Valores possíveis: tax_rate_details = detalhes da alíquota de imposto. |
Notas de crédito - Detalhes - Itens
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- credit_note_id → Notas de crédito > id
- credit_note_id > _credit_note_lines_discount_amounts → Notas de crédito > id
- credit_note_line_id > _credit_note_lines_discount_amounts → Notas de crédito - Detalhes - Itens > id
- credit_note_id > _credit_note_lines_metadata → Notas de crédito > id
- credit_note_line_id > _credit_note_lines_metadata → Notas de crédito - Detalhes - Itens > id
- credit_note_id > _credit_note_lines_pretax_credit_amounts → Notas de crédito > id
- credit_note_line_id > _credit_note_lines_pretax_credit_amounts → Notas de crédito - Detalhes - Itens > id
- credit_note_id > _credit_note_lines_tax_rates → Notas de crédito > id
- credit_note_line_id > _credit_note_lines_tax_rates → Notas de crédito - Detalhes - Itens > id
- credit_note_id > _credit_note_lines_tax_rates_metadata → Notas de crédito > id
- credit_note_line_id > _credit_note_lines_tax_rates_metadata → Notas de crédito - Detalhes - Itens > id
- credit_note_id > _credit_note_lines_taxes → Notas de crédito > id
- credit_note_line_id > _credit_note_lines_taxes → Notas de crédito - Detalhes - Itens > id
Objeto principal
Itens de cada nota de crédito.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_credit_notes). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o valor bruto sendo creditado para este item de linha, excluindo impostos (exclusivos) e descontos. |
|
|
text |
[pt] Descrição do item que está sendo creditado. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que representa o desconto sendo creditado para este item de linha. |
|
|
text |
[pt] ID do item de linha da fatura que está sendo creditado… |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
int |
[pt] O número de unidades do produto que estão sendo creditadas. |
|
|
text |
[pt] O tipo do item de linha da nota de crédito, um entre invoice_line_item ou custom_line_item. Quando o tipo é invoice_line_item, há uma propriedade adicional invoice_line_item no recurso, cujo valor é o ID do item de linha creditado na fatura. Valores possíveis: custom_line_item = item avulso da nota de crédito; invoice_line_item = referente a item da fatura. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O custo de cada unidade do produto que está sendo creditada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
stripe_credit_note_lines_discount_amounts
Notas de crédito - Detalhes - Itens: discount_amounts (uma linha por item; liga-se a stripe_credit_note_lines pela coluna credit_note_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_credit_notes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_note_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do desconto. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de desconto. |
stripe_credit_note_lines_metadata
Notas de crédito - Detalhes - Itens: metadata (uma linha por item; liga-se a stripe_credit_note_lines pela coluna credit_note_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_credit_notes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_note_lines). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_credit_note_lines_pretax_credit_amounts
Notas de crédito - Detalhes - Itens: pretax_credit_amounts (uma linha por item; liga-se a stripe_credit_note_lines pela coluna credit_note_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_credit_notes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_note_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do crédito antes de impostos. |
|
|
text |
[pt] A transação de saldo de crédito que foi aplicada para obter este valor de crédito antes de impostos. |
|
|
text |
[pt] O desconto que foi aplicado para obter este valor de crédito antes de impostos. |
|
|
text |
[pt] Tipo do valor de crédito antes de impostos referenciado. Valores possíveis: credit_balance_transaction = transação de crédito de cobrança; discount = desconto. |
stripe_credit_note_lines_tax_rates
Notas de crédito - Detalhes - Itens: tax_rates (uma linha por item; liga-se a stripe_credit_note_lines pela coluna credit_note_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_credit_notes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_note_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
stripe_credit_note_lines_tax_rates_metadata
Notas de crédito - Detalhes - Itens: tax_rates.metadata (uma linha por item; liga-se a stripe_credit_note_lines pela coluna credit_note_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_credit_notes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_note_lines). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_credit_note_lines_tax_rates, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_credit_note_lines_taxes
Notas de crédito - Detalhes - Itens: taxes (uma linha por item; liga-se a stripe_credit_note_lines pela coluna credit_note_line_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_credit_notes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_credit_note_lines). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto. |
|
|
text |
[pt] Se este imposto é inclusivo ou exclusivo. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço. |
|
|
text |
[pt] ID da alíquota de imposto… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_available = motivo não disponível; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
|
|
text |
[pt] O tipo de informação fiscal. Valores possíveis: tax_rate_details = detalhes da alíquota de imposto. |
Orçamentos
Tipo de replicação: Integral
Relacionamentos:
- customer → Clientes > id
- invoice → Faturas > id
- subscription → Assinaturas > id
- quote_id > _quotes_computed_recurring_tot_breakdown_discounts → Orçamentos > id
- quote_id > _quotes_computed_recurring_total_d_breakdown_taxes → Orçamentos > id
- quote_id > _quotes_computed_upfront_total_breakdown_discounts → Orçamentos > id
- quote_id > _quotes_computed_upfront_total_det_breakdown_taxes → Orçamentos > id
- quote_id > _quotes_default_tax_rates → Orçamentos > id
- quote_id > _quotes_discounts → Orçamentos > id
- quote_id > _quotes_invoice_settings_custom_fields → Orçamentos > id
- quote_id > _quotes_metadata → Orçamentos > id
- quote_id > _quotes_subscription_data_metadata → Orçamentos > id
- quote_id > _quotes_total_details_breakdown_discounts → Orçamentos > id
- quote_id > _quotes_total_details_breakdown_taxes → Orçamentos > id
Objeto principal
Orçamentos (quotes) enviados a clientes, com valores, validade e status.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total antes da aplicação de quaisquer descontos ou impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total após a aplicação de descontos e impostos. |
|
|
text |
[pt] ID do aplicativo Connect que criou o orçamento. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor da taxa de aplicação (se houver) que será solicitada para ser aplicada ao pagamento e transferida para a conta Stripe do proprietário do aplicativo. Aplicável apenas se não houver itens de linha com preços recorrentes na cotação. |
|
|
float |
[pt] Um decimal não negativo entre 0 e 100, com no máximo duas casas decimais. Representa a porcentagem do total da fatura da assinatura que será transferida para a conta Stripe do proprietário do aplicativo. Aplicável somente se houver itens de linha com preços recorrentes no orçamento. |
|
|
boolean |
[pt] Calcular impostos automaticamente… Valores: true (sim) ou false (não). |
|
|
text |
[pt] A conta conectada referenciada quando type é account. |
|
|
text |
[pt] Tipo da conta referenciada. Valores possíveis: account = a própria conta; self = o próprio dono. |
|
|
text |
[pt] O provedor de imposto que alimenta o imposto automático. |
|
|
text |
[pt] O status do cálculo automático de imposto mais recente desta cotação. Valores possíveis: complete = concluída; failed = falhou; requires_location_inputs = requer endereço válido do cliente. |
|
|
text |
[pt] charge_automatically ou send_invoice. Ao cobrar automaticamente, a Stripe tentará pagar as faturas no fim do ciclo da assinatura ou na finalização, usando o método de pagamento padrão vinculado à assinatura ou ao cliente. Valores possíveis: charge_automatically = cobrança automática no meio de pagamento; send_invoice = fatura enviada ao cliente para pagar. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total antes da aplicação de quaisquer descontos ou impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total após a aplicação de descontos e impostos. |
|
|
text |
[pt] A frequência com que uma assinatura é cobrada. Um entre day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O número de intervalos (especificados no atributo interval) entre as cobranças da assinatura. Por exemplo, interval=month e interval_count=3 cobra a cada 3 meses. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os descontos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os valores de envio. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os valores de imposto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total antes da aplicação de quaisquer descontos ou impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total após a aplicação de descontos e impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os descontos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os valores de envio. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os valores de imposto. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] O cliente que recebeu esta cotação. Um cliente é necessário para finalizar a cotação. Depois de especificado, não pode ser alterado. |
|
|
text |
[pt] A conta que representa o cliente que recebeu esta cotação. Um cliente ou conta é necessário para finalizar a cotação. Depois de especificado, não pode ser alterado. |
|
|
text |
[pt] Uma descrição que será exibida no PDF do orçamento. |
|
|
timestamp |
[pt] A data em que a cotação será cancelada se estiver com status open ou draft. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Um rodapé que será exibido no PDF do orçamento. |
|
|
boolean |
[pt] Se esta cotação é uma revisão de outra cotação. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A cotação que foi clonada. |
|
|
text |
[pt] Um cabeçalho que será exibido no PDF do orçamento. |
|
|
text |
[pt] A fatura que foi criada a partir desta cotação. |
|
|
int |
[pt] Número de dias dentro dos quais um cliente deve pagar as faturas geradas por este orçamento. Este valor será nulo em orçamentos em que collection_method=charge_automatically. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] Rodapé a ser exibido na fatura. |
|
|
text |
[pt] A conta conectada referenciada quando type é account. |
|
|
text |
[pt] Tipo da conta referenciada. Valores possíveis: account = a própria conta; self = o próprio dono. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Um número único que identifica este orçamento específico. Este número é atribuído quando o orçamento é finalizado. |
|
|
text |
[pt] A conta em nome da qual cobrar. |
|
|
text |
[pt] O status da cotação. Valores possíveis: accepted = aceito pelo cliente; canceled = cancelado; draft = rascunho, ainda não finalizado; open = aberto, aguardando conclusão. |
|
|
timestamp |
[pt] O momento em que a cotação foi aceita. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O momento em que a cotação foi cancelada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O momento em que a cotação foi finalizada. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A assinatura que foi criada ou atualizada a partir desta cotação. |
|
|
text |
[pt] Controla como faturas e itens de fatura exibem valores de rateio (proration) e de desconto. Valores possíveis: included = descontos incluídos no valor proporcional; itemized = descontos discriminados separadamente. |
|
|
text |
[pt] Controla como os rateios (prorations) e as faturas de assinaturas são calculados e orquestrados. Valores possíveis: classic = modo clássico de cobrança; flexible = modo flexível de cobrança. |
|
|
text |
[pt] A descrição da assinatura, destinada a ser exibida ao cliente. Use este campo para armazenar, opcionalmente, uma explicação da assinatura para renderização em superfícies da Stripe e em certas interfaces de métodos de pagamento locais. |
|
|
timestamp |
[pt] Ao criar uma nova assinatura, a data em que o agendamento de assinatura começará após a cotação ser aceita. Esta data é ignorada se estiver no passado quando a cotação for aceita. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
int |
[pt] Inteiro que representa o número de dias do período de teste antes de o cliente ser cobrado pela primeira vez. |
|
|
text |
[pt] O agendamento de assinatura que foi criado ou atualizado a partir desta cotação. |
|
|
text |
[pt] ID do relógio de teste (test clock) ao qual este orçamento pertence. Só é preenchido em modo de teste (chave sk_test_/rk_test_), quando o registro foi criado preso a um relógio de teste para simular a passagem do tempo; em conta real fica sempre vazio. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os descontos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os valores de envio. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Esta é a soma de todos os valores de imposto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor que será transferido para a conta de destino quando a fatura for paga. Por padrão, o valor total é transferido para o destino. |
|
|
float |
[pt] Um decimal não negativo entre 0 e 100, com no máximo duas casas decimais. Representa a porcentagem do total da fatura da assinatura que será transferida para a conta de destino. Por padrão, o valor total será transferido para o destino. |
|
|
text |
[pt] A conta para onde os fundos do pagamento serão transferidos após o sucesso do pagamento. |
stripe_quotes_computed_recurring_tot_breakdown_discounts
Orçamentos: computed.recurring.total_details.breakdown.discounts (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor descontado. |
|
|
text |
[pt] Um desconto representa a aplicação efetiva de um cupom ou código promocional. Contém informações sobre quando o desconto começou, quando termina e a que se aplica. Guia relacionado: Aplicação de descontos em assinaturas… |
stripe_quotes_computed_recurring_total_d_breakdown_taxes
Orçamentos: computed.recurring.total_details.breakdown.taxes (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Alíquotas de imposto podem ser aplicadas a faturas, assinaturas e sessões de checkout para cobrar imposto. Guia relacionado: Tax rates… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
stripe_quotes_computed_upfront_total_breakdown_discounts
Orçamentos: computed.upfront.total_details.breakdown.discounts (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor descontado. |
|
|
text |
[pt] Um desconto representa a aplicação efetiva de um cupom ou código promocional. Contém informações sobre quando o desconto começou, quando termina e a que se aplica. Guia relacionado: Aplicação de descontos em assinaturas… |
stripe_quotes_computed_upfront_total_det_breakdown_taxes
Orçamentos: computed.upfront.total_details.breakdown.taxes (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Alíquotas de imposto podem ser aplicadas a faturas, assinaturas e sessões de checkout para cobrar imposto. Guia relacionado: Tax rates… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
stripe_quotes_default_tax_rates
Orçamentos: default_tax_rates (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] As alíquotas de imposto aplicadas a esta cotação. |
stripe_quotes_discounts
Orçamentos: discounts (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os descontos aplicados a esta cotação. |
stripe_quotes_invoice_settings_custom_fields
Orçamentos: invoice_settings.custom_fields (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do campo personalizado. |
|
|
text |
[pt] O valor do campo personalizado. |
stripe_quotes_metadata
Orçamentos: metadata (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_quotes_subscription_data_metadata
Orçamentos: subscription_data.metadata (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que definirá metadados na assinatura ou no cronograma de assinatura quando o orçamento for aceito. Se um preço recorrente estiver incluído em line_items, este campo será repassado ao campo metadata da assinatura resultante. |
stripe_quotes_total_details_breakdown_discounts
Orçamentos: total_details.breakdown.discounts (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor descontado. |
|
|
text |
[pt] Um desconto representa a aplicação efetiva de um cupom ou código promocional. Contém informações sobre quando o desconto começou, quando termina e a que se aplica. Guia relacionado: Aplicação de descontos em assinaturas… |
stripe_quotes_total_details_breakdown_taxes
Orçamentos: total_details.breakdown.taxes (uma linha por item; liga-se a stripe_quotes pela coluna quote_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quotes). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Alíquotas de imposto podem ser aplicadas a faturas, assinaturas e sessões de checkout para cobrar imposto. Guia relacionado: Tax rates… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
Orçamentos - Detalhes - Itens
Tipo de replicação: Integral
Relacionamentos:
- quote_id → Orçamentos > id
- quote_id > _quote_line_items_discounts → Orçamentos > id
- quote_line_item_id > _quote_line_items_discounts → Orçamentos - Detalhes - Itens > id
- quote_id > _quote_line_items_metadata → Orçamentos > id
- quote_line_item_id > _quote_line_items_metadata → Orçamentos - Detalhes - Itens > id
- quote_id > _quote_line_items_price_currency_options → Orçamentos > id
- quote_line_item_id > _quote_line_items_price_currency_options → Orçamentos - Detalhes - Itens > id
- quote_id > _quote_line_items_price_currency_options_tiers → Orçamentos > id
- quote_line_item_id > _quote_line_items_price_currency_options_tiers → Orçamentos - Detalhes - Itens > id
- quote_id > _quote_line_items_price_metadata → Orçamentos > id
- quote_line_item_id > _quote_line_items_price_metadata → Orçamentos - Detalhes - Itens > id
- quote_id > _quote_line_items_price_tiers → Orçamentos > id
- quote_line_item_id > _quote_line_items_price_tiers → Orçamentos - Detalhes - Itens > id
- quote_id > _quote_line_items_taxes → Orçamentos > id
- quote_line_item_id > _quote_line_items_taxes → Orçamentos - Detalhes - Itens > id
- quote_id > _quote_line_items_taxes_rate_metadata → Orçamentos > id
- quote_line_item_id > _quote_line_items_taxes_rate_metadata → Orçamentos - Detalhes - Itens > id
Objeto principal
Itens de cada orçamento.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o cliente pode ajustar a quantidade deste item no Checkout. Valores: true (sim) ou false (não). |
|
|
int |
[pt] Quantidade máxima que o cliente pode escolher para este item no Checkout. |
|
|
int |
[pt] Quantidade mínima que o cliente pode escolher para este item no Checkout. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de desconto aplicado. Se nenhum desconto foi aplicado, o padrão é 0. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total antes da aplicação de quaisquer descontos ou impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de imposto aplicado. Se nenhum imposto foi aplicado, o padrão é 0. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total após descontos e impostos. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. O padrão é o nome do produto. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o preço pode ser usado em novas compras. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Descreve como calcular o preço por período. per_unit ou tiered. Valores possíveis: per_unit = preço fixo por unidade; tiered = preço por faixas. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Uma chave de consulta usada para recuperar preços dinamicamente a partir de uma string estática. Pode ter até 200 caracteres. |
|
|
text |
[pt] Uma breve descrição do preço, oculta dos clientes. |
|
|
text |
[pt] O ID do produto ao qual este preço está associado. |
|
|
text |
[pt] A frequência com que uma assinatura é cobrada. Um entre day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O número de intervalos (especificados no atributo interval) entre as cobranças da assinatura. Por exemplo, interval=month e interval_count=3 cobra a cada 3 meses. |
|
|
text |
[pt] O medidor que rastreia o uso de um preço medido. |
|
|
text |
[pt] Configura como a quantidade por período deve ser determinada. Pode ser metered ou licensed. licensed cobra automaticamente a quantidade definida ao adicioná-la a uma assinatura. metered agrega o uso total com base nos registros de uso. O padrão é licensed. Valores possíveis: licensed = cobra a quantidade contratada; metered = cobra pelo uso medido. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
text |
[pt] Define se o preço escalonado deve ser graduated ou baseado em volume. No escalonamento baseado em volume, a quantidade máxima dentro de um período determina o preço por unidade. No escalonamento graduated, o preço pode mudar à medida que a quantidade cresce. Valores possíveis: graduated = graduado: cada faixa com seu preço; volume = por volume: faixa total define preço. |
|
|
int |
[pt] Divida o uso por este número. |
|
|
text |
[pt] Após a divisão, arredonde o resultado para cima ou para baixo. Valores possíveis: down = arredonda para baixo; up = arredonda para cima. |
|
|
text |
[pt] Um de one_time ou recurring, dependendo de o preço ser de uma compra única ou de uma compra recorrente (assinatura). Valores possíveis: one_time = preço avulso (compra única); recurring = preço recorrente (assinatura). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
|
|
int |
[pt] A quantidade de produtos sendo comprada. |
stripe_quote_line_items_discounts
Orçamentos - Detalhes - Itens: discounts (uma linha por item; liga-se a stripe_quote_line_items pela coluna quote_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quote_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor descontado. |
|
|
text |
[pt] O ID do objeto de desconto. Descontos não podem ser consultados por ID. Use expand[]=discounts nas chamadas de API para expandir os IDs de desconto em um array. |
|
|
text |
[pt] A sessão de checkout à qual este cupom é aplicado, se for aplicado a uma sessão específica no modo payment. Não presente no modo subscription. |
|
|
text |
[pt] O ID do cliente associado a este desconto. |
|
|
text |
[pt] O ID da conta que representa o cliente associado a este desconto. |
|
|
timestamp |
[pt] Se o cupom tem duração repeating, a data em que este desconto terminará. Se o cupom tem duração once ou forever, este atributo será nulo. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A fatura à qual o cupom do desconto foi aplicado, se foi aplicado diretamente a uma fatura específica. |
|
|
text |
[pt] O ID do item de fatura (ou do item de linha de fatura, para itens de linha do tipo type='subscription') ao qual o cupom do desconto foi aplicado, se foi aplicado diretamente a um item de fatura ou item de linha de fatura específico. |
|
|
text |
[pt] O código promocional aplicado para criar este desconto. |
|
|
text |
[pt] O cupom que foi resgatado para criar este desconto. |
|
|
text |
[pt] O tipo de origem do desconto. Valores possíveis: coupon = cupom. |
|
|
timestamp |
[pt] Data em que o cupom foi aplicado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A assinatura à qual este cupom é aplicado, se for aplicado a uma assinatura específica. |
|
|
text |
[pt] O item de assinatura ao qual este cupom é aplicado, se for aplicado a um item de assinatura específico. |
stripe_quote_line_items_metadata
Orçamentos - Detalhes - Itens: metadata (uma linha por item; liga-se a stripe_quote_line_items pela coluna quote_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quote_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_quote_line_items_price_currency_options
Orçamentos - Detalhes - Itens: price.currency_options (uma linha por item; liga-se a stripe_quote_line_items pela coluna quote_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quote_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
stripe_quote_line_items_price_currency_options_tiers
Orçamentos - Detalhes - Itens: price.currency_options.tiers (uma linha por item; liga-se a stripe_quote_line_items pela coluna quote_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quote_line_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_quote_line_items_price_currency_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_quote_line_items_price_metadata
Orçamentos - Detalhes - Itens: price.metadata (uma linha por item; liga-se a stripe_quote_line_items pela coluna quote_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quote_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_quote_line_items_price_tiers
Orçamentos - Detalhes - Itens: price.tiers (uma linha por item; liga-se a stripe_quote_line_items pela coluna quote_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quote_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_quote_line_items_taxes
Orçamentos - Detalhes - Itens: taxes (uma linha por item; liga-se a stripe_quote_line_items pela coluna quote_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quote_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
stripe_quote_line_items_taxes_rate_metadata
Orçamentos - Detalhes - Itens: taxes.rate.metadata (uma linha por item; liga-se a stripe_quote_line_items pela coluna quote_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_quotes). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_quote_line_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_quote_line_items_taxes, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Pagamentos de faturas
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Pagamentos aplicados às faturas, com valor pago, status e o pagamento de origem.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que foi efetivamente pago nesta fatura. Este campo é nulo até que o pagamento seja efetuado. Este valor pode ser menor que amount_requested se o amount_received do PaymentIntent não for suficiente para pagar todas as faturas às quais ele está vinculado. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que se pretende pagar nesta fatura. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] A fatura que foi paga. |
|
|
boolean |
[pt] A Stripe cria automaticamente um InvoicePayment padrão quando a fatura é finalizada e o mantém sincronizado com o amount_remaining da fatura. O PaymentIntent associado ao pagamento padrão não pode ser editado nem cancelado diretamente. Valores: true (sim) ou false (não). |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] ID da cobrança bem-sucedida deste pagamento quando type é charge. Observação: charge só é exibido se o objeto de cobrança não estiver associado a um payment intent. Se o objeto de cobrança tiver um payment intent, o Invoice Payment exibe o payment intent no lugar. |
|
|
text |
[pt] ID do PaymentIntent associado a este pagamento quando type é payment_intent. Observação: esta propriedade só é preenchida para faturas finalizadas em ou após 15 de março de 2019. |
|
|
text |
[pt] ID do PaymentRecord associado a este pagamento quando type é payment_record. |
|
|
text |
[pt] Tipo de objeto de pagamento associado a este pagamento de fatura. Valores possíveis: charge = cobrança (charge); payment_intent = PaymentIntent; payment_record = registro de pagamento (Payment Record). |
|
|
text |
[pt] O status do pagamento, um entre open, paid ou canceled. |
|
|
timestamp |
[pt] O momento em que o pagamento foi cancelado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
timestamp |
[pt] O momento em que o pagamento foi bem-sucedido. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
Planos
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Planos (modelo antigo de preço recorrente do Stripe).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o plano pode ser usado em novas compras. Valores: true (sim) ou false (não). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
|
|
text |
[pt] Descreve como calcular o preço por período. per_unit ou tiered. per_unit indica que o valor fixo (especificado em amount) será cobrado por unidade em quantity (para planos com usage_type=licensed), ou por unidade do uso total (para planos com usage_type=metered). Valores possíveis: per_unit = preço fixo por unidade; tiered = preço por faixas. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] A frequência com que uma assinatura é cobrada. Um entre day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O número de intervalos (especificados no atributo interval) entre as cobranças da assinatura. Por exemplo, interval=month e interval_count=3 cobra a cada 3 meses. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O medidor que rastreia o uso de um preço medido. |
|
|
text |
[pt] Uma breve descrição do plano, oculta dos clientes. |
|
|
text |
[pt] O produto cujo preço este plano determina. |
|
|
text |
[pt] Define se o preço escalonado deve ser graduated ou baseado em volume. No escalonamento baseado em volume, a quantidade máxima dentro de um período determina o preço por unidade. No escalonamento graduated, o preço pode mudar à medida que a quantidade cresce. Valores possíveis: graduated = graduado: cada faixa com seu preço; volume = por volume: faixa total define preço. |
|
|
int |
[pt] Divida o uso por este número. |
|
|
text |
[pt] Após a divisão, arredonde o resultado para cima ou para baixo. Valores possíveis: down = arredonda para baixo; up = arredonda para cima. |
|
|
int |
[pt] Número padrão de dias de teste ao assinar este plano para um cliente usando trial_from_plan=true. |
|
|
text |
[pt] Configura como a quantidade por período deve ser determinada. Pode ser metered ou licensed. licensed cobra automaticamente a quantidade definida ao adicioná-la a uma assinatura. metered agrega o uso total com base nos registros de uso. O padrão é licensed. Valores possíveis: licensed = cobra a quantidade contratada; metered = cobra pelo uso medido. |
stripe_plans_metadata
Planos: metadata (uma linha por item; liga-se a stripe_plans pela coluna plan_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_plans). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_plans_tiers
Planos: tiers (uma linha por item; liga-se a stripe_plans pela coluna plan_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_plans). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
Preços
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Preços dos produtos (avulsos ou recorrentes), com moeda, valor, intervalo de cobrança e faixas.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o preço pode ser usado em novas compras. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Descreve como calcular o preço por período. per_unit ou tiered. Valores possíveis: per_unit = preço fixo por unidade; tiered = preço por faixas. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Uma chave de consulta usada para recuperar preços dinamicamente a partir de uma string estática. Pode ter até 200 caracteres. |
|
|
text |
[pt] Uma breve descrição do preço, oculta dos clientes. |
|
|
text |
[pt] O ID do produto ao qual este preço está associado. |
|
|
text |
[pt] A frequência com que uma assinatura é cobrada. Um entre day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O número de intervalos (especificados no atributo interval) entre as cobranças da assinatura. Por exemplo, interval=month e interval_count=3 cobra a cada 3 meses. |
|
|
text |
[pt] O medidor que rastreia o uso de um preço medido. |
|
|
text |
[pt] Configura como a quantidade por período deve ser determinada. Pode ser metered ou licensed. licensed cobra automaticamente a quantidade definida ao adicioná-la a uma assinatura. metered agrega o uso total com base nos registros de uso. O padrão é licensed. Valores possíveis: licensed = cobra a quantidade contratada; metered = cobra pelo uso medido. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
text |
[pt] Define se o preço escalonado deve ser graduated ou baseado em volume. No escalonamento baseado em volume, a quantidade máxima dentro de um período determina o preço por unidade. No escalonamento graduated, o preço pode mudar à medida que a quantidade cresce. Valores possíveis: graduated = graduado: cada faixa com seu preço; volume = por volume: faixa total define preço. |
|
|
int |
[pt] Divida o uso por este número. |
|
|
text |
[pt] Após a divisão, arredonde o resultado para cima ou para baixo. Valores possíveis: down = arredonda para baixo; up = arredonda para cima. |
|
|
text |
[pt] Um de one_time ou recurring, dependendo de o preço ser de uma compra única ou de uma compra recorrente (assinatura). Valores possíveis: one_time = preço avulso (compra única); recurring = preço recorrente (assinatura). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
stripe_prices_currency_options
Preços: currency_options (uma linha por item; liga-se a stripe_prices pela coluna price_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_prices). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
stripe_prices_currency_options_tiers
Preços: currency_options.tiers (uma linha por item; liga-se a stripe_prices pela coluna price_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_prices). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_prices_currency_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_prices_metadata
Preços: metadata (uma linha por item; liga-se a stripe_prices pela coluna price_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_prices). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_prices_tiers
Preços: tiers (uma linha por item; liga-se a stripe_prices pela coluna price_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_prices). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
Produtos
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Produtos do catálogo Stripe.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o produto está atualmente disponível para compra. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O ID do objeto Price que é o preço padrão deste produto. |
|
|
text |
[pt] A descrição do produto, destinada a ser exibida ao cliente. Use este campo para armazenar, opcionalmente, uma explicação longa do produto vendido para sua própria renderização. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O nome do produto, destinado a ser exibido ao cliente. |
|
|
float |
[pt] Altura, em polegadas. |
|
|
float |
[pt] Comprimento, em polegadas. |
|
|
float |
[pt] Peso, em onças. |
|
|
float |
[pt] Largura, em polegadas. |
|
|
boolean |
[pt] Se este produto é enviado (ou seja, bens físicos). Valores: true (sim) ou false (não). |
|
|
text |
[pt] Informações extras sobre um produto que aparecerão na fatura do cartão de crédito do seu cliente. Caso vários produtos sejam cobrados de uma vez, será usado o primeiro descritor de extrato. Usado apenas em pagamentos de assinatura. |
|
|
text |
[pt] Um ID de código fiscal (tax code). |
|
|
text |
[pt] O ID de um local de imposto do tipo performance, representando onde a prestação ocorre. |
|
|
text |
[pt] Um ID de código fiscal (tax code). |
|
|
text |
[pt] Um rótulo que representa as unidades deste produto. Quando definido, será incluído nos recibos, faturas, no Checkout e no portal do cliente. |
|
|
timestamp |
[pt] Momento em que o objeto foi atualizado pela última vez. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A URL de uma página web publicamente acessível para este produto. |
stripe_products_images
Produtos: images (uma linha por item; liga-se a stripe_products pela coluna product_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_products). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Uma lista de até 8 URLs de imagens deste produto, destinadas a poderem ser exibidas ao cliente. |
stripe_products_marketing_features
Produtos: marketing_features (uma linha por item; liga-se a stripe_products pela coluna product_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_products). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do recurso de marketing. Até 80 caracteres. |
stripe_products_metadata
Produtos: metadata (uma linha por item; liga-se a stripe_products pela coluna product_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_products). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Recargas de saldo (top-ups)
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Objeto principal
Recargas de saldo (top-ups) feitas a partir da conta bancária.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor transferido. |
|
|
text |
[pt] ID da transação de saldo que descreve o impacto deste top-up no saldo da sua conta. Pode não ser especificado, dependendo do status do top-up. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
timestamp |
[pt] Data em que os fundos devem chegar à sua conta Stripe nos repasses. Considera atrasos como fins de semana ou feriados bancários. Pode não ser especificada, dependendo do status do top-up. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de erro que explica o motivo da falha do top-up, se disponível (consulte a seção de erros para a lista de códigos). |
|
|
text |
[pt] Mensagem ao usuário que explica melhor o motivo da falha do top-up, se disponível. |
|
|
text |
[pt] Indica se o top-up foi iniciado pela Stripe ou pelo usuário. Valores possíveis: stripe = iniciado pela Stripe; user = iniciado pelo usuário. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O ID de um PaymentMethod que representa o método de pagamento usado no top-up. Pode ser usado um PaymentMethod do tipo us_bank_account. |
|
|
text |
[pt] O campo source está obsoleto. Ele pode nem sempre estar presente na resposta da API. |
|
|
text |
[pt] Informações extras sobre um top-up. Aparecerão no extrato bancário da sua origem. Deve conter pelo menos uma letra. |
|
|
text |
[pt] O status da recarga (top-up) é canceled, failed, pending, reversed ou succeeded. Valores possíveis: canceled = cancelado; failed = falhou; pending = pendente; reversed = estornado; succeeded = concluído com sucesso. |
|
|
text |
[pt] Uma string que identifica este top-up como parte de um grupo. |
stripe_topups_metadata
Recargas de saldo (top-ups): metadata (uma linha por item; liga-se a stripe_topups pela coluna topup_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_topups). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_topups_payment_method_options
Recargas de saldo (top-ups): payment_method_options (uma linha por item; liga-se a stripe_topups pela coluna topup_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_topups). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] A rede de transferência bancária dos EUA usada nesta recarga (top-up). O padrão é ach. Valores possíveis: ach. |
Reembolsos
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Objeto principal
Reembolsos de cobranças, com valor (positivo, na moeda da cobrança), motivo, status e o mesmo valor na moeda do seu saldo (colunas balance_transaction_*, ali negativo porque saiu do saldo). Motivo vazio = não informado (reembolso feito pelo painel sem motivo).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor. Positivo aqui; na tabela de transações de saldo o mesmo reembolso aparece negativo (saiu do saldo). Na moeda da cobrança; na moeda do seu saldo: balance_transaction_amount. |
|
|
text |
[pt] Transação de saldo que descreve o impacto no saldo da sua conta. |
|
|
text |
[pt] ID da cobrança que foi reembolsada. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] ID do cliente deste reembolso. |
|
|
text |
[pt] ID da conta deste reembolso. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Você pode usá-la para exibir aos usuários (disponível apenas em reembolsos que não sejam de cartão). |
|
|
text |
[pt] Para reembolsos recusados pela rede, código de recusa fornecido pela rede que indica o motivo da falha do reembolso. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] Valor do número de referência atribuído ao reembolso. |
|
|
text |
[pt] Status do número de referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] Tipo do número de referência atribuído ao reembolso. |
|
|
text |
[pt] O tipo de reembolso. Pode ser refund, reversal ou pending. Valores possíveis: pending = retomada pendente; refund = reembolso; reversal = reversão. |
|
|
text |
[pt] O hash da transação do reembolso. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] Para reembolsos recusados pela rede, código de recusa fornecido pela rede que indica o motivo da falha do reembolso. |
|
|
text |
[pt] Para reembolsos recusados pela rede, código de recusa fornecido pela rede que indica o motivo da falha do reembolso. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] O tipo de detalhes específicos da transação do meio de pagamento usado no reembolso (ex.: card). Um hash adicional é incluído em destination_details com um nome correspondente a este valor. Ele contém informações específicas da transação de reembolso. |
|
|
text |
[pt] A referência atribuída ao reembolso. |
|
|
text |
[pt] Status da referência no reembolso. Pode ser pending, available ou unavailable. |
|
|
text |
[pt] Após a falha do reembolso, esta transação de saldo descreve o ajuste feito no saldo da sua conta que reverte a transação de saldo inicial. |
|
|
text |
[pt] Fornece o motivo da falha do reembolso. Os valores possíveis são: lost_or_stolen_card, expired_or_canceled_card, charge_for_pending_refund_disputed, insufficient_funds, declined, merchant_request ou unknown. |
|
|
text |
[pt] Para métodos de pagamento sem suporte nativo a reembolso (por exemplo, Konbini, PromptPay), informe um endereço de e-mail para o cliente receber as instruções de reembolso. |
|
|
timestamp |
[pt] O timestamp em que o e-mail foi enviado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O endereço de e-mail do destinatário. |
|
|
timestamp |
[pt] O carimbo de data/hora de expiração. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Tipo da próxima ação a ser executada. |
|
|
text |
[pt] ID do PaymentIntent que foi reembolsado. |
|
|
text |
[pt] ID do método de pagamento associado a este reembolso. |
|
|
text |
[pt] Fornece o motivo pelo qual o reembolso está pendente. Os valores possíveis são: processing, insufficient_funds ou charge_pending. Valores possíveis: charge_pending = cobrança original ainda pendente; insufficient_funds = saldo insuficiente para o reembolso; processing = reembolso em processamento. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que se pretende cobrar por este pagamento, denominado em presentment_currency. |
|
|
text |
[pt] Moeda apresentada ao cliente durante o pagamento. |
|
|
text |
[pt] Motivo do reembolso, fornecido pelo usuário (duplicate, fraudulent ou requested_by_customer) ou gerado internamente pela Stripe (expired_uncaptured_charge). Valores possíveis: duplicate = cobrança duplicada; expired_uncaptured_charge = cobrança não capturada expirou; fraudulent = fraude; requested_by_customer = solicitado pelo cliente. Vazio = motivo não informado (reembolso feito pelo painel sem escolher motivo). |
|
|
text |
[pt] Este é o número da transação que aparece nos recibos enviados por e-mail para este reembolso. |
|
|
text |
[pt] A reversão de transferência associada ao reembolso. Presente apenas se a cobrança veio de outra conta Stripe. |
|
|
text |
[pt] Status do reembolso. Pode ser pending, requires_action, succeeded, failed ou canceled. |
|
|
text |
[pt] Refere-se ao objeto de reversão de transferência, se a transferência correspondente for revertida. Aplicável apenas se a cobrança foi criada usando o parâmetro destination. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Este valor convertido para a moeda do seu saldo Stripe (ex.: reais), como entrou no saldo. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Tarifa da Stripe sobre esta transação, na moeda do seu saldo Stripe. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Líquido (valor menos a tarifa da Stripe), na moeda do seu saldo Stripe: o que de fato você recebe. |
|
|
text |
[pt] Moeda do seu saldo Stripe em que estão balance_transaction_amount, balance_transaction_fee e balance_transaction_net (ex.: brl = reais). |
|
|
float |
[pt] Câmbio usado para converter o valor para a moeda do saldo (amount × exchange_rate = balance_transaction_amount). Vazio quando não houve conversão. |
|
|
timestamp |
[pt] Data em que o dinheiro fica disponível no seu saldo Stripe para ser repassado ao banco. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Se o dinheiro já está disponível no seu saldo Stripe (available) ou ainda não (pending). |
stripe_refunds_metadata
Reembolsos: metadata (uma linha por item; liga-se a stripe_refunds pela coluna refund_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_refunds). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Repasses (payouts)
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Objeto principal
Repasses (payouts) do saldo Stripe para a sua conta bancária, com valor (positivo), status, data prevista de chegada ao banco (arrival_date) e falhas. Para saber quais vendas, tarifas e reembolsos compõem cada repasse, use a integração Repasses - Detalhes - Transações do repasse.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor (em centavos, ou equivalente local) que é transferido para sua conta bancária ou cartão de débito. Positivo aqui; na tabela de transações de saldo o mesmo repasse aparece negativo (saiu do saldo para o banco). |
|
|
text |
[pt] A taxa de aplicação (se houver) do repasse (payout). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor da taxa de aplicação (se houver) solicitada para o repasse (payout). |
|
|
timestamp |
[pt] Data em que você pode esperar que o repasse chegue ao banco. Considera atrasos como fins de semana ou feriados bancários. Data prevista de chegada ao banco (vale a data; a hora vem 00:00 UTC — não converta para o horário de Brasília, senão vira o dia anterior). |
|
|
boolean |
[pt] Retorna true se o repasse foi criado por um cronograma automático de repasses e false se foi solicitado manualmente. Valores: true (sim) ou false (não). |
|
|
text |
[pt] ID da transação de saldo que descreve o impacto deste repasse no saldo da sua conta. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] ID da conta bancária ou do cartão para o qual o repasse é enviado. |
|
|
text |
[pt] Se o repasse falhar ou for cancelado, é o ID da transação de saldo que reverte a transação de saldo inicial e devolve ao seu saldo os fundos do repasse que falhou. |
|
|
text |
[pt] Código de erro que informa o motivo da falha de um repasse, se disponível. Veja nossa lista de códigos de falha. |
|
|
text |
[pt] Mensagem que informa o motivo da falha de um repasse, se disponível. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O método usado para enviar este repasse (payout), que pode ser standard ou instant. instant é suportado para repasses a cartões de débito e contas bancárias em determinados países. |
|
|
text |
[pt] Se o repasse reverte outro, é o ID do repasse original. |
|
|
text |
[pt] ID da FinancialAccount v2 para a qual os fundos são enviados. |
|
|
text |
[pt] Se concluído, você pode usar a API Balance Transactions para listar todas as transações de saldo repassadas neste repasse. Valores possíveis: completed = conciliação concluída; in_progress = conciliação em andamento; not_applicable = conciliação não se aplica (repasse manual). |
|
|
text |
[pt] Se o repasse for revertido, é o ID do repasse que reverte este repasse. |
|
|
text |
[pt] O saldo de origem de onde este repasse (payout) saiu, que pode ser um dos seguintes: card, fpx ou bank_account. |
|
|
text |
[pt] Informações extras sobre um repasse que aparecem no extrato bancário do usuário. |
|
|
text |
[pt] Status atual do repasse (payout): paid, pending, in_transit, canceled ou failed. Um repasse fica pending até ser enviado ao banco, quando passa a in_transit. O status muda para paid se a transação for bem-sucedida, ou para failed ou canceled (em até 5 dias úteis). |
|
|
text |
[pt] Os valores possíveis são pending, supported e unsupported. Quando payout.status é pending ou in_transit, será pending. Quando o repasse passa para paid, failed ou canceled, este status passa a supported ou unsupported logo em seguida, na maioria dos casos. |
|
|
text |
[pt] O valor do ID de rastreamento (trace ID) se trace_id.status for suportado; caso contrário, nil. |
|
|
text |
[pt] Pode ser bank_account ou card. Valores possíveis: bank_account = conta bancária; card = cartão (online). |
stripe_payouts_metadata
Repasses (payouts): metadata (uma linha por item; liga-se a stripe_payouts pela coluna payout_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payouts). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Revisões do Radar
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Revisões de pagamentos sinalizados pelo Radar para análise manual, com motivo e decisão.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] O CEP ou código postal do cartão usado, se aplicável. |
|
|
text |
[pt] A cobrança associada a esta revisão. |
|
|
text |
[pt] O motivo pelo qual a revisão foi fechada, ou null se ainda não foi fechada. Um entre approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled ou acknowledged. Valores possíveis: acknowledged = revisão reconhecida e encerrada; approved = pagamento aprovado; canceled = pagamento cancelado; disputed = pagamento contestado; payment_never_settled = pagamento nunca liquidado; redacted = dados ocultados (redigidos); refunded = pagamento reembolsado; refunded_as_fraud = reembolsado como fraude. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] O endereço IP de onde o pagamento se originou. |
|
|
text |
[pt] A cidade de onde o pagamento se originou. |
|
|
text |
[pt] Código ISO de duas letras que representa o país de onde o pagamento se originou. |
|
|
float |
[pt] A latitude geográfica de onde o pagamento se originou. |
|
|
float |
[pt] A longitude geográfica de onde o pagamento se originou. |
|
|
text |
[pt] O estado/condado/província/região de onde o pagamento se originou. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
boolean |
[pt] Se true, a revisão precisa de ação. Valores: true (sim) ou false (não). |
|
|
text |
[pt] O motivo pelo qual a revisão foi aberta. Um entre rule ou manual. Valores possíveis: manual = aberta manualmente; rule = aberta por regra do Radar. |
|
|
text |
[pt] O ID do PaymentIntent associado a esta revisão, se existir. |
|
|
text |
[pt] O motivo pelo qual a revisão está atualmente aberta ou fechada. Um entre rule, manual, approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled ou acknowledged. |
|
|
text |
[pt] O navegador usado nesta sessão de navegação (por exemplo, Chrome). |
|
|
text |
[pt] Informações sobre o dispositivo usado na sessão do navegador (por exemplo, Samsung SM-G930T). |
|
|
text |
[pt] A plataforma da sessão de navegação (ex.: Macintosh). |
|
|
text |
[pt] A versão da sessão de navegação (ex.: 61.0.3163.100). |
Saldo atual
Tipo de replicação: Integral
Saldo atual da conta Stripe no momento da leitura: uma linha por tipo de saldo (disponível, pendente, reservado, instantâneo) e moeda.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Tipo de saldo: available (disponível), pending (pendente), connect_reserved (reservado para contas conectadas), instant_available (disponível para repasse instantâneo), refund_and_dispute_prefunding_available / _pending (pré-financiamento de reembolsos e contestações) e issuing_available (Issuing). |
|
|
text |
[pt] Moeda do saldo (código ISO de três letras, minúsculo). |
|
|
float |
[pt] Valor do saldo na unidade da moeda, com casas decimais (ex.: 1234.56 = R$ 1.234,56), já convertido dos centavos do Stripe. |
|
|
float |
[pt] Parte do valor (na unidade da moeda) que veio de cartões. |
|
|
float |
[pt] Parte do valor (na unidade da moeda) que veio de contas bancárias. |
|
|
float |
[pt] Parte do valor (na unidade da moeda) que veio de FPX (Malásia). |
|
|
boolean |
[pt] true se o saldo é do modo de produção; false se é do modo de teste. |
|
|
timestamp |
[pt] Data e hora (UTC) em que o saldo foi lido. |
Sessões de checkout
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- customer → Clientes > id
- invoice → Faturas > id
- payment_intent → Intenções de pagamento (PaymentIntents) > id
- payment_link → Links de pagamento > id
- setup_intent → Intenções de configuração (SetupIntents) > id
- subscription → Assinaturas > id
- checkout_session_id > _checkout_sessions_allowed_payment_method_types → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_custom_fields → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_custom_fields_dropdown_options → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_customer_details_tax_ids → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_discounts → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_excluded_payment_method_types → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_inv_invoice_dat_account_tax_ids → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_invo_invoice_data_custom_fields → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_invoice_c_invoice_data_metadata → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_metadata → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_optional_items → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_payment_method_options → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_pay_ban_requested_address_types → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_pay_fin_fil_account_subcategori → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_pay_financial_conne_permissions → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_pay_financial_connecti_prefetch → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_pay_mandate_options_default_for → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_pay_restrictions_brands_blocked → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_pay_restr_funding_types_blocked → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_payment_method_types → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_saved_p_allow_redisplay_filters → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_shipping_addr_allowed_countries → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_shipping_cost_taxes → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_shipping_options → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_total_detai_breakdown_discounts → Sessões de checkout > id
- checkout_session_id > _checkout_sessions_total_details_breakdown_taxes → Sessões de checkout > id
Objeto principal
Sessões do Stripe Checkout (página de pagamento), com cliente, valores, status de pagamento e o pagamento ou assinatura gerados.
stripe_checkout_sessions_allowed_payment_method_types
Sessões de checkout: allowed_payment_method_types (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Uma lista dos tipos de métodos de pagamento (por exemplo, card) que esta sessão de checkout pode aceitar. |
stripe_checkout_sessions_custom_fields
Sessões de checkout: custom_fields (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O valor que vem pré-preenchido na página de pagamento. |
|
|
text |
[pt] A opção selecionada pelo cliente. Será o valor da opção. |
|
|
text |
[pt] String de sua escolha que sua integração pode usar para reconciliar este campo. Deve ser única para este campo, alfanumérica e ter até 200 caracteres. |
|
|
text |
[pt] Texto personalizado do rótulo, exibido ao cliente. Até 100 caracteres. |
|
|
text |
[pt] O tipo do rótulo. Valores possíveis: custom = meio de pagamento personalizado. |
|
|
text |
[pt] O valor que pré-preenche o campo na página de pagamento. |
|
|
int |
[pt] A restrição de comprimento máximo de caracteres para a entrada do cliente. |
|
|
int |
[pt] A exigência de comprimento mínimo de caracteres para a entrada do cliente. |
|
|
text |
[pt] O valor informado pelo cliente, contendo apenas dígitos. |
|
|
boolean |
[pt] Se o cliente precisa preencher o campo antes de concluir a sessão de checkout. O padrão é false. Valores: true (sim) ou false (não). |
|
|
text |
[pt] O valor que pré-preenche o campo na página de pagamento. |
|
|
int |
[pt] A restrição de comprimento máximo de caracteres para a entrada do cliente. |
|
|
int |
[pt] A exigência de comprimento mínimo de caracteres para a entrada do cliente. |
|
|
text |
[pt] O valor informado pelo cliente. |
|
|
text |
[pt] O tipo do campo. Valores possíveis: dropdown = lista suspensa; numeric = campo numérico; text = campo de texto. |
stripe_checkout_sessions_custom_fields_dropdown_options
Sessões de checkout: custom_fields.dropdown.options (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_sessions_custom_fields, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O rótulo da opção, exibido ao cliente. Até 100 caracteres. |
|
|
text |
[pt] O valor desta opção, não exibido ao cliente, usado pela sua integração para conciliar a opção selecionada pelo cliente. Deve ser único para esta opção, alfanumérico e ter até 100 caracteres. |
stripe_checkout_sessions_customer_details_tax_ids
Sessões de checkout: customer_details.tax_ids (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O tipo do documento fiscal (tax ID), um entre ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn,… Valores possíveis: ad_nrt = NRT (Andorra); ae_trn = TRN (Emirados Árabes); al_tin = NIPT/TIN (Albânia); am_tin = TIN (Armênia); ao_tin = NIF (Angola); ar_cuit = CUIT (Argentina); au_abn = ABN (Austrália); au_arn = ARN (Austrália); aw_tin = TIN (Aruba); az_tin = TIN (Azerbaijão); ba_tin = TIN (Bósnia e Herzegovina); bb_tin = TIN (Barbados); bd_bin = BIN (Bangladesh); bf_ifu = IFU (Burkina Faso); bg_uic = UIC (Bulgária); bh_vat = VAT/IVA (Bahrein); bj_ifu = IFU (Benin); bo_tin = NIT (Bolívia); br_cnpj = CNPJ (Brasil); br_cpf = CPF (Brasil); bs_tin = TIN (Bahamas); by_tin = TIN (Belarus); ca_bn = BN (Canadá); ca_gst_hst = GST/HST (Canadá); ca_pst_bc = PST Colúmbia Britânica (Canadá); ca_pst_mb = PST Manitoba (Canadá); ca_pst_sk = PST Saskatchewan (Canadá); ca_qst = QST Quebec (Canadá); cd_nif = NIF (Rep. Dem. do Congo); ch_uid = UID (Suíça); ch_vat = VAT/IVA (Suíça); cl_tin = RUT (Chile); cm_niu = NIU (Camarões); cn_tin = TIN (China); co_nit = NIT (Colômbia); cr_tin = TIN (Costa Rica); cv_nif = NIF (Cabo Verde); de_stn = Steuernummer (Alemanha); do_rcn = RNC (Rep. Dominicana); ec_ruc = RUC (Equador); eg_tin = TIN (Egito); es_cif = CIF/NIF (Espanha); et_tin = TIN (Etiópia); eu_oss_vat = VAT/IVA regime OSS (União Europeia); eu_vat = VAT/IVA (União Europeia); fo_vat = VAT/IVA (Ilhas Faroé); gb_vat = VAT/IVA (Reino Unido); ge_vat = VAT/IVA (Geórgia); gi_tin = TIN (Gibraltar); gn_nif = NIF (Guiné); hk_br = BR (Hong Kong); hr_oib = OIB (Croácia); hu_tin = TIN (Hungria); ic_nif = NIF (Ilhas Canárias); id_npwp = NPWP (Indonésia); il_vat = VAT/IVA (Israel); in_gst = GSTIN (Índia); is_vat = VAT/IVA (Islândia); it_cf = Codice Fiscale (Itália); jp_cn = Corporate Number (Japão); jp_rn = RN para empresa estrangeira (Japão); jp_trn = TRN de consumo (Japão); ke_pin = KRA PIN (Quênia); kg_tin = TIN (Quirguistão); kh_tin = TIN (Camboja); kr_brn = BRN (Coreia do Sul); kz_bin = BIN (Cazaquistão); la_tin = TIN (Laos); li_uid = UID (Liechtenstein); li_vat = VAT/IVA (Liechtenstein); lk_vat = VAT/IVA (Sri Lanka); ma_vat = VAT/IVA (Marrocos); md_vat = VAT/IVA (Moldávia); me_pib = PIB (Montenegro); mk_vat = VAT/IVA (Macedônia do Norte); mr_nif = NIF (Mauritânia); mx_rfc = RFC (México); my_frp = FRP (Malásia); my_itn = ITN (Malásia); my_sst = SST (Malásia); ng_tin = TIN (Nigéria); no_vat = VAT/IVA (Noruega); no_voec = VOEC (Noruega); np_pan = PAN (Nepal); nz_gst = GST (Nova Zelândia); om_vat = VAT/IVA (Omã); pe_ruc = RUC (Peru); ph_tin = TIN (Filipinas); pl_nip = NIP (Polônia); py_ruc = RUC (Paraguai); ro_tin = TIN (Romênia); rs_pib = PIB (Sérvia); ru_inn = INN (Rússia); ru_kpp = KPP (Rússia); sa_vat = VAT/IVA (Arábia Saudita); sg_gst = GST (Singapura); sg_uen = UEN (Singapura); si_tin = TIN (Eslovênia); sn_ninea = NINEA (Senegal); sr_fin = FIN (Suriname); sv_nit = NIT (El Salvador); th_vat = VAT/IVA (Tailândia); tj_tin = TIN (Tajiquistão); tr_tin = TIN (Turquia); tw_vat = VAT/IVA (Taiwan); tz_vat = VAT/IVA (Tanzânia); ua_vat = VAT/IVA (Ucrânia); ug_tin = TIN (Uganda); unknown = tipo de ID fiscal desconhecido; us_ein = EIN (EUA); uy_ruc = RUC (Uruguai); uz_tin = TIN (Uzbequistão); uz_vat = VAT/IVA (Uzbequistão); ve_rif = RIF (Venezuela); vn_tin = TIN (Vietnã); za_vat = VAT/IVA (África do Sul); zm_tin = TIN (Zâmbia); zw_tin = TIN (Zimbábue). |
|
|
text |
[pt] O valor do documento fiscal (tax ID). |
stripe_checkout_sessions_discounts
Sessões de checkout: discounts (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Cupom anexado à sessão de checkout. |
|
|
text |
[pt] Código promocional anexado à sessão de checkout. |
stripe_checkout_sessions_excluded_payment_method_types
Sessões de checkout: excluded_payment_method_types (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Uma lista dos tipos de métodos de pagamento (por exemplo, card) que devem ser excluídos desta sessão de checkout. Deve ser usada apenas quando os métodos de pagamento desta sessão de checkout são gerenciados pelo Stripe Dashboard. |
stripe_checkout_sessions_inv_invoice_dat_account_tax_ids
Sessões de checkout: invoice_creation.invoice_data.account_tax_ids (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Os IDs fiscais da conta associados à fatura. |
stripe_checkout_sessions_invo_invoice_data_custom_fields
Sessões de checkout: invoice_creation.invoice_data.custom_fields (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O nome do campo personalizado. |
|
|
text |
[pt] O valor do campo personalizado. |
stripe_checkout_sessions_invoice_c_invoice_data_metadata
Sessões de checkout: invoice_creation.invoice_data.metadata (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_checkout_sessions_metadata
Sessões de checkout: metadata (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_checkout_sessions_optional_items
Sessões de checkout: optional_items (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
boolean |
[pt] Defina como true se a quantidade puder ser ajustada para qualquer inteiro não negativo. Valores: true (sim) ou false (não). |
|
|
int |
[pt] A quantidade máxima deste item que o cliente pode comprar. Por padrão, este valor é 99. Você pode especificar um valor de até 999999. |
|
|
int |
[pt] A quantidade mínima deste item que o cliente deve comprar, caso escolha comprá-lo. Como este item é opcional, o cliente sempre poderá removê-lo do pedido, mesmo que o mínimo configurado aqui seja maior que 0. Por padrão, este valor é 0. |
|
|
text |
[pt] Identificador do preço do item opcional oferecido no Checkout. |
|
|
int |
[pt] Quantidade inicial do item opcional oferecido no Checkout. |
stripe_checkout_sessions_payment_method_options
Sessões de checkout: payment_method_options (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Determina se o valor inclui o imposto IOF. Valores possíveis: always = valor sempre inclui IOF; never = valor não inclui IOF. |
|
|
text |
[pt] ID do app registrado no WeChat Pay. Obrigatório apenas quando o cliente é iOS ou Android. |
|
|
text |
[pt] O código de país desejado para as informações da conta bancária. Valores permitidos: DE, FR, IE ou NL. Valores possíveis: BE = Bélgica; DE = Alemanha; ES = Espanha; FR = França; IE = Irlanda; NL = Países Baixos. |
|
|
text |
[pt] Tipo de transferência bancária que esta PaymentIntent pode usar para financiar. Valores permitidos: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer ou us_bank_transfer. Valores possíveis: eu_bank_transfer = transferência bancária (zona do euro); gb_bank_transfer = transferência bancária (Reino Unido); jp_bank_transfer = transferência bancária (Japão); mx_bank_transfer = transferência bancária (México); us_bank_transfer = transferência bancária (EUA). |
|
|
text |
[pt] Controla quando os fundos serão capturados da conta do cliente. Valores possíveis: manual = captura manual posterior. |
|
|
text |
[pt] O tipo de cliente a partir do qual o consumidor final pagará… Valores possíveis: android = app Android; ios = app iOS; web = navegador web. |
|
|
text |
[pt] Moeda suportada pela conta bancária. Retornada quando a sessão está no modo setup. Valores possíveis: cad = dólar canadense; usd = dólar americano. |
|
|
int |
[pt] O número de dias corridos antes de um voucher de Boleto expirar. Por exemplo, se você criar um voucher de Boleto na segunda-feira e definir expires_after_days como 2, o voucher expirará na quarta-feira às 23:59, horário de America/Sao_Paulo. |
|
|
int |
[pt] O número de segundos após o qual o pagamento Pix expirará. |
|
|
text |
[pt] Somente para integrações webview. Ao concluir o login OAuth no navegador nativo, o usuário será redirecionado para esta URL para voltar ao seu app. |
|
|
text |
[pt] O tipo de método de financiamento a ser usado quando não há fundos suficientes no saldo do cliente. Valores permitidos: bank_transfer. Valores possíveis: bank_transfer = transferência bancária. |
|
|
boolean |
[pt] Indica se o parcelamento está habilitado… Valores: true (sim) ou false (não). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor que será cobrado. Obrigatório quando amount_type é fixed. |
|
|
text |
[pt] Determina se o valor inclui o imposto IOF. Valores possíveis: always = valor sempre inclui IOF; never = valor não inclui IOF. |
|
|
text |
[pt] Tipo de valor cobrado: exato (fixed) ou até o valor de amount (maximum). Padrão maximum. Valores possíveis: fixed = valor exato a cobrar; maximum = valor máximo a cobrar. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
text |
[pt] URL para o texto personalizado do mandato… |
|
|
text |
[pt] Descrição do mandato ou da assinatura exibida ao cliente. |
|
|
text |
[pt] Data, no formato AAAA-MM-DD, depois da qual os pagamentos não serão mais cobrados. Por padrão, sem data de término. |
|
|
text |
[pt] Descrição do intervalo. Obrigatório apenas se o parâmetro 'payment_schedule' for 'interval' ou 'combined'. |
|
|
text |
[pt] Cronograma de pagamento do mandato. Valores possíveis: combined = combinado: periódico e esporádico; interval = em intervalos fixos; sporadic = esporádico, sob demanda. |
|
|
int |
[pt] Número de pagamentos feitos em um período de pagamento. Padrão 1, exceto quando payment_schedule é adhoc; nesse caso, sem limite. |
|
|
text |
[pt] Finalidade dos pagamentos. Tem valor padrão conforme o código de categoria do comerciante (MCC). Valores possíveis: dependant_support = sustento de dependentes; government = pagamento governamental; loan = empréstimo; mortgage = financiamento imobiliário; other = outro propósito; pension = aposentadoria/pensão; personal = pagamento pessoal; retail = compra no varejo; salary = salário; tax = pagamento de impostos; utility = contas de consumo (água, luz etc.). |
|
|
text |
[pt] Nome da assinatura exibido ao comprador no app do banco. |
|
|
text |
[pt] Prefixo usado para gerar a referência do mandato. No máximo 12 caracteres: letras maiúsculas, números, espaços ou os caracteres '/', '_', '-', '&', '.'. Não pode começar com 'DDIC' nem 'STRIPE'. |
|
|
text |
[pt] Data, no formato AAAA-MM-DD, a partir da qual os pagamentos serão cobrados. Por padrão, o momento da confirmação. |
|
|
text |
[pt] Tipo de transação do mandato. Valores possíveis: business = transação empresarial; personal = transação pessoal. |
|
|
text |
[pt] Localidade (locale) preferida da página de checkout do PayPal para a qual o cliente é redirecionado. |
|
|
text |
[pt] Referência da transação do PayPal visível ao cliente, mapeada para o ID de fatura do PayPal. Deve ser um ID globalmente único se você configurou nas suas configurações do PayPal o bloqueio de múltiplos pagamentos por ID de fatura. |
|
|
text |
[pt] Solicita a capacidade de capturar além da janela de validade padrão da autorização nesta CheckoutSession. Valores possíveis: if_available = pede autorização estendida se disponível; never = nunca pede autorização estendida. |
|
|
text |
[pt] Solicita a capacidade de incrementar a autorização nesta CheckoutSession. Valores possíveis: if_available = solicitar autorização incremental se disponível; never = não solicitar autorização incremental. |
|
|
text |
[pt] Solicita a capacidade de fazer múltiplas capturas nesta CheckoutSession. Valores possíveis: if_available = solicita multicaptura se disponível; never = nunca solicita multicaptura. |
|
|
text |
[pt] Solicita a capacidade de fazer over-capture nesta CheckoutSession. Valores possíveis: if_available = sobrecaptura se disponível; never = nunca permitir sobrecaptura. |
|
|
text |
[pt] Recomendamos fortemente que você use o nosso SCA Engine para solicitar automaticamente a autenticação dos seus clientes com base no nível de risco e em outros requisitos. No entanto, se quiser solicitar 3D Secure com base na lógica do seu próprio mecanismo antifraude, informe esta opção. Valores possíveis: any = solicita 3D Secure sempre que possível; automatic = Stripe decide quando exigir 3D Secure; challenge = força desafio 3D Secure. |
|
|
text |
[pt] Indica que você pretende fazer pagamentos futuros com o método de pagamento deste PaymentIntent. Se você fornecer um Customer ao PaymentIntent, pode usar este parâmetro para vincular o método de pagamento ao Customer depois que o PaymentIntent for confirmado e o cliente concluir quaisquer ações necessárias. Valores possíveis: none = não salvar para uso futuro; off_session = uso futuro sem o cliente presente; on_session = uso futuro com o cliente presente. |
|
|
text |
[pt] Fornece informações sobre um pagamento com cartão que os clientes veem em suas faturas. É concatenado ao prefixo Kana (descritor Kana abreviado) ou ao descritor de fatura Kana definido na conta para formar o descritor completo. Máximo de 22 caracteres. |
|
|
text |
[pt] Fornece informações sobre um pagamento com cartão que os clientes veem em suas faturas. É concatenado ao prefixo Kanji (descritor Kanji abreviado) ou ao descritor de fatura Kanji definido na conta para formar o descritor completo. Máximo de 17 caracteres. |
|
|
text |
[pt] Controla quando a Stripe tentará debitar os fundos da conta do cliente. A data deve ser uma string no formato YYYY-MM-DD, no futuro e entre 3 e 15 dias corridos a partir de hoje. |
|
|
text |
[pt] Método de verificação da conta bancária. O valor padrão é automatic. Valores possíveis: automatic = automática (instantânea ou microdepósitos); instant = verificação instantânea; microdeposits = verificação por microdepósitos. |
stripe_checkout_sessions_pay_ban_requested_address_types
Sessões de checkout: payment_method_options.bank_transfer.requested_address_types (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_sessions_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista de tipos de endereço que devem ser retornados na resposta financial_addresses. Se não especificada, todos os tipos válidos serão retornados. Valores permitidos: sort_code, zengin, iban ou spei. Valores possíveis: aba = ABA (EUA); iban = IBAN; sepa = SEPA (Europa); sort_code = sort code (Reino Unido); spei = SPEI (México); swift = SWIFT (internacional); zengin = Zengin (Japão). |
stripe_checkout_sessions_pay_fin_fil_account_subcategori
Sessões de checkout: payment_method_options.financial_connections.filters.account_subcategories (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_sessions_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Subcategorias de conta usadas para filtrar as possíveis contas a vincular. As subcategorias válidas são checking e savings. Valores possíveis: checking = conta corrente; savings = conta poupança. |
stripe_checkout_sessions_pay_financial_conne_permissions
Sessões de checkout: payment_method_options.financial_connections.permissions (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_sessions_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] A lista de permissões a solicitar. A permissão payment_method deve ser incluída. Valores possíveis: balances = saldos da conta; ownership = titularidade da conta; payment_method = uso como meio de pagamento; transactions = transações da conta. |
stripe_checkout_sessions_pay_financial_connecti_prefetch
Sessões de checkout: payment_method_options.financial_connections.prefetch (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_sessions_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Recursos de dados solicitados para serem recuperados na criação da conta. Valores possíveis: balances = saldos; ownership = titularidade; transactions = transações. |
stripe_checkout_sessions_pay_mandate_options_default_for
Sessões de checkout: payment_method_options.mandate_options.default_for (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_sessions_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Lista de produtos da Stripe em que este mandato pode ser selecionado automaticamente. Retornada quando a sessão está no modo setup. Valores possíveis: invoice = padrão para faturas; subscription = padrão para assinaturas. |
stripe_checkout_sessions_pay_restrictions_brands_blocked
Sessões de checkout: payment_method_options.restrictions.brands_blocked (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_sessions_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Bandeiras de cartão a bloquear. Se um cliente informar ou selecionar um cartão de uma bandeira bloqueada, ele não conseguirá concluir o pagamento. Valores possíveis: american_express = American Express (bandeira); discover_global_network = Discover Global Network (bandeira); mastercard = Mastercard (bandeira); visa = Visa (bandeira). |
stripe_checkout_sessions_pay_restr_funding_types_blocked
Sessões de checkout: payment_method_options.restrictions.funding_types_blocked (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_sessions_payment_method_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Tipos de funding de cartão a bloquear nesta sessão de checkout. Os valores suportados são credit, debit e prepaid. Valores possíveis: credit = cartão de crédito bloqueado; debit = cartão de débito bloqueado; prepaid = cartão pré-pago bloqueado. |
stripe_checkout_sessions_payment_method_types
Sessões de checkout: payment_method_types (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Uma lista dos tipos de métodos de pagamento (por exemplo, card) que esta sessão de checkout pode aceitar. |
stripe_checkout_sessions_saved_p_allow_redisplay_filters
Sessões de checkout: saved_payment_method_options.allow_redisplay_filters (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Usa o valor allow_redisplay de cada método de pagamento salvo para filtrar o conjunto apresentado a um cliente recorrente. Por padrão, apenas métodos de pagamento salvos com ’allow_redisplay: ‘always’ são exibidos no Checkout. Valores possíveis: always = sempre pode ser reexibido ao cliente; limited = reexibição limitada; unspecified = não especificado. |
stripe_checkout_sessions_shipping_addr_allowed_countries
Sessões de checkout: shipping_address_collection.allowed_countries (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Um array de códigos de país ISO de duas letras que representam os países que o Checkout deve oferecer como opções de local de entrega. Códigos de país não suportados: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI. Valores possíveis: código de país ISO 3166-1 alfa-2 (ex.: BR = Brasil, US = Estados Unidos, PT = Portugal), entre os 238 países e territórios aceitos pelo Stripe. |
stripe_checkout_sessions_shipping_cost_taxes
Sessões de checkout: shipping_cost.taxes (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Alíquotas de imposto podem ser aplicadas a faturas, assinaturas e sessões de checkout para cobrar imposto. Guia relacionado: Tax rates… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
stripe_checkout_sessions_shipping_options
Sessões de checkout: shipping_options (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. |
|
|
text |
[pt] A taxa de envio. |
stripe_checkout_sessions_total_detai_breakdown_discounts
Sessões de checkout: total_details.breakdown.discounts (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor descontado. |
|
|
text |
[pt] Um desconto representa a aplicação efetiva de um cupom ou código promocional. Contém informações sobre quando o desconto começou, quando termina e a que se aplica. Guia relacionado: Aplicação de descontos em assinaturas… |
stripe_checkout_sessions_total_details_breakdown_taxes
Sessões de checkout: total_details.breakdown.taxes (uma linha por item; liga-se a stripe_checkout_sessions pela coluna checkout_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Alíquotas de imposto podem ser aplicadas a faturas, assinaturas e sessões de checkout para cobrar imposto. Guia relacionado: Tax rates… |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
Sessões de checkout - Detalhes - Itens
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
- checkout_session_id → Sessões de checkout > id
- checkout_session_id > _checkout_session_line_items_discounts → Sessões de checkout > id
- checkout_session_line_item_id > _checkout_session_line_items_discounts → Sessões de checkout - Detalhes - Itens > id
- checkout_session_id > _checkout_session_line_items_metadata → Sessões de checkout > id
- checkout_session_line_item_id > _checkout_session_line_items_metadata → Sessões de checkout - Detalhes - Itens > id
- checkout_session_id > _checkout_session_line_items_pric_currency_options → Sessões de checkout > id
- checkout_session_line_item_id > _checkout_session_line_items_pric_currency_options → Sessões de checkout - Detalhes - Itens > id
- checkout_session_id > _checkout_session_line_items_price_currency__tiers → Sessões de checkout > id
- checkout_session_line_item_id > _checkout_session_line_items_price_currency__tiers → Sessões de checkout - Detalhes - Itens > id
- checkout_session_id > _checkout_session_line_items_price_metadata → Sessões de checkout > id
- checkout_session_line_item_id > _checkout_session_line_items_price_metadata → Sessões de checkout - Detalhes - Itens > id
- checkout_session_id > _checkout_session_line_items_price_tiers → Sessões de checkout > id
- checkout_session_line_item_id > _checkout_session_line_items_price_tiers → Sessões de checkout - Detalhes - Itens > id
- checkout_session_id > _checkout_session_line_items_taxes → Sessões de checkout > id
- checkout_session_line_item_id > _checkout_session_line_items_taxes → Sessões de checkout - Detalhes - Itens > id
- checkout_session_id > _checkout_session_line_items_taxes_rate_metadata → Sessões de checkout > id
- checkout_session_line_item_id > _checkout_session_line_items_taxes_rate_metadata → Sessões de checkout - Detalhes - Itens > id
Objeto principal
Itens comprados em cada sessão de checkout, com preço, quantidade e valores.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o cliente pode ajustar a quantidade deste item no Checkout. Valores: true (sim) ou false (não). |
|
|
int |
[pt] Quantidade máxima que o cliente pode escolher para este item no Checkout. |
|
|
int |
[pt] Quantidade mínima que o cliente pode escolher para este item no Checkout. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de desconto aplicado. Se nenhum desconto foi aplicado, o padrão é 0. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total antes da aplicação de quaisquer descontos ou impostos. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor total de imposto aplicado. Se nenhum imposto foi aplicado, o padrão é 0. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Total após descontos e impostos. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. O padrão é o nome do produto. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se o preço pode ser usado em novas compras. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Descreve como calcular o preço por período. per_unit ou tiered. Valores possíveis: per_unit = preço fixo por unidade; tiered = preço por faixas. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Uma chave de consulta usada para recuperar preços dinamicamente a partir de uma string estática. Pode ter até 200 caracteres. |
|
|
text |
[pt] Uma breve descrição do preço, oculta dos clientes. |
|
|
text |
[pt] O ID do produto ao qual este preço está associado. |
|
|
text |
[pt] A frequência com que uma assinatura é cobrada. Um entre day, week, month ou year. Valores possíveis: day = diário; month = mensal; week = semanal; year = anual. |
|
|
int |
[pt] O número de intervalos (especificados no atributo interval) entre as cobranças da assinatura. Por exemplo, interval=month e interval_count=3 cobra a cada 3 meses. |
|
|
text |
[pt] O medidor que rastreia o uso de um preço medido. |
|
|
text |
[pt] Configura como a quantidade por período deve ser determinada. Pode ser metered ou licensed. licensed cobra automaticamente a quantidade definida ao adicioná-la a uma assinatura. metered agrega o uso total com base nos registros de uso. O padrão é licensed. Valores possíveis: licensed = cobra a quantidade contratada; metered = cobra pelo uso medido. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
text |
[pt] Define se o preço escalonado deve ser graduated ou baseado em volume. No escalonamento baseado em volume, a quantidade máxima dentro de um período determina o preço por unidade. No escalonamento graduated, o preço pode mudar à medida que a quantidade cresce. Valores possíveis: graduated = graduado: cada faixa com seu preço; volume = por volume: faixa total define preço. |
|
|
int |
[pt] Divida o uso por este número. |
|
|
text |
[pt] Após a divisão, arredonde o resultado para cima ou para baixo. Valores possíveis: down = arredonda para baixo; up = arredonda para cima. |
|
|
text |
[pt] Um de one_time ou recurring, dependendo de o preço ser de uma compra única ou de uma compra recorrente (assinatura). Valores possíveis: one_time = preço avulso (compra única); recurring = preço recorrente (assinatura). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
|
|
int |
[pt] A quantidade de produtos sendo comprada. |
stripe_checkout_session_line_items_discounts
Sessões de checkout - Detalhes - Itens: discounts (uma linha por item; liga-se a stripe_checkout_session_line_items pela coluna checkout_session_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_session_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor descontado. |
|
|
text |
[pt] O ID do objeto de desconto. Descontos não podem ser consultados por ID. Use expand[]=discounts nas chamadas de API para expandir os IDs de desconto em um array. |
|
|
text |
[pt] A sessão de checkout à qual este cupom é aplicado, se for aplicado a uma sessão específica no modo payment. Não presente no modo subscription. |
|
|
text |
[pt] O ID do cliente associado a este desconto. |
|
|
text |
[pt] O ID da conta que representa o cliente associado a este desconto. |
|
|
timestamp |
[pt] Se o cupom tem duração repeating, a data em que este desconto terminará. Se o cupom tem duração once ou forever, este atributo será nulo. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A fatura à qual o cupom do desconto foi aplicado, se foi aplicado diretamente a uma fatura específica. |
|
|
text |
[pt] O ID do item de fatura (ou do item de linha de fatura, para itens de linha do tipo type='subscription') ao qual o cupom do desconto foi aplicado, se foi aplicado diretamente a um item de fatura ou item de linha de fatura específico. |
|
|
text |
[pt] O código promocional aplicado para criar este desconto. |
|
|
text |
[pt] O cupom que foi resgatado para criar este desconto. |
|
|
text |
[pt] O tipo de origem do desconto. Valores possíveis: coupon = cupom. |
|
|
timestamp |
[pt] Data em que o cupom foi aplicado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] A assinatura à qual este cupom é aplicado, se for aplicado a uma assinatura específica. |
|
|
text |
[pt] O item de assinatura ao qual este cupom é aplicado, se for aplicado a um item de assinatura específico. |
stripe_checkout_session_line_items_metadata
Sessões de checkout - Detalhes - Itens: metadata (uma linha por item; liga-se a stripe_checkout_session_line_items pela coluna checkout_session_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_session_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_checkout_session_line_items_pric_currency_options
Sessões de checkout - Detalhes - Itens: price.currency_options (uma linha por item; liga-se a stripe_checkout_session_line_items pela coluna checkout_session_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_session_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário máximo que o cliente pode especificar para este item. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário mínimo que o cliente pode especificar para este item. Deve ser pelo menos o valor mínimo de cobrança. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário inicial, que pode ser atualizado pelo cliente. |
|
|
text |
[pt] Obrigatório somente se um comportamento de imposto padrão (default tax behavior) não foi fornecido nas configurações do Stripe Tax. Especifica se o preço é considerado com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Depois de especificado como inclusive ou exclusive, não pode ser alterado. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado. Definido apenas se billing_scheme=per_unit. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. O valor unitário a ser cobrado, representado como string decimal com no máximo 12 casas decimais. Definido apenas se billing_scheme=per_unit. |
stripe_checkout_session_line_items_price_currency__tiers
Sessões de checkout - Detalhes - Itens: price.currency_options.tiers (uma linha por item; liga-se a stripe_checkout_session_line_items pela coluna checkout_session_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_session_line_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_session_line_items_pric_currency_options, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_checkout_session_line_items_price_metadata
Sessões de checkout - Detalhes - Itens: price.metadata (uma linha por item; liga-se a stripe_checkout_session_line_items pela coluna checkout_session_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_session_line_items). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_checkout_session_line_items_price_tiers
Sessões de checkout - Detalhes - Itens: price.tiers (uma linha por item; liga-se a stripe_checkout_session_line_items pela coluna checkout_session_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_session_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço do nível (tier) inteiro. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a flat_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Preço por unidade para as unidades relevantes ao nível (tier). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Igual a unit_amount, mas contém um valor decimal com no máximo 12 casas decimais. |
|
|
int |
[pt] Até esta quantidade, inclusive, será contida na faixa (tier). |
stripe_checkout_session_line_items_taxes
Sessões de checkout - Detalhes - Itens: taxes (uma linha por item; liga-se a stripe_checkout_session_line_items pela coluna checkout_session_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_session_line_items). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto aplicado para esta alíquota. |
|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] O padrão é true. Quando definido como false, esta alíquota de imposto não pode ser usada em novas aplicações ou sessões de checkout, mas continua funcionando em assinaturas e faturas que já a tenham definida. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string arbitrária anexada à alíquota de imposto, apenas para uso interno. Não será visível para seus clientes. |
|
|
text |
[pt] O nome de exibição das alíquotas de imposto, como aparecerá ao cliente no e-mail de recibo, no PDF e na página hospedada da fatura. |
|
|
float |
[pt] Percentual real/efetivo da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual reflete a alíquota efetivamente usada para calcular o imposto, com base na tributabilidade do produto e no fato de o usuário estar registrado para cobrar impostos na jurisdição correspondente. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do imposto quando rate_type é flat_amount. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. |
|
|
boolean |
[pt] Especifica se a alíquota de imposto é inclusiva ou exclusiva. Valores: true (sim) ou false (não). |
|
|
text |
[pt] A jurisdição da alíquota de imposto. Você pode usar este campo de rótulo para fins de relatório fiscal. Ele também aparece na fatura do cliente. |
|
|
text |
[pt] O nível da jurisdição que impõe esta alíquota de imposto. Será null para alíquotas definidas manualmente. Valores possíveis: city = municipal; country = nacional; county = condado; district = distrito; multiple = múltiplas jurisdições; state = estadual. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
float |
[pt] Percentual da alíquota de imposto, de 0 a 100. Em cálculos de impostos com automatic_tax[enabled]=true, este percentual inclui a alíquota legal de jurisdições não tributáveis. |
|
|
text |
[pt] Indica o tipo de alíquota de imposto aplicada ao valor tributável. Este valor pode ser nulo quando nenhum imposto se aplica ao local. Este campo só está presente em TaxRates criadas pelo Stripe Tax. Valores possíveis: flat_amount = valor fixo de imposto; percentage = percentual de imposto. |
|
|
text |
[pt] Código de subdivisão ISO 3166-2, sem o prefixo do país. Por exemplo, "NY" para Nova York, Estados Unidos. |
|
|
text |
[pt] O tipo de imposto de alto nível, como vat ou sales_tax. Valores possíveis: amusement_tax = imposto sobre entretenimento; communications_tax = imposto sobre comunicações; digital_excise_tax = imposto seletivo sobre bens digitais; gst = imposto sobre bens e serviços (GST); hst = imposto harmonizado sobre vendas (HST, Canadá); igst = GST integrado (IGST, Índia); jct = imposto sobre consumo do Japão (JCT); lease_tax = imposto sobre locação; mass_transit_parking_tax = imposto de estacionamento em transporte público; parking_tax = imposto sobre estacionamento; pst = imposto provincial sobre vendas (PST, Canadá); qst = imposto sobre vendas de Quebec (QST); retail_delivery_fee = taxa sobre entregas no varejo; rst = imposto sobre vendas no varejo (RST); sales_tax = imposto sobre vendas; service_tax = imposto sobre serviços; utility_users_tax = imposto sobre uso de serviços públicos; vat = imposto sobre valor agregado (IVA/VAT). |
|
|
text |
[pt] O motivo por trás deste imposto, por exemplo, se o produto é isento de imposto. Os valores possíveis deste campo podem ser ampliados à medida que novas regras fiscais forem suportadas. Valores possíveis: customer_exempt = cliente isento de imposto; not_collecting = sem registro para recolher imposto; not_subject_to_tax = não sujeito a imposto; not_supported = jurisdição não suportada; portion_product_exempt = parte do produto isenta; portion_reduced_rated = parte com alíquota reduzida; portion_standard_rated = parte com alíquota padrão; product_exempt = produto isento; product_exempt_holiday = produto isento por feriado fiscal; proportionally_rated = alíquota proporcional; reduced_rated = alíquota reduzida; reverse_charge = reverse charge: o comprador recolhe o imposto; standard_rated = alíquota padrão; taxable_basis_reduced = base de cálculo reduzida; zero_rated = alíquota zero. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor sobre o qual o imposto é calculado. |
stripe_checkout_session_line_items_taxes_rate_metadata
Sessões de checkout - Detalhes - Itens: taxes.rate.metadata (uma linha por item; liga-se a stripe_checkout_session_line_items pela coluna checkout_session_line_item_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_checkout_sessions). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_checkout_session_line_items). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_checkout_session_line_items_taxes, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Sessões de verificação de identidade
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Objeto principal
Sessões do Stripe Identity (verificação de documento e selfie), com status e resultado.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] Uma string para referenciar este usuário. Pode ser um ID de cliente, um ID de sessão ou algo semelhante, e pode ser usada para conciliar esta verificação com seus sistemas internos. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma string curta legível por máquina que informa o motivo da falha de verificação ou da sessão do usuário. Valores possíveis: abandoned = usuário abandonou a verificação; consent_declined = usuário recusou o consentimento; country_not_supported = país não suportado; device_not_supported = dispositivo sem câmera suportada; document_expired = documento vencido; document_type_not_supported = tipo de documento não aceito; document_unverified_other = documento não verificado (outro motivo); email_unverified_other = e-mail não verificado (outro motivo); email_verification_declined = usuário recusou verificar o e-mail; id_number_insufficient_document_data = dados insuficientes para verificar o número de ID; id_number_mismatch = número de ID não confere; id_number_unverified_other = número de ID não verificado (outro motivo); phone_unverified_other = telefone não verificado (outro motivo); phone_verification_declined = usuário recusou verificar o telefone; selfie_document_missing_photo = documento sem foto para comparar com a selfie; selfie_face_mismatch = rosto da selfie não confere com o documento; selfie_manipulated = selfie adulterada; selfie_unverified_other = selfie não verificada (outro motivo); under_supported_age = usuário abaixo da idade mínima. |
|
|
text |
[pt] Uma mensagem que explica o motivo da falha de verificação ou da sessão do usuário. |
|
|
text |
[pt] ID do VerificationReport mais recente. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
boolean |
[pt] Coleta um número de identificação e faz uma verificação do número de identificação com o nome e a data de nascimento extraídos do documento. Valores: true (sim) ou false (não). |
|
|
boolean |
[pt] Desabilita o upload de imagens; as imagens do documento de identidade devem ser capturadas com a câmera do dispositivo. Valores: true (sim) ou false (não). |
|
|
boolean |
[pt] Captura uma imagem do rosto e faz uma verificação por selfie, comparando um documento com foto e uma foto do rosto do usuário. Valores: true (sim) ou false (não). |
|
|
boolean |
[pt] Solicita a verificação por senha de uso único (one time password) de provided_details.email. Valores: true (sim) ou false (não). |
|
|
text |
[pt] Rigor da política de correspondência da data de nascimento (DOB) a ser aplicada. Valores possíveis: none = sem verificação de correspondência; similar = correspondência aproximada aceita. |
|
|
text |
[pt] Rigor da política de correspondência do nome a ser aplicada. Valores possíveis: none = sem verificação de correspondência; similar = correspondência aproximada aceita. |
|
|
boolean |
[pt] Solicita a verificação por senha de uso único (one time password) de provided_details.phone. Valores: true (sim) ou false (não). |
|
|
text |
[pt] E-mail do usuário que está sendo verificado… |
|
|
text |
[pt] Número de telefone do usuário que está sendo verificado… |
|
|
text |
[pt] Indica se este objeto e seus objetos relacionados foram redigidos (redacted) ou não. Valores possíveis: processing = em processamento; redacted = dados ocultados (redigidos); validated = validado. |
|
|
text |
[pt] ID do cliente… |
|
|
text |
[pt] O ID da conta (Account) que representa um cliente. |
|
|
text |
[pt] Token que referencia a conta (Account) associada do recurso Person relacionado. |
|
|
text |
[pt] Token que referencia o recurso Person relacionado. |
|
|
text |
[pt] Status desta VerificationSession. Valores possíveis: canceled = cancelado; processing = em processamento; requires_input = requer nova entrada do usuário; verified = verificado. |
|
|
text |
[pt] O tipo de verificação a ser realizada. Valores possíveis: document = verificação de documento; id_number = verificação de número de identidade; verification_flow = fluxo de verificação configurado. |
|
|
text |
[pt] O token de configuração de um fluxo de verificação do dashboard. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
int |
[pt] Dia numérico entre 1 e 31. |
|
|
int |
[pt] Mês numérico entre 1 e 12. |
|
|
int |
[pt] O ano com quatro dígitos. |
|
|
text |
[pt] O endereço de e-mail verificado do usuário. |
|
|
text |
[pt] O primeiro nome verificado do usuário. |
|
|
text |
[pt] O número de identificação verificado do usuário. |
|
|
text |
[pt] O tipo de número de identificação verificado do usuário. Valores possíveis: br_cpf = CPF (Brasil); sg_nric = NRIC (Singapura); us_ssn = SSN (EUA). |
|
|
text |
[pt] O sobrenome verificado do usuário. |
|
|
text |
[pt] O número de telefone verificado do usuário. |
|
|
text |
[pt] O sexo verificado do usuário. Valores possíveis: [redacted] = informação ocultada; female = feminino; male = masculino; unknown = desconhecido. |
|
|
text |
[pt] O local de nascimento verificado do usuário, conforme consta no documento. |
|
|
text |
[pt] O sexo verificado do usuário, conforme consta no documento. |
stripe_identity_verification_sessions_metadata
Sessões de verificação de identidade: metadata (uma linha por item; liga-se a stripe_identity_verification_sessions pela coluna verification_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_identity_verification_sessions). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_identity_verification_sessions_opt_doc_allowed_ty
Sessões de verificação de identidade: options.document.allowed_types (uma linha por item; liga-se a stripe_identity_verification_sessions pela coluna verification_session_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_identity_verification_sessions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Array de strings com os tipos de documento de identidade permitidos. Se o documento de identidade fornecido não for de um dos tipos permitidos, a verificação falhará com o código de erro document_type_not_allowed. Valores possíveis: driving_license = carteira de motorista; id_card = carteira de identidade; passport = passaporte. |
Tarifas de frete
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Tarifas de frete oferecidas no Checkout e em faturas.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
boolean |
[pt] Se a taxa de envio pode ser usada em novas compras. O padrão é true. Valores: true (sim) ou false (não). |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Uma unidade de tempo. Valores possíveis: business_day = dia útil; day = dia; hour = hora; month = mês; week = semana. |
|
|
int |
[pt] Deve ser maior que 0. |
|
|
text |
[pt] Uma unidade de tempo. Valores possíveis: business_day = dia útil; day = dia; hour = hora; month = mês; week = semana. |
|
|
int |
[pt] Deve ser maior que 0. |
|
|
text |
[pt] O nome da taxa de envio, destinado a ser exibido ao cliente. Aparecerá nas CheckoutSessions. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] Especifica se a alíquota é considerada com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
|
|
text |
[pt] Um ID de código fiscal (tax code). O código fiscal de frete (Shipping) é txcd_92010001. |
|
|
text |
[pt] O tipo de cálculo a usar na taxa de envio. Valores possíveis: fixed_amount = valor fixo de frete. |
stripe_shipping_rates_fixed_amount_currency_options
Tarifas de frete: fixed_amount.currency_options (uma linha por item; liga-se a stripe_shipping_rates pela coluna shipping_rate_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_shipping_rates). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. |
|
|
text |
[pt] Especifica se a alíquota é considerada com impostos incluídos ou sem impostos. Um de inclusive, exclusive ou unspecified. Valores possíveis: exclusive = imposto somado ao preço; inclusive = imposto incluso no preço; unspecified = comportamento de imposto não definido. |
stripe_shipping_rates_metadata
Tarifas de frete: metadata (uma linha por item; liga-se a stripe_shipping_rates pela coluna shipping_rate_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_shipping_rates). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Taxas de aplicação
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Taxas de aplicação cobradas de contas conectadas (Stripe Connect), com valor e reembolsos.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] ID da conta Stripe da qual esta tarifa foi cobrada. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor ganho. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor reembolsado (pode ser menor que o atributo amount da tarifa se foi emitido um reembolso parcial) |
|
|
text |
[pt] ID do aplicativo Connect que obteve a tarifa. |
|
|
text |
[pt] Transação de saldo que descreve o impacto desta tarifa de aplicativo cobrada no saldo da sua conta (sem incluir reembolsos). |
|
|
text |
[pt] ID da cobrança da qual a tarifa de aplicativo foi cobrada. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] ID da cobrança que criou esta tarifa de aplicativo. |
|
|
text |
[pt] ID do repasse que criou esta tarifa de aplicativo. |
|
|
text |
[pt] Tipo de objeto que criou a taxa de aplicação. Valores possíveis: charge = cobrança (charge); payout = repasse para conta bancária. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] ID da cobrança correspondente na conta da plataforma, se esta tarifa resultou de uma cobrança feita com o parâmetro destination. |
|
|
boolean |
[pt] Se a taxa foi totalmente reembolsada. Se a taxa foi reembolsada apenas parcialmente, este atributo continuará false. Valores: true (sim) ou false (não). |
Terminal - Leitores
Tipo de replicação: Integral
Relacionamentos:
- reader_id > _terminal_readers_action_collect_inputs_inputs → Terminal - Leitores > id
- reader_id > _terminal_readers_action_col_inputs_select_choices → Terminal - Leitores > id
- reader_id > _terminal_readers_action_collect_in_inputs_toggles → Terminal - Leitores > id
- reader_id > _terminal_readers_action_collect_inputs_metadata → Terminal - Leitores > id
- reader_id > _terminal_readers_action_refund_payment_metadata → Terminal - Leitores > id
- reader_id > _terminal_readers_action_set_reade_cart_line_items → Terminal - Leitores > id
- reader_id > _terminal_readers_metadata → Terminal - Leitores > id
Objeto principal
Leitores de cartão do Stripe Terminal, com status e local.
stripe_terminal_readers_action_collect_inputs_inputs
Terminal - Leitores: action.collect_inputs.inputs (uma linha por item; liga-se a stripe_terminal_readers pela coluna reader_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_terminal_readers). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] Personaliza a descrição padrão deste campo… |
|
|
text |
[pt] Personaliza o rótulo padrão do botão de pular deste campo… |
|
|
text |
[pt] Personaliza o rótulo padrão do botão de enviar deste campo… |
|
|
text |
[pt] Personaliza o título padrão deste campo… |
|
|
text |
[pt] O endereço de e-mail coletado… |
|
|
text |
[pt] O número coletado… |
|
|
text |
[pt] O número de telefone coletado… |
|
|
boolean |
[pt] Indica que este campo é obrigatório, desabilitando o botão de pular. Valores: true (sim) ou false (não). |
|
|
text |
[pt] O id da opção selecionada… |
|
|
text |
[pt] O texto da opção selecionada… |
|
|
text |
[pt] ID do arquivo (File) da imagem da assinatura coletada… |
|
|
boolean |
[pt] Indica que este campo foi pulado pelo usuário. Valores: true (sim) ou false (não). |
|
|
text |
[pt] O valor de texto coletado… |
|
|
text |
[pt] Tipo de entrada sendo coletada. Valores possíveis: email = coletar e-mail; numeric = campo numérico; phone = coletar telefone; selection = coletar seleção de opção; signature = coletar assinatura; text = campo de texto. |
stripe_terminal_readers_action_col_inputs_select_choices
Terminal - Leitores: action.collect_inputs.inputs.selection.choices (uma linha por item; liga-se a stripe_terminal_readers pela coluna reader_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_terminal_readers). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_terminal_readers_action_collect_inputs_inputs, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O identificador da opção selecionada. Máximo de 50 caracteres. |
|
|
text |
[pt] Estilo do botão da opção. Pode ser primary ou secondary. Valores possíveis: primary = botão principal; secondary = botão secundário. |
|
|
text |
[pt] O texto a ser selecionado. Máximo de 30 caracteres. |
stripe_terminal_readers_action_collect_in_inputs_toggles
Terminal - Leitores: action.collect_inputs.inputs.toggles (uma linha por item; liga-se a stripe_terminal_readers pela coluna reader_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_terminal_readers). |
|
|
text |
[pt] Posição (ou chave) do item-pai desta linha dentro da tabela stripe_terminal_readers_action_collect_inputs_inputs, encadeada por ponto quando há mais de um nível (ex.: 2, usd, 0.3). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
text |
[pt] O valor padrão do toggle. Pode ser enabled ou disabled. Valores possíveis: disabled = desativado por padrão; enabled = ativado por padrão. |
|
|
text |
[pt] O texto de descrição do toggle. Máximo de 50 caracteres. |
|
|
text |
[pt] O texto de título do toggle. Máximo de 50 caracteres. |
|
|
text |
[pt] O valor coletado do toggle. Pode ser enabled ou disabled. Valores possíveis: disabled = desligado; enabled = ligado. |
stripe_terminal_readers_action_collect_inputs_metadata
Terminal - Leitores: action.collect_inputs.metadata (uma linha por item; liga-se a stripe_terminal_readers pela coluna reader_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_terminal_readers). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_terminal_readers_action_refund_payment_metadata
Terminal - Leitores: action.refund_payment.metadata (uma linha por item; liga-se a stripe_terminal_readers pela coluna reader_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_terminal_readers). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
stripe_terminal_readers_action_set_reade_cart_line_items
Terminal - Leitores: action.set_reader_display.cart.line_items (uma linha por item; liga-se a stripe_terminal_readers pela coluna reader_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_terminal_readers). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor do item de linha. |
|
|
text |
[pt] Descrição do item de linha. |
|
|
int |
[pt] A quantidade do item de linha. |
stripe_terminal_readers_metadata
Terminal - Leitores: metadata (uma linha por item; liga-se a stripe_terminal_readers pela coluna reader_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_terminal_readers). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Terminal - Locais
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Locais físicos cadastrados para os leitores do Stripe Terminal.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
text |
[pt] Cidade, distrito, bairro, município ou vilarejo. |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Linha de endereço 1, como a rua, a caixa postal ou o nome da empresa. |
|
|
text |
[pt] Linha de endereço 2, como o apartamento, a sala, a unidade ou o edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Estado, condado, província ou região (ISO 3166-2). |
|
|
text |
[pt] Cidade/Distrito (Ward). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Número do quarteirão/edifício. |
|
|
text |
[pt] Detalhes do edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Província (prefecture). |
|
|
text |
[pt] Cidade/cho-me (town/cho-me). |
|
|
text |
[pt] Cidade/Distrito (Ward). |
|
|
text |
[pt] Código de país de duas letras (ISO 3166-1 alpha-2). |
|
|
text |
[pt] Número do quarteirão/edifício. |
|
|
text |
[pt] Detalhes do edifício. |
|
|
text |
[pt] CEP ou código postal. |
|
|
text |
[pt] Província (prefecture). |
|
|
text |
[pt] Cidade/cho-me (town/cho-me). |
|
|
text |
[pt] O ID de uma configuração que será usada para personalizar todos os leitores neste local. |
|
|
text |
[pt] O nome de exibição do local. |
|
|
text |
[pt] A variação Kana do nome de exibição do local. |
|
|
text |
[pt] A variação Kanji do nome de exibição do local. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
text |
[pt] O número de telefone do local. |
stripe_terminal_locations_metadata
Terminal - Locais: metadata (uma linha por item; liga-se a stripe_terminal_locations pela coluna location_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_terminal_locations). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Transações de saldo
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Objeto principal
Transações de saldo: o extrato do seu saldo Stripe, já na moeda do saldo (ex.: reais). É a melhor fonte para faturamento, tarifas e conciliação: type = charge (venda), refund (reembolso), payout (repasse ao banco); amount = bruto, fee = tarifa da Stripe, net = líquido (amount − fee). Sinal: positivo entrou no saldo, negativo saiu (repasse e reembolso aparecem negativos aqui). A tabela-filha de tarifas detalha cada tarifa (processamento, conversão de moeda...).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor bruto desta transação. Um valor positivo representa fundos cobrados de outra parte, e um valor negativo representa fundos enviados a outra parte. Bruto, na moeda do seu saldo Stripe (ex.: reais). Positivo = entrou no saldo; negativo = saiu (repasses e reembolsos aparecem negativos aqui). |
|
|
timestamp |
[pt] A data em que os fundos líquidos da transação ficam disponíveis no saldo da Stripe. Data em que o dinheiro fica disponível para repasse (vale a data; a hora vem 00:00 UTC — não converta para o horário de Brasília, senão vira o dia anterior). |
|
|
text |
[pt] O saldo que esta transação impacta. Valores possíveis: issuing = saldo do Issuing; payments = saldo de pagamentos; refund_and_dispute_prefunding = saldo pré-financiado para reembolsos e disputas; risk_reserved = saldo retido como reserva de risco. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
float |
[pt] Se aplicável, esta transação usa uma taxa de câmbio. Se o dinheiro é convertido da moeda A para a moeda B, o valor na moeda A multiplicado pela exchange_rate é igual ao valor na moeda B. Câmbio usado na conversão: valor da cobrança (na moeda do cliente) × exchange_rate = amount desta linha (na moeda do saldo). Vazio quando não houve conversão. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Tarifas pagas por esta transação. Tarifa cobrada pela Stripe nesta transação (processamento + conversão de moeda, detalhadas na tabela-filha de tarifas). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Impacto líquido em um saldo da Stripe. Um valor positivo representa um incremento no saldo da Stripe, e um valor negativo, uma redução. Você pode calcular o impacto líquido de uma transação em um saldo por amount - fee… Líquido = amount − fee: o que de fato fica no seu saldo. |
|
|
text |
[pt] Categoria contábil da transação, mais simples que type: charge = venda; refund = reembolso; payout = repasse; fee = tarifa; dispute = contestação; adjustment = ajuste. |
|
|
text |
[pt] Esta transação está relacionada ao objeto Stripe. Id do registro que gerou a transação: cobrança (ch_...), reembolso (re_...), repasse (po_...) etc. |
|
|
text |
[pt] O status dos fundos líquidos da transação no saldo da Stripe, que pode ser available ou pending. |
|
|
text |
[pt] Tipo de transação: tax_fund, adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, inbound_transfer, inbound_transfer_reversal, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_dispute_provisional_credit, issuing_dispute… Valores possíveis: adjustment = ajuste de saldo; advance = adiantamento de fundos; advance_funding = financiamento do adiantamento; anticipation_repayment = reembolso de antecipação; application_fee = taxa da plataforma Connect; application_fee_refund = estorno da taxa da plataforma; charge = cobrança (charge); climate_order_purchase = compra de remoção de carbono (Climate); climate_order_refund = estorno de pedido Climate; connect_collection_transfer = transferência de cobrança Connect; contribution = contribuição (ex.: Climate); fee_credit_funding = crédito de tarifas Stripe; inbound_transfer = transferência recebida; inbound_transfer_reversal = reversão de transferência recebida; issuing_authorization_hold = bloqueio de autorização Issuing; issuing_authorization_release = liberação de autorização Issuing; issuing_dispute = contestação Issuing; issuing_dispute_provisional_credit = crédito provisório de contestação Issuing; issuing_dispute_provisional_credit_reversal = reversão de crédito provisório Issuing; issuing_transaction = transação de cartão Issuing; obligation_outbound = obrigação enviada; obligation_reversal_inbound = reversão de obrigação recebida; payment = pagamento; payment_failure_refund = devolução de pagamento falho; payment_network_reserve_hold = retenção de reserva da bandeira; payment_network_reserve_release = liberação de reserva da bandeira; payment_refund = reembolso de pagamento; payment_reversal = reversão de pagamento; payment_unreconciled = pagamento não conciliado; payout = repasse para conta bancária; payout_cancel = repasse cancelado; payout_failure = repasse falhou; payout_minimum_balance_hold = retenção de saldo mínimo de repasse; payout_minimum_balance_release = liberação de saldo mínimo de repasse; refund = reembolso; refund_failure = reembolso falhou; reserve_hold = retenção em reserva; reserve_release = liberação de reserva; reserve_transaction = movimentação de reserva; reserved_funds = fundos reservados; stripe_balance_payment_debit = débito pago com saldo Stripe; stripe_balance_payment_debit_reversal = reversão de débito com saldo Stripe; stripe_fee = tarifa da Stripe; stripe_fx_fee = tarifa de câmbio da Stripe; tax_fee = tarifa de impostos (Stripe Tax); tax_fund = fundos de impostos; topup = recarga de saldo; topup_reversal = reversão de recarga; transfer = transferência para conta conectada; transfer_cancel = transferência cancelada; transfer_failure = transferência falhou; transfer_refund = reversão de transferência. Mais comuns: charge = venda; refund = reembolso; payout = repasse para o banco; adjustment = ajuste; stripe_fee = tarifa avulsa da Stripe. |
stripe_balance_transactions_fee_details
Transações de saldo: fee_details (uma linha por item; liga-se a stripe_balance_transactions pela coluna balance_transaction_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_balance_transactions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor da tarifa. |
|
|
text |
[pt] ID do aplicativo Connect que obteve a tarifa. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. Descrição da tarifa, em inglês: "Stripe processing fees" = tarifa de processamento; "Stripe currency conversion fee" = tarifa de conversão de moeda. |
|
|
text |
[pt] Tipo da taxa, um entre: application_fee, payment_method_passthrough_fee, stripe_fee, tax ou withheld_tax. Tipo da tarifa (geralmente stripe_fee). Para separar processamento de conversão de moeda use a coluna description. |
Transferências
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Objeto principal
Transferências do saldo para contas conectadas (Stripe Connect).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor a ser transferido. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor revertido (pode ser menor que o atributo amount da transferência se foi emitida uma reversão parcial). |
|
|
text |
[pt] Transação de saldo que descreve o impacto desta transferência no saldo da sua conta. |
|
|
timestamp |
[pt] Momento em que este registro da transferência foi criado pela primeira vez. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
text |
[pt] ID da conta Stripe para a qual a transferência foi enviada. |
|
|
text |
[pt] Se o destino for uma conta Stripe, será o ID do pagamento que a conta de destino recebeu pela transferência. |
|
|
boolean |
[pt] Se o objeto existe em modo de produção (live mode), o valor é true. Se o objeto existe em modo de teste, o valor é false. true = registro do modo real (produção), false = registro do modo de teste. |
|
|
boolean |
[pt] Se a transferência foi totalmente revertida. Se a transferência foi revertida apenas parcialmente, este atributo continuará false. Valores: true (sim) ou false (não). |
|
|
text |
[pt] ID da cobrança usada para financiar a transferência. Se nulo, a transferência foi financiada a partir do saldo disponível. |
|
|
text |
[pt] O saldo de origem de onde esta transferência saiu. Um entre card, fpx ou bank_account. |
|
|
text |
[pt] Uma string que identifica esta transação como parte de um grupo. |
stripe_transfers_metadata
Transferências: metadata (uma linha por item; liga-se a stripe_transfers pela coluna transfer_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_transfers). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Transferências - Detalhes - Estornos
Tipo de replicação: Integral
Relacionamentos:
Objeto principal
Estornos de cada transferência para conta conectada.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_transfers). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor. |
|
|
text |
[pt] Transação de saldo que descreve o impacto no saldo da sua conta. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Reembolso de pagamento vinculado à reversão da transferência. |
|
|
text |
[pt] ID do reembolso responsável pela reversão da transferência. |
|
|
text |
[pt] ID da transferência que foi revertida. |
stripe_transfer_reversals_metadata
Transferências - Detalhes - Estornos: metadata (uma linha por item; liga-se a stripe_transfer_reversals pela coluna transfer_reversal_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_transfers). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_transfer_reversals). |
|
|
text |
[pt] Chave do item no registro (nome do metadado, moeda ou tipo de meio de pagamento). |
|
|
text |
[pt] Conjunto de pares chave-valor que você pode anexar a um objeto. Pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. |
Repasses - Detalhes - Transações do repasse
Tipo de replicação: Incremental com janela de atualização ou Integral (configurável pelo usuário)
Parâmetros:
- Janela de atualização (dias): No modo Incremental, a cada execução os registros criados nos últimos N dias são relidos (o Stripe filtra pela data de criação). Alterações em registros mais antigos que a janela só entram no modo Integral
- Data inicial de leitura: Registros criados a partir desta data serão lidos na primeira execução (modo Incremental)
Relacionamentos:
Objeto principal
Composição de cada repasse (payout): as vendas, tarifas, reembolsos e ajustes cujo dinheiro foi para a conta bancária naquele repasse, uma linha por transação de saldo, na moeda do saldo (ex.: reais). A soma de net das linhas (sem a própria linha type = payout) é o valor do repasse. Só repasses automáticos têm composição; repasses manuais ficam de fora.
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payouts). |
|
|
text |
[pt] Identificador único do objeto. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor bruto desta transação. Um valor positivo representa fundos cobrados de outra parte, e um valor negativo representa fundos enviados a outra parte. Bruto, na moeda do seu saldo Stripe (ex.: reais). Positivo = entrou no saldo; negativo = saiu (repasses e reembolsos aparecem negativos aqui). |
|
|
timestamp |
[pt] A data em que os fundos líquidos da transação ficam disponíveis no saldo da Stripe. Data em que o dinheiro fica disponível para repasse (vale a data; a hora vem 00:00 UTC — não converta para o horário de Brasília, senão vira o dia anterior). |
|
|
text |
[pt] O saldo que esta transação impacta. Valores possíveis: issuing = saldo do Issuing; payments = saldo de pagamentos; refund_and_dispute_prefunding = saldo pré-financiado para reembolsos e disputas; risk_reserved = saldo retido como reserva de risco. |
|
|
timestamp |
[pt] Momento em que o objeto foi criado. Data e hora em UTC (horário de Brasília = UTC − 3 h). |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. |
|
|
float |
[pt] Se aplicável, esta transação usa uma taxa de câmbio. Se o dinheiro é convertido da moeda A para a moeda B, o valor na moeda A multiplicado pela exchange_rate é igual ao valor na moeda B. Câmbio usado na conversão: valor da cobrança (na moeda do cliente) × exchange_rate = amount desta linha (na moeda do saldo). Vazio quando não houve conversão. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Tarifas pagas por esta transação. Tarifa cobrada pela Stripe nesta transação (processamento + conversão de moeda, detalhadas na tabela-filha de tarifas). |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Impacto líquido em um saldo da Stripe. Um valor positivo representa um incremento no saldo da Stripe, e um valor negativo, uma redução. Você pode calcular o impacto líquido de uma transação em um saldo por amount - fee… Líquido = amount − fee: o que de fato fica no seu saldo. |
|
|
text |
[pt] Categoria contábil da transação, mais simples que type: charge = venda; refund = reembolso; payout = repasse; fee = tarifa; dispute = contestação; adjustment = ajuste. |
|
|
text |
[pt] Esta transação está relacionada ao objeto Stripe. Id do registro que gerou a transação: cobrança (ch_...), reembolso (re_...), repasse (po_...) etc. |
|
|
text |
[pt] O status dos fundos líquidos da transação no saldo da Stripe, que pode ser available ou pending. |
|
|
text |
[pt] Tipo de transação: tax_fund, adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, inbound_transfer, inbound_transfer_reversal, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_dispute_provisional_credit, issuing_dispute… Valores possíveis: adjustment = ajuste de saldo; advance = adiantamento de fundos; advance_funding = financiamento do adiantamento; anticipation_repayment = reembolso de antecipação; application_fee = taxa da plataforma Connect; application_fee_refund = estorno da taxa da plataforma; charge = cobrança (charge); climate_order_purchase = compra de remoção de carbono (Climate); climate_order_refund = estorno de pedido Climate; connect_collection_transfer = transferência de cobrança Connect; contribution = contribuição (ex.: Climate); fee_credit_funding = crédito de tarifas Stripe; inbound_transfer = transferência recebida; inbound_transfer_reversal = reversão de transferência recebida; issuing_authorization_hold = bloqueio de autorização Issuing; issuing_authorization_release = liberação de autorização Issuing; issuing_dispute = contestação Issuing; issuing_dispute_provisional_credit = crédito provisório de contestação Issuing; issuing_dispute_provisional_credit_reversal = reversão de crédito provisório Issuing; issuing_transaction = transação de cartão Issuing; obligation_outbound = obrigação enviada; obligation_reversal_inbound = reversão de obrigação recebida; payment = pagamento; payment_failure_refund = devolução de pagamento falho; payment_network_reserve_hold = retenção de reserva da bandeira; payment_network_reserve_release = liberação de reserva da bandeira; payment_refund = reembolso de pagamento; payment_reversal = reversão de pagamento; payment_unreconciled = pagamento não conciliado; payout = repasse para conta bancária; payout_cancel = repasse cancelado; payout_failure = repasse falhou; payout_minimum_balance_hold = retenção de saldo mínimo de repasse; payout_minimum_balance_release = liberação de saldo mínimo de repasse; refund = reembolso; refund_failure = reembolso falhou; reserve_hold = retenção em reserva; reserve_release = liberação de reserva; reserve_transaction = movimentação de reserva; reserved_funds = fundos reservados; stripe_balance_payment_debit = débito pago com saldo Stripe; stripe_balance_payment_debit_reversal = reversão de débito com saldo Stripe; stripe_fee = tarifa da Stripe; stripe_fx_fee = tarifa de câmbio da Stripe; tax_fee = tarifa de impostos (Stripe Tax); tax_fund = fundos de impostos; topup = recarga de saldo; topup_reversal = reversão de recarga; transfer = transferência para conta conectada; transfer_cancel = transferência cancelada; transfer_failure = transferência falhou; transfer_refund = reversão de transferência. Mais comuns: charge = venda; refund = reembolso; payout = repasse para o banco; adjustment = ajuste; stripe_fee = tarifa avulsa da Stripe. |
stripe_payout_balance_transactions_fee_details
Repasses - Detalhes - Transações do repasse: fee_details (uma linha por item; liga-se a stripe_payout_balance_transactions pela coluna balance_transaction_id).
| Campo | Tipo | |
|---|---|---|
|
text |
[pt] Identificador do registro-pai (coluna id da tabela stripe_payouts). |
|
|
text |
[pt] Identificador do registro a que esta linha pertence (coluna id da tabela stripe_payout_balance_transactions). |
|
|
int |
[pt] Posição do item na lista (0 = primeiro), como o Stripe devolveu. |
|
|
float |
[pt] Valor em dinheiro já na unidade da moeda, com casas decimais: 1234.56 = R$ 1.234,56 quando a moeda é brl. Valor da tarifa. |
|
|
text |
[pt] ID do aplicativo Connect que obteve a tarifa. |
|
|
text |
[pt] Código de moeda ISO de três letras, em minúsculas. Deve ser uma moeda suportada. |
|
|
text |
[pt] Uma string arbitrária anexada ao objeto. Geralmente útil para exibir aos usuários. Descrição da tarifa, em inglês: "Stripe processing fees" = tarifa de processamento; "Stripe currency conversion fee" = tarifa de conversão de moeda. |
|
|
text |
[pt] Tipo da taxa, um entre: application_fee, payment_method_passthrough_fee, stripe_fee, tax ou withheld_tax. Tipo da tarifa (geralmente stripe_fee). Para separar processamento de conversão de moeda use a coluna description. |
Notas
Pontos importantes sobre os dados do Stripe:
- Integral ou Incremental: nas integrações de movimento (cobranças, PaymentIntents, reembolsos, faturas, assinaturas, clientes, sessões de checkout etc.) você escolhe o modo ao criar ou editar a integração. A API do Stripe só filtra pela data de criação: no modo Incremental (padrão) a cada execução são relidos os registros criados nos últimos N dias (a Janela de atualização, padrão 30); mudanças de status, valores, cancelamentos e exclusões de registros mais antigos que a janela só entram no modo Integral, que relê a base inteira a cada execução.
- Cadastros (produtos, preços, planos, cupons, códigos promocionais, alíquotas, fretes, links de pagamento, orçamentos) e o saldo atual são sempre Integral.
- Integrações "Detalhes" trazem todos os itens de cada registro (não só os 10 que o Stripe devolve embutidos): itens de fatura, de nota de crédito, de checkout, de link de pagamento e de orçamento acompanham o modo da integração-pai; meios de pagamento, identificações fiscais e transações de saldo do cliente, itens de assinatura e estornos de transferência são sempre Integral (um cartão novo num cliente antigo não seria lido no Incremental).
- Eventos são sempre Incremental: o Stripe guarda só os últimos 30 dias, então a tabela acumula o histórico. A tabela
stripe_events_changestraz, para cada evento de alteração, o atributo que mudou com o valor anterior e o novo. - Valores em dinheiro já vêm em reais, dólares etc., com casas decimais (ex.:
1234.56= R$ 1.234,56): a Kondado converte os centavos que o Stripe envia, respeitando moedas sem casa decimal (JPY) e de três casas (KWD). A moeda de cada valor está na colunacurrencydo registro. - Datas e horas estão em UTC (horário de Brasília = UTC − 3 h). Datas como a chegada do repasse ao banco (
arrival_date) e a disponibilidade no saldo (available_on) vêm com hora 00:00: use só a data, sem converter de fuso. - Qual tabela usar no financeiro:
- Faturamento, tarifas e líquido em reais:
stripe_balance_transactions(Transações de saldo), que já está na moeda do seu saldo Stripe.type = chargeé venda,refundé reembolso,payouté repasse ao banco;amounté o bruto,feea tarifa da Stripe eneto líquido. Valores positivos entraram no saldo e negativos saíram (repasses e reembolsos aparecem negativos aqui). A tabela..._fee_detailssepara tarifa de processamento e de conversão de moeda. - Vendas por cliente e recusas:
stripe_charges(Cobranças), na moeda cobrada do cliente. O mesmo valor em reais, com tarifa e líquido, está nas colunasbalance_transaction_amount,balance_transaction_feeebalance_transaction_net. Pagas:status = succeeded; recusadas:status = failed, com o motivo emoutcome_reason. - Conciliação bancária:
stripe_payouts(Repasses) traz cada repasse ao banco; a integração Repasses - Detalhes - Transações do repasse mostra quais vendas, tarifas e reembolsos compõem cada repasse. - Contas a receber:
stripe_invoicescomstatus = openeamount_remaining. Faturasdraft(rascunho) ainda não foram cobradas e não são dívida. - Assinaturas:
status = activenão garante que o cliente está pagando (cobrança pausada gera faturas em rascunho); confira as faturas pagas.
- Faturamento, tarifas e líquido em reais:
- Nada fica em JSON: objetos aninhados viram colunas (ex.:
billing_details_address_city) e listas viram tabelas próprias, ligadas à tabela principal pelo id do registro: cada item temitem_index(posição), dicionários têmkey(metadata, moeda, tipo de meio de pagamento) e itens dentro de itens têmparent_item. Os detalhes de cada meio de pagamento (cartão, Pix, boleto...) ficam em..._payment_method_details/..._payment_method_options, uma linha por tipo. - Os metadados (metadata) de cada objeto ficam numa tabela chave/valor própria (
..._metadata). - No modo Incremental, quando uma lista de um registro fica vazia (por exemplo, todos os metadados removidos), as linhas antigas dele na tabela relacionada só saem na próxima execução Integral.
- A Kondado usa uma versão fixa da API do Stripe, então o formato dos dados não depende da versão padrão configurada na sua conta.
- Parte desta documentacao foi gerada automaticamente por IA e pode conter erros. Recomendamos verificar informacoes críticas