> ## Documentation Index > Fetch the complete documentation index at: https://docs.malga.io/llms.txt > Use this file to discover all available pages before exploring further. # Realizar nova cobrança ## OpenAPI ````yaml post /v1/charges openapi: 3.1.0 info: version: '0.5' title: Documentação Malga API description: > # Authentication Os serviços de API da Malga são protegidos através de chaves de acesso. Você pode gerenciar suas chaves de acesso através do seu dashboard. É importante armazenar suas chaves de maneira privada e segura uma vez que elas possuem privilégios de alteração na sua conta. Não compartilhe suas chaves, não deixe elas fixadas no seu código e nem armazene elas no seu servidor de controle de versão. Recomendamos utilizar variáveis de ambiente secretas para deixar a chave disponível para sua aplicação. A Autenticação para todos os chamadas da API é feita através de headers HTTP, sendo necessário informar seu identificador de cliente na Malga e a chave secreta de acesso. ## X-Client-ID Identificador única da sua conta na Malga. Deve ser enviado no header obrigatóriamente em todas as requisições feitas a API. | Security Scheme Type | API Key | |-----------------------|-----------| | Header parameter name | `X-Client-ID` | ## X-Api-Key Sua chave de acesso a API. Funciona em par com o client-id devendo ser enviado no header obrigatóriamente em todas as requisições feitas a API. | Security Scheme Type | API Key | |-----------------------|-----------| | Header parameter name | `X-Api-Key` | ## Exemplo de requisicão autenticada ```bash curl --location --request GET 'https://api.malga.io/v1/' \ --header 'X-Client-Id: ' \ --header 'X-Api-Key: ' ``` servers: - url: https://api.malga.io description: Production security: - X-Client-ID: [] X-Api-Key: [] tags: - name: Client-token description: > É possível criar chaves públicas de acesso temporária a API com escopo e tempo de expiração limitados. Recomendamos o uso deste tipo de chave quando você tiver que expor a chave em uma aplicação client side. **Detalhe dos parâmetros da chamada de criação da chave pública:** **Retorno da chamada de criação da chave pública:** - name: Tokens description: | **Dados básicos de uma requisição de criação de card token** - name: Cards description: | **Dados básicos de um objeto cartão** - name: Customers description: > Através da API de `customers` é possível realizar a criação, edição, listagem e exclusão de dados de compradores para uso nos serviços de tokenização de cartões, cobrança por PIX, Boleto, uso em análise de motores de antifraude e recorrência. *A fim de manter maior integridade dos dados, as informações de email e documento (CPF/CNJP) são únicos para customers na sua conta Malga, não podendo existir dois compradores iguais.* ### Consulte a [tabela de tipos de paises e documentos suportados](#section/Tabela-tipos-de-paises-e-documentos-cadastro-de-Customer) para criação de customer - name: Sessions description: > Através da API de sessões é possível criar um pedido, composto por itens, métodos de pagamento e outros atributos, que pode ser pago através de um endpoint ou integrado ao MalgaCheckout. # Fluxo de criação e de pagamento de uma sessão - Crie uma `sessão` informando os dados básicos necessários - Utilize a `publicKey` retornada na criação ou recuperada na rota de detalhes no `X-Api-Key` para autenticar o pagamento **Dados básicos de um objeto do tipo session** - name: Charges description: > Para realizar uma cobrança deve criar um objeto `charge`. É possível recuperar detalhes de transações individuais ou listar todas as cobranças realizadas em um determinado `merchant`. Os `charges` são identificados a partir de um id 'único'. **Dados básicos de um objeto do tipo charge** - name: Webhooks description: > A Malga utiliza o serviço de webhooks para notificar o seu sistema sobre os eventos ocorridos na nossa plataforma. Através de webhooks você consegue atualizar seu sistema sempre que um evento importante acontece, como a atualização de status de uma cobrança para confirmar ou cancelar um determinado pagamento. **Dados básicos de um objeto do tipo event:** - name: Subscriptions description: > Através da API de `subscriptions` é possível realizar a criação, edição, listagem e exclusão de assinaturas. **Dados básicos de um objeto do tipo subscription** - name: Reports description: > Através da API Reports, é possível realizar a exportação das informações das transações processadas através da Malga em arquivo .csv, relacionadas à cobrança [charges], o pagamento [transaction], o link de pagamento [session] e cliente [customer] que realizou o pagamento - name: Merchants description: > Através das APIs de `merchants` é possível realizar a criação e configuração de sub contas na Malga. Uma sub conta, ou um `merchant`, é um cadastro de estabelecimento comercial que você tenha junto há um dos provedores de pagamentos integrados pela Malga. Uma vez que você tenha uma conta criada em um dos provedores aceitos, basta você solicitar suas credenciais de acesso ao parceiro e configurar seu cadastro na Malga. No cadastro de `merchant` é necessário informar o código da categoria `mcc` do seu cadastro junto ao provedor, escolher um dos tipos de provedores suportados pela Malga, e definir a prioridade do provedor com suas credenciais de acesso à API do provedor. O sistema de roteamento inteligente de transações da Malga foi desenvolvido de maneira a suportar o uso de múltiplos provedores por cadastro de estabelecimento. Usamos a prioridade definida no cadastro dos provedores para priorizar um determinado provedor em relação à outro, dessa forma você consegue gerenciar a ordem de provedores que será utilizado para fazer as retentativas. ### Consulte a [tabela de provedores aceitos](#section/Provedores-e-meios-de-pagamentos-suportados) para cadastro de credenciais ### Consulte a [tabela de código MCC](api-reference/type-tables/mcc-code.mdx) para cadastro de Merchants **Dados básicos do objeto do tipo merchant** - name: Providers description: > Através das APIs de Providers você pode realizar a edição e atualização dos provedores vinculados a um merchant já cadastrado na Malga. Essas operações permitem que você mantenha seus dados sempre atualizados, garantindo a continuidade e a segurança das integrações com os provedores de pagamento. **Atenção:** Alterações nas credenciais ou configurações do provedor podem impactar o processamento das transações. Sempre revise e valide as informações antes de salvar. ### Consulte a [tabela de provedores aceitos](#section/Provedores-e-meios-de-pagamentos-suportados) para cadastro de credenciais ### Consulte a [tabela de código MCC](api-reference/type-tables/mcc-code.mdx) para cadastro de Merchants **Dados básicos do objeto do tipo providers** - name: Sellers description: > Para realizar uma cobrança com Split, antes é necessário criar um `seller`. Os `sellers` são identificados a partir de um id 'único'. Através das APIs de `sellers` é possível realizar a criação e configuração de recebedores que serão beneficiados em um Split. Uma recebedor, ou um `seller`, é um cadastro de pessoa física ou jurídica para quem você tenha interesse em repassar automaticamente valores de uma determinada cobrança. É obrigatório informar o campo `owner` caso o seller cadastrado seja considerado como `pessoa física` agora se esse for considerado como `pessoa jurídica` é necessário informar os campos `owner` e `business`. - name: Flows description: > Através da API de `flows` é possível recuperar detalhes de um Fluxo ou listar todas os Fluxos cadastrados em determinado `clientId`. Os fluxos inteligentes são um recurso disponibilizado pela Malga para gestão dos pagamentos, possibilitando a configuração e a inserção de regras e condicionais personalizados para processamento das cobranças. Para mais informações, consulte a documentação [link](https://docs.malga.io/documentations/flow-guide/introduction). - name: Settings description: > Através da API de `settings` é possível recuperar e criar configurações de personalização de link de pagamento de um determinado `clientId`. - name: Payouts description: > Através das APIs de `payouts` é possível consultar o saldo disponível, listar repasses e visualizar as ordens de pagamento liquidadas para um cliente. Esses endpoints são read-only e atendem a fluxos de conciliação financeira de Split de pagamentos. As consultas são restritas ao `X-Client-Id` autenticado e podem ser filtradas por `sellerId` quando aplicável. **Status possíveis de repasse:** `pending`, `paid`, `failed`, `offset`. - name: Tabelas de tipos description: "\n# Provedores e meios de pagamentos suportados\n\n| Provedor | Cartão | Boleto | Pix | Pix Parcelado | Split | 3DS2 | Voucher | Descrição |\n| ------------ |--- |--- |--- |--- |--- |--- |--- |--------- |\n| `SANDBOX` | SIM | SIM | SIM | SIM | SIM | SIM | SIM | Simulador ambiente de teste |\n| `ADYEN` | SIM | SIM | SIM | NÃO | NÃO | SIM | NÃO | Adyen |\n| `BARTE` | SIM | NÃO | NÃO | NÃO | NÃO | SIM | NÃO | Barte |\n| `ITAU` | NÃO | EM BREVE | SIM | NÃO | NÃO | NÃO | NÃO | Itaú |\n| `BB` | NÃO | NÃO | SIM | NÃO | NÃO | NÃO | NÃO | Banco do Brasil |\n| `BRAINTREE` | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | Braintree |\n| `BRASPAG` | SIM | NÃO | NÃO | NÃO | SIM | NÃO | NÃO | Braspag |\n| `BS2_BOLETO` | NÃO | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | Banco BS2 Boleto |\n| `BS2` | NÃO | NÃO | SIM | NÃO | NÃO | NÃO | NÃO | Banco BS2 Pix |\n| `CIELO` | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | Cielo |\n| `DRIP` | NÃO | NÃO | NÃO | SIM | NÃO | NÃO | NÃO | Drip |\n| `GETNET` | SIM | SIM | SIM | NÃO | NÃO | NÃO | NÃO | Getnet |\n| `GETNETSEP` | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | GetnetSep |\n| `KLAP` | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | Klap |\n| `MERCADO_PAGO` | SIM | SIM | SIM | NÃO | NÃO | NÃO | NÃO | Mercado pago |\n| `PAGARME_V5` | SIM | SIM | SIM | NÃO | NÃO | NÃO | SIM | Pagar.me V5 |\n| `PAGARME` | SIM | SIM | SIM | NÃO | SIM | NÃO | NÃO | Pagar.me |\n| `PAGSEGURO` | SIM | NÃO | SIM | NÃO | NÃO | NÃO | NÃO | PagSeguro |\n| `PAYPAL` | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | PayPal |\n| `REDE` | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | Rede |\n| `SAFRAPAY` | SIM | NÃO | SIM | NÃO | NÃO | NÃO | NÃO | Safrapay |\n| `MAPINVEST` | NÃO | NÃO | SIM | NÃO | NÃO | NÃO | NÃO | Mapinvest |\n| `BOLT` | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | Bolt |\n| `STRIPE` | SIM | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | Stripe |\n| `VR` | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | SIM | VR |\n| `WORLDPAY` | SIM | NÃO | NÃO | NÃO | NÃO | NÃO | NÃO | Worldpay | \n| `ZOOP` | SIM | SIM | SIM | NÃO | SIM | NÃO | NÃO | Zoop |\n| `PICPAY` | SIM | NÃO | SIM | NÃO | NÃO | NÃO | NÃO | Picpay |\n\n# Provedores de AntiFraude\n| Provedor | Realtime | Assíncrono | Descrição |\n| ------------ |--- |--- |--------- |\n| `CLEARSALE` | SIM | SIM | Clearsale Realtime Decision e Behaviour Analytics |\n| `B2E` | NÃO | SIM | B2E Antifraude Análise de Risco |\n\n# Tabela de código de negação para declinedCode\n\n| DeclinedCode | ResponseMessage | O que fazer (ABECS) |\n| --------------------------|----------- | --------------- |\n| *card_not_supported* | The card does not support this type of purchase\t| UTILIZE FUNÇÃO DÉBITO |\n| *expired_card* | The card expiration date is invalid\t| VERIFIQUE OS DADOS DO CARTÃO |\n| *fraud_confirmed* | The charge has been declined for confirmed fraud | \tTRANSAÇÃO NÃO PERMITIDA PARA O CARTÃO - NÃO TENTE NOVAMENTE |\n| *fraud_suspect* | The charge has been declined for suspect it is fraudulent | \tCONTATE A CENTRAL DO SEU CARTÃO |\n| *generic* | The card has been declined for a unknown reason | \tCONTATE A CENTRAL DO SEU CARTÃO |\n| *insufficient_funds* | The card has insufficient funds\t| NÃO AUTORIZADA |\n| *invalid_amount* | The charge amount is not valid or exceeded maximum allowed\t| VALOR DA TRANSAÇÃO NÃO PERMITIDO |\n| *invalid_cvv* | The security code is invalid\t| SENHA INVÁLIDA |\n| *invalid_data* | The card has been declined for invalid data\t| VERIFIQUE OS DADOS DO CARTÃO |\n| *invalid_installment* | The charge has been declined because invalid number of installments\t| PARCELAMENTO INVÁLIDO |\n| *invalid_merchant* | The charge has been declined because merchant is not valid\t| CONTA ORIGEM INVÁLIDA |\n| *invalid_number* | The card number is invalid\t| VERIFIQUE OS DADOS DO CARTÃO |\n| *invalid_pin* | The card has been declined because pin is invalid\t| SENHA INVÁLIDA |\n| *issuer_not_available* | The card issuer could not be reached, charge not authorized\t| DADOS DO CARTÃO INVÁLIDO |\n| *lost_card* | The card has been declined because the card is reported lost\t| TRANSAÇÃO NÃO PERMITIDA - NÃO TENTE NOVAMENTE |\n| *not_permitted* | The charge is not permited to the card\t| TRANSAÇÃO NÃO PERMITIDA PARA O CARTÃO |\n| *pickup_card* | The card cannot be used to make this charges\t| CONTATE A CENTRAL DO SEU CARTÃO |\n| *pin_try_exceeded* | The card has been declined because exceeded maximum pin tries\t| EXCEDIDAS TENTATIVAS DE SENHA. CONTATE A CENTRAL DO SEU CARTÃO |\n| *restricted_card* | The card cannot be used to make this charge\t| DESBLOQUEIE O CARTÃO |\n| *security_violation* | The card has been declined for a unknown reason\t| VERIFIQUE OS DADOS DO CARTÃO |\n| *service_not_allowed* | The card has been declined because do not support international charge\t| CARTÃO NÃO PERMITE TRANSAÇÃO INTERNACIONAL |\n| *stolen_card* | The card has been declined because the card is reported stolen\t| TRANSAÇÃO NÃO PERMITIDA - NÃO TENTE NOVAMENTE |\n| *transaction_not_allowed* | The card has been declined for a unknown reason\t| ERRO NO CARTÃO |\n| *try_again* | The card has been declined for a unknown reason\t| REFAZER A TRANSAÇÃO |\n\n# Tabela de códigos MCC\n\n|MCC | Descrição |\n|--------|-----------------|\n|*742* | VETERINARIA |\n|*744* | Carefree Resorts |\n|*763* | COOPERATIVA AGRÍCOLA |\n|*780* | SERVIÇOS DE PAISAGISMO E HORTICULTURA |\n|*1520* | EMPREITEIROS EM GERAL - COMERCIAL E RESIDENCIAL |\n|*1711* | PREST. DE SERV. PARA AR COND., ENCANAMENTO E AQUEC. |\n|*1731* | ELETRICISTAS E SERVIÇOS ELÉTRICOS |\n|*1740* | PEDREIROS E SERVIÇOS DE INSTALAÇÃO |\n|*1750* | MARCENEIROS E SERVIÇOS DE CARPINTARIA |\n|*1761* | METALURGICOS |\n|*1771* | EMPREITEIO PARA SERVIÇOS ESPECIALIZADO |\n|*1799* | DEMAIS SVS DE REFORMA E CONSTRUÇÃO NÃO-CLASSIFICADOS |\n|*2741* | EDITORAS - PUBLICAÇÕES E IMPRESSÕES |\n|*2791* | TYPESETTING, PLATE MAKING AND RELATED SERVICES |\n|*2842* | SERVIÇOS DE LIMPEZA E POLIMENTO |\n|*4011* | TRANSPORTE FERROVIÁRIO DE CARGA |\n|*4111* | TRANSPORTE LOCAL DE PASSAGEIROS, INCLUINDO BALSAS |\n|*4112* | TRANSPORTE DE PASSAGEIROS EM TREM (LONGA DISTÂNCIA) |\n|*4119* | AMBULANCIAS |\n|*4121* | LIMUSINES E TÁXIS (TAXICABS AND LIMOUSINES) |\n|*4131* | COMPANHIAS DE ONIBUS |\n|*4214* | TRANSPORTE DE CARGA RODOVIÁRIO E ARMAZENAMENTO |\n|*4215* | CORREIOS - AÉREO, TERRESTRE E TRANSITÓRIOS |\n|*4225* | ARMAZENAM. PROD AGRÍCOLAS,MERCAD REFRIGERADAS,BENS DOMÉSTICO |\n|*4411* | LINHAS DE CRUZEROS (CRUISE LINES) |\n|*4457* | ALUGUEL E ARRENDAMENTO DE BARCOS, ESQUIS E IATES |\n|*4468* | MARINAS, SERVIÇOS E FORNECEDORES |\n|*4511* | OUTRAS CIAS AÉREAS |\n|*4582* | AEROPORTOS E SERVIÇOS LIGADOS A AERONAVES |\n|*4722* | AGÊNCIAS DE VIAGENS (TRAVEL AGENCIES) |\n|*4723* | AGÊNCIAS DE VIAGEM TUI (TUI TRAVEL AGENCY) |\n|*4784* | PEDÁGIOS |\n|*4789* | SERVIÇOS DE TRANSPORTE |\n|*4812* | TELEFONES E EQUIPAMENTOS DE TELECOMUN. |\n|*4813* | SERVIÇOS DE TELEC.- CHAM. LOCAIS E LONGA DISTÂNCIA |\n|*4814* | SERVIÇOS DE TELECOMUNICAÇÃO |\n|*4816* | REDES DE COMPUTADORES / SERVIÇOS DE INFORMAÇÃO |\n|*4821* | TELEGRAFO |\n|*4829* | ORDENS DE PAGAMENTO POR TRANSFERÊNCIA BANCÁRIA |\n|*4899* | SERVIÇOS DE TV A CABO/PAGA (CABLE/PAY TV SERVICES) |\n|*4900* | UTILID./ELEC/GAS/AGUÁ/SANI (UT../ELEC/GAS/H2O/SANI) |\n|*5013* | ATACADISTAS E DISTRIBUIDORES DE ACESSÓRIOS DE VEÍCULOS |\n|*5021* | MÓVEIS PARA ESCRITÓRIOS (COMMERCIAL FURNITURE) |\n|*5039* | MATERIAL PARA CONSTRUÇÃO E AFINS (CONST. MAT. - DEF) |\n|*5044* | A/D DE EQUIPAMENTOS DE FOTOGRAFIA, CÓPIA E MICROFILME |\n|*5045* | COMPUTADORES, EQUIPAMENTOS E SOFTWARES |\n|*5046* | A/D DE MÁQUINAS E EQUIPAMENTOS PARA EC |\n|*5047* | A/D DE EQUIPAMENTO HOSPITALARES, MÉDICOS E OFTÁLMICOS |\n|*5051* | CENTROS DE SERVIÇOS DE METAIS (METAL SERVICE CENTERS) |\n|*5065* | LOJA ARTIGOS ELETRÔNICOS |\n|*5072* | EQUIP./DISTRIB. DE HARDWARE (HARDWARE EQUIP.SUPPLIES) |\n|*5074* | EQUIP. DE AQUECIMENTO/ENCANAMENTO (PLUMB./HEAT. E.) |\n|*5085* | A/D DE SUPRIMENTOS INDUSTRIAIS (NÃO CLASSIFICADO EM OUTRO) |\n|*5094* | JOALHERIA, PEDRAS PRECIOSAS, METAIS |\n|*5099* | ATACADISTAS E DISTRIBUIDORES DE MERCADORIAS DURÁVEIS |\n|*5111* | A/D DE ARTIGOS DE PAPELARIA E SUPRIMENTOS PARA ESCRITÓRIO |\n|*5122* | FARMACEUTICOS/DROGAS (DRUGS/DRUGGISTS SUNDRIES) |\n|*5131* | A/D DE TECIDOS E PRODUTOS DE ARMARINHO |\n|*5137* | ATACADISTAS E DISTRIBUIDORES DE ROUPAS |\n|*5139* | ATACADISTAS E DISTRIBUIDORES DE CALÇADOS |\n|*5169* | A/D DE PRODUTOS QUIMICOS E SEMELHANTES (N CLASSIF. EM OUTRO) |\n|*5172* | PRODUTOS DE PETRÓLEO (PETROLEUM/PETROLEUM PRODUCTS) |\n|*5192* | ATAC. E DISTRIB. DE LIVROS, PERIÓDICOS E JORNAIS |\n|*5193* | ATACADISTAS E DISTRIBUIDORES DE FLORES, PLANTAS E SEMENTES |\n|*5198* | PINTURA, POLIMENTO E SUPRIM. (PAN.,VARN. & SUPPLIES) |\n|*5199* | A/D DE MERCADORIAS NÃO DURÁVEIS (NÃO CLASSIF. EM OUTRO) |\n|*5200* | LOJAS DE MATERIAL DE CONSTRUÇÃO (PEQUENO/MÉDIO PORTE) |\n|*5211* | LOJAS DE MATERIAL DE CONSTRUÇÃO-PRODUTOS BRUTOS (EX: TIJOLO) |\n|*5231* | LOJAS DE VIDROS, TINTAS E PAPÉIS DE PAREDE |\n|*5251* | VENDA DE EQUIPAMENTOS, INCLUINDO DE FERRAGEM |\n|*5261* | JARDINAGEM |\n|*5271* | CORRETORES DE RESIDÊNCIAS MÓVEIS |\n|*5300* | VENDA POR ATACADO (WHOLESALE CLUBS) |\n|*5309* | DUTY FREE STORES |\n|*5310* | LOJAS DE DESCONTO |\n|*5311* | LOJAS DE DEPARTAMENTOS (DEPARTMENT STORES) |\n|*5331* | LOJAS DE VARIEDADES |\n|*5399* | LOJA MERCADORIAS GERAIS |\n|*5411* | MERCEARIAS/SUPERMERCADOS (GROCERY STORES/SUPERM.) |\n|*5422* | AÇOGUEIRO (FREEZER/MEAT LOCKERS) |\n|*5441* | LOJA DE DOCES |\n|*5451* | LOJA DE PRODUTOS DE LACTICÍNIOS (DAIRY PROD. STORES) |\n|*5462* | CONFEITARIAS (BAKERIES) |\n|*5499* | LOJA DE ALIMENTOS VARIADOS (MISC FOOD S. - DEFAULT) |\n|*5511* | VENDA DE CARROS E CAMINHÕES (NOVOS E USADOS) |\n|*5521* | VENDA DE CARROS USADOS |\n|*5531* | Lojas de Automóveis, Lojas de Acessórios Domésticos |\n|*5532* | LOJA DE PNEUS |\n|*5533* | LOJA DE PEÇAS E ACESSÓRIOS DE CARROS |\n|*5541* | ESTAÇÕES DE SERVIÇOS (SERVICE STATIONS) |\n|*5551* | VENDA DE BARCOS MOTORIZADOS |\n|*5561* | ARTIGOS PARA ACAMPAMENTO |\n|*5571* | LOJAS DE MOTOCICLETAS E ACESSÓRIOS |\n|*5592* | VENDA DE TRAILLERS |\n|*5598* | CONSECIONÁRIA DE SNOWMOBILE |\n|*5599* | SERVIÇOS GERIAS PARA CARROS |\n|*5611* | ARTIGOS MASCULINOS |\n|*5621* | LOJA DE ROUPAS FEMININAS \"PRONTA PARA USAR\" |\n|*5631* | ACESSORIOS FEMININOS E LINGERIES |\n|*5641* | ARTIGOS PARA CRIANÇAS E BEBÊS |\n|*5651* | ROUPAS MASCULINAS, FEMININAS E INFANTIS |\n|*5655* | ROUPA ESPORTIVA |\n|*5661* | LOJAS DE SAPATOS |\n|*5681* | LOJA DE PELES |\n|*5691* | OJA ROUPA UNISSEX |\n|*5697* | COSTUREIRAS E ALFAIATES |\n|*5698* | LOJAS DE PERUCA |\n|*5699* | SERVIÇOS GERIAS PARA VESTIMENTA |\n|*5712* | LOJA DE MÓVEIS |\n|*5713* | Loja de Pisos |\n|*5714* | LOJA DE ESTOFADOS (DRAPERY & UPHOLSTERY STORES) |\n|*5718* | LAREIRAS E ACESSÓRIOS (FIREPLACES & ACCESSORIES) |\n|*5719* | LOJA DE MÓVEIS ESPECIALIZADA (HOME FURNISHING SPEC.) |\n|*5722* | LOJAS DE ELETRODOMÉSTICOS |\n|*5732* | LOJA DE ELETRÔNICOS |\n|*5733* | LOJA INSTRUMENTO MUSICAIS |\n|*5734* | LOJA DE SOFTWARE |\n|*5735* | LOJAS DE DISCOS |\n|*5811* | DISTRIBUIÇÃO E PRODUÇÃO DE ALIMENTOS |\n|*5812* | RESTAURANTES |\n|*5813* | BARES, PUBS E CASA NOTURNAS |\n|*5814* | LANCHONETES DE COMIDAS RÁPIDAS (FAST FOOD) |\n|*5815* | Produtos Digitais - De comunicação social audiovisual, incluindo Livros, Filmes e Música |\n|*5816* | Pordutos Digitais - Jogos |\n|*5817* | Produtos Digitais - Aplicativos de Software (Exceto Jogos) |\n|*5818* | Produtos Digitais - Diversas Categorias |\n|*5912* | FARMÁCIAS (DRUG STORES & PHARMACIES) |\n|*5921* | CERVEJAS, VINHOS E LICORES (STORE/BEER/WINE/LIQUOR) |\n|*5931* | LOJAS DE ARTIGOS DE SEGUNDA MÃO / BRECHÓS |\n|*5932* | LOJA DE ANTIGUIDADES (ANTIQUE SHOPS) |\n|*5933* | LOJAS DE PENHORES |\n|*5935* | DEMOLIÇÕES, SUCATAS, DESMANCHES DE AUTOMÓVEIS |\n|*5937* | L. DE REPRODUÇÃO DE ANTIQUIDADES (ANT.REPROD. STORES) |\n|*5940* | LOJA DE BICICLETAS - VENDAS E SERVIÇOS |\n|*5941* | SERVIÇOS GERAIS PARA ESPORTES |\n|*5942* | LIVRARIAS |\n|*5943* | PAPELARIAS |\n|*5944* | JOALHERIA (JEWERLY STORE) |\n|*5945* | LOJA DE BRINQUEDOS |\n|*5946* | LOJA DE FOTOGRAFIA |\n|*5947* | LOJA DE PRESENTES |\n|*5948* | ARTIGOS DE COURO |\n|*5949* | ARMARINHOS E LOJAS DE TECIDO |\n|*5950* | LOJA DE COPOS/CRISTAIS (GLASSWARE/CRYSTAL STORES) |\n|*5960* | MARK.DIRETO DE SEGUROS (DIR. MARKET. INSURANCE SVC) |\n|*5962* | SERV. DIRETOS DE VIAGENS (D. MKTG-TRAV. RELATED ARR) |\n|*5963* | VENDA DIRETA (DIRECT SELL/DOOR-TO-DOOR) |\n|*5964* | CATALOGO DE COMERCIOS (CATALOG MERCHANT) |\n|*5965* | CATÁLOGO DE VAREJO (COMB.CATALOG & RETAIL) |\n|*5966* | MARKETING DIRETO-SAÍDA (OUTB. TELEMARKETING M.) |\n|*5967* | MARKETING DIRETO - ENTRADA (INB. TELEMARKETING M.) |\n|*5968* | ASSINATURA COMERCIAL (CONTINUITY/SUBSCRIP. MERCHANT) |\n|*5969* | OUTROS VENDEDORES DE MARKETING DIRETO |\n|*5970* | PRODUTOS ARTESANAIS |\n|*5971* | GALERIA DE ARTE (ART DEALERS & GALLERIES) |\n|*5972* | LOJA DE MOEDAS E SELOS |\n|*5973* | LOJA DE BENS RELIGIOSOS |\n|*5975* | APARELHOS AUDITIVOS - VENDAS E SERVIÇOS |\n|*5976* | BENS ORTOPÉDICOS - PRÓTESES |\n|*5977* | LOJA DE COSMÉTICOS |\n|*5978* | MÁQUINAS DE ESCREVER - VENDA, ALUGUEL E SERVIÇOS |\n|*5983* | REVENDEDORES DE COMBUSTÍVEIS (FUEL DEALERS) |\n|*5992* | FLORICULTURA |\n|*5993* | TABACARIA |\n|*5994* | BANCA DE JORNAL E PROVEDOR DE NOTÍCIAS |\n|*5995* | PET SHOP |\n|*5996* | PISCINAS E BANHEIRAS - SERVIÇOS, SUPRIMENTOS E VENDAS |\n|*5997* | NAVALHA ELÉTRICA - VENDA E SERVIÇOS |\n|*5998* | LOJAS DE BARRACAS E TOLDOS |\n|*5999* | LOJAS ESPECIALIZADAS NÃO LISTADAS ANTERIOMENTE |\n|*6010* | BANCOS / LOJAS DE POUPANÇA E INST. FINANCEIRA |\n|*6011* | INSTIUIÇÃO FINANCEIRA - CAIXA ELETRÔNICO |\n|*6012* | INSTIUIÇÃO FINANCEIRA - AGÊNCIAS E SERVIÇOS |\n|*6050* | Similar a Dinheiro (Quase Cash) - Instituição Financeira Cliente |\n|*6051* | CASAS DE CÂMBIO |\n|*6211* | CORRETORES DE IMÓVEIS (SECURITIES BROKERS/DEALERS) |\n|*6300* | VENDA DE SEGUROS(INSURANCE SALES/UNDERWRITE) |\n|*6513* | CORRETOR DE IMÓVEIS (ALUGUEL) |\n|*6532* | PAGTOS DE TRANSAÇÕES DE INST.FINANCEIRAS |\n|*6533* | PAGTOS DE TRANSAÇÕES COMERCIAIS |\n|*7011* | HOTEIS (HOTELS/MOTELS/RESORTS) |\n|*7012* | TEMPO COMPARTILHADO (TIMESHARE) |\n|*7032* | ACAMPAMENTOS RECREATIVOS E DEPORTIVOS |\n|*7033* | SERVIÇOS DE ACAMPAMENTOS |\n|*7210* | LAVANDARIA, LIMPEZA E SERVIÇOS DE VESTUÁRIO |\n|*7211* | LAVANDERIA - FAMILIAR E COMERCIAL |\n|*7216* | LAVANDERIA TINTURARIA |\n|*7217* | LIMPEZA DE TAPETES E ESTOFADOS |\n|*7221* | ESTÚDIOS DE FOTOGRAFIA |\n|*7230* | SALAO DE BELEZA / BARBEARIA / DEPILAÇÃO / MANICURE |\n|*7251* | LOJA/REPARO DE SAPATOS |\n|*7261* | SERVIÇO FUNERÁRIO |\n|*7273* | SERVIÇO DE ENCONTROS E ACOMPANHANTE |\n|*7276* | SERVIÇOS DE PREP. IMPOST. DE RENDA (TAX PREP. SVCS) |\n|*7277* | S. DE ACONSELHAMENTO DE DÍVIDAS, CASAMENTO E PESSOAL |\n|*7278* | CLUBES DE COMPRAS |\n|*7296* | ALUGUEL DE ROUPAS - FANTASIAS, UNIFORMES E ROUPAS SOCIAIS |\n|*7297* | CENTRO DE SAUNAS E MASSAGENS |\n|*7298* | CLÍNICAS DE ESTÉTICA FACIAL / CORPORAL |\n|*7299* | OUTROS SERVIÇOS PESSOAIS |\n|*7311* | PUBLICIDADES |\n|*7321* | AGÊNCIAS DE ANÁLISE DE CRÉDITO DE CONSUMIDORES |\n|*7333* | SERVIÇOS DE IMPRESSÃO E ARTE GRÁFICA |\n|*7338* | COPIADORAS E FOTOCOPIADORAS |\n|*7339* | SERVIÇO DE SECRETARIADO E ESTENOGRAFIA |\n|*7342* | DEDETIZAÇÃO E DESINFECÇÃO |\n|*7343* | SERVIÇO DE EXTERMINIO E DESINFETAÇÃO |\n|*7349* | SERVIÇO LIMPEZA E MANUTENÇÃO |\n|*7361* | AGÊNCIAS DE EMPREGO |\n|*7372* | SERVIÇOS DE PROGRAMAÇÃO DE COMPUTADORES E PROCESS. DE DADOS |\n|*7375* | SERVIÇO DE RECUPERAÇÃO DE INFORMAÇÃO |\n|*7379* | COMPUTADORES: CONCERTOS E REPAROS |\n|*7392* | CONSULTORIA EMPRESARIAL E SERVIÇOS DE RELAÇÕES PÚBLICAS |\n|*7393* | AGÊNCIAS DE DETETIVES, PROTECÇÃO E DE SEGURANÇA |\n|*7394* | ALUGUEL DE EQUIPAMENTO E MOBÍLIA DE ESCRITÓRIOS |\n|*7395* | LABORATÓRIOS FOTOGRÁFICOS |\n|*7399* | SERVIÇOS DE NEGÓCIOS |\n|*7511* | PARADA DE CAMINHÕES (TRUCK STOP) |\n|*7512* | ALUGUEL DE AUTOMÓVEIS (AUTOMOBILE RENTAL AGENCY) |\n|*7513* | ALUGUEL DE CAMINHÕES (TRUCK/UTILITY TRAILER RENTALS) |\n|*7519* | ALUGUEL DE MOTOR HOME (MOTOR HOME/RV RENTALS) |\n|*7523* | ESTACIONAMENTOS E GARAGENS DE CARRO |\n|*7531* | FUNILARIAS E PINTURA AUTOMOTIVA |\n|*7534* | BORRACHARIAS |\n|*7535* | LOJAS DE PINTURA DE AUTTOMÓVEIS |\n|*7538* | SERVIÇOS PARA CARROS (NÃO CONCESIONARIA) |\n|*7542* | LAVA JATO |\n|*7549* | GUINCHO |\n|*7622* | CONSERTO DE EQUIP. AUDIO E TV |\n|*7623* | CONSERTO DE AR CONDICIONADO |\n|*7629* | CONSERTO DE ELETRONICOS |\n|*7631* | CONSERTO DE RELÓGIOS E JÓIAS |\n|*7641* | RESTAURAÇÃO DE MÓVEIS (FURNITURE REPAIR) |\n|*7692* | SERRALHEIROS E SOLDADORES |\n|*7699* | LOJA DE CONSERTOS GERAIS E SERVIÇOS RELACIONADOS |\n|*7829* | PRODUTORES E DISTRIBUIDORES DE FILMES |\n|*7832* | CINEMAS, PRODUÇÕES CINEMATOGRÁFICAS |\n|*7841* | LOJAS DE VIDEOS |\n|*7911* | DANÇA (ESTUDIOS, ESCOLAS E SALÕES) |\n|*7922* | TEATROS, PRODUC. TEATR. E ESPECTAC. |\n|*7929* | BANDAS,ORQUESTRAS,ARTISTAS DIVERSOS(N CLASSIFICADO EM OUTRO) |\n|*7932* | BARES DE SINUCA |\n|*7933* | BOLICHE |\n|*7941* | QUADRAS DE ESPORTE / PROPAGANDA ESPORTIVA |\n|*7991* | ATRAÇÕES TURÍSTICAS E EXPOSIÇÕES |\n|*7992* | AULAS DE GOLF PUBLICA |\n|*7993* | FORNECEDORES DE MÁQUINAS DE VIDEOGAME OU JOGOS |\n|*7994* | LOJAS DE DIVERSÃO / VIDEO GAME / LAN HOUSE / CIBER CAFÉ |\n|*7995* | CASSINOS, LOTERIAS E JOGOS DE AZAR |\n|*7996* | PARQUE DE DIVERSAO, CIRCO E AFINS |\n|*7997* | ACADEMIAS / CLUBES |\n|*7998* | AQUÁRIOS E ZOOLÓGICOS |\n|*7999* | SERVIÇOS DE RECREAÇÃO E FESTAS |\n|*8011* | MÉDICOS (CLÍNICAS E CONSULTÓRIOS) |\n|*8021* | DENTISTAS E ORTODONTISTAS (CLÍNICAS E CONSULTÓRIOS) |\n|*8031* | OSTEOPATAS |\n|*8041* | QUIROPRAXIA |\n|*8042* | OFTAMOLOGISTA E OPTOMETRISTAS |\n|*8043* | OPTICIANS, OPTICAL GOODS, AND EYEGLASSES |\n|*8049* | TRATAMENTOS PODIÁTRICOS |\n|*8050* | CASAS DE REPOUSO, CLÍN. DE RECUPERAÇÃO E ENFERMAGEM |\n|*8062* | HOSPITAIS |\n|*8071* | ANALISES CLÍNICAS MÉDICAS E DENTAIS |\n|*8099* | MEDICINA EM GERAL E PRATICANTES DE SERVIÇOS DE SAÚDE |\n|*8111* | SERVIÇOS JURÍDICOS - ADVOGADOS |\n|*8211* | EDUCAÇÃO PRIMÁRIA E SECUNDÁRIA (ELEM./SEC.S.) |\n|*8220* | UNIVERSIDADES E FACULDADES (COLLEGES/UNIV/JC/PROF.) |\n|*8241* | EDUACAÇÃO A DISTÂNCIA (CORRESPONDENCE SCHOOLS) |\n|*8244* | ESCOLA DE COMÉRCIOS E SECRETARIADO (BUS./SEC. SCHOOL) |\n|*8249* | ESCOLA DE NEGÓCIOS/VOCAÇÕES (TRADE/VOCATIONS S.) |\n|*8299* | COLEGIOS (SCHOOLS) |\n|*8351* | SERVIÇOS DE CUIDADOS DE CRIANÇAS (CHILD CARE SVCS) |\n|*8398* | ORGANIZAÇÕES DE SERVIÇOS BENEFICENTES E SOCIAIS |\n|*8641* | ASSOCIAÇÕES CÍVICAS E SOCIAIS |\n|*8651* | ORGANIZAÇÕES POLITICAS |\n|*8661* | ORGANIZAÇÕES RELIGIOSAS |\n|*8675* | ASSOCIAÇÃO DE CARROS |\n|*8699* | ORG. SIND., ASSOC. CULT. E OTRS ASSOC. NÃO CLASSIF. |\n|*8734* | LABORATÓRIOS DE TESTE (PARA TESTES NÃO MÉDICOS) |\n|*8911* | ARQUIRETURA, ENGENHARIA E AGRIMENSURA |\n|*8931* | CONTABILIDADE, AUDITORIA E SERVIÇOS DE CONTABILIDADE |\n|*8999* | OUTROS SERVIÇOS PROFISSIONAIS DE ESPECIALIZADOS |\n|*9211* | PENSÃO ALIMENTÍCIA (COURT COSTS/ALIMONY/SUPPORT) |\n|*9222* | MULTAS (FINES) |\n|*9223* | PAGAMENTOS DE TÍTULOS E FINANÇAS (BAIL AND BOND P.) |\n|*9311* | PAGAMENTOS DE IMPOSTOS (TAX PAYMENTS) |\n|*9399* | SERVIÇOS GOVERNAMENTAIS (GOVT SERV - DEFAULT) |\n|*9402* | POSTAGENS (POSTAGE STAMPS) |\n|*9405* | COMPRAS GOVERNAMENTAIS (INTRA-GOVERNMENT PURCHASES) |\n|*9406* | Loteria de Propriedade do Governo (Países Específicos |\n|*9950* | DEPART. DE COMPRAS (INTRA- COMPANY PURCHASES) |\n\n# Tabela tipos de moedas aceitas\n\n| Currency Code | Currency |\n| ----- |----------------------- |\n| **BRL** | \tBrazilian real |\n| *USD* | \tUnited States dollar |\n| *EUR* | \tEuro |\n| *YER* | \tYemeni rial |\n| *ZAR* | \tSouth African rand |\n| *AED* | \tUnited Arab Emirates dirham |\n| *AFN* | \tAfghan afghani |\n| *ALL* | \tAlbanian lek |\n| *AMD* | \tArmenian dram |\n| *ANG* | \tNetherlands Antillean guilder |\n| *AOA* | \tAngolan kwanza |\n| *ARS* | \tArgentine peso |\n| *AUD* | \tAustralian dollar |\n| *AWG* | \tAruban florin |\n| *AZN* | \tAzerbaijani manat |\n| *BAM* | \tBosnia and Herzegovina convertible mark |\n| *BBD* | \tBarbados dollar |\n| *BDT* | \tBangladeshi taka |\n| *BGN* | \tBulgarian lev |\n| *BIF* | \tBurundian franc |\n| *BMD* | \tBermudian dollar |\n| *BND* | \tBrunei dollar |\n| *BOB* | \tBoliviano |\n| *BSD* | \tBahamian dollar |\n| *BWP* | \tBotswana pula |\n| *BZD* | \tBelize dollar |\n| *CAD* | \tCanadian dollar |\n| *CDF* | \tCongolese franc |\n| *CHF* | \tSwiss franc |\n| *CLP* | \tChilean peso |\n| *CNY* | \tChinese yuan[8] |\n| *COP* | \tColombian peso |\n| *CRC* | \tCosta Rican colon |\n| *CVE* | \tCape Verdean escudo |\n| *CZK* | \tCzech koruna |\n| *DJF* | \tDjiboutian franc |\n| *DKK* | \tDanish krone |\n| *DOP* | \tDominican peso |\n| *DZD* | \tAlgerian dinar |\n| *EGP* | \tEgyptian pound |\n| *ETB* | \tEthiopian birr |\n| *ZMW* | \tZambian kwacha |\n| *FJD* | \tFiji dollar |\n| *FKP* | \tFalkland Islands pound |\n| *GBP* | \tPound sterling |\n| *GEL* | \tGeorgian lari |\n| *GIP* | \tGibraltar pound |\n| *GMD* | \tGambian dalasi |\n| *GNF* | \tGuinean franc |\n| *GTQ* | \tGuatemalan quetzal |\n| *GYD* | \tGuyanese dollar |\n| *HKD* | \tHong Kong dollar |\n| *HNL* | \tHonduran lempira |\n| *HRK* | \tCroatian kuna |\n| *HTG* | \tHaitian gourde |\n| *HUF* | \tHungarian forint |\n| *IDR* | \tIndonesian rupiah |\n| *ILS* | \tIsraeli new shekel |\n| *INR* | \tIndian rupee |\n| *ISK* | \tIcelandic króna |\n| *JMD* | \tJamaican dollar |\n| *JPY* | \tJapanese yen |\n| *KES* | \tKenyan shilling |\n| *KGS* | \tKyrgyzstani som |\n| *KHR* | \tCambodian riel |\n| *KMF* | \tComoro franc |\n| *KRW* | \tSouth Korean won |\n| *KYD* | \tCayman Islands dollar |\n| *KZT* | \tKazakhstani tenge |\n| *LAK* | \tLao kip |\n| *LBP* | \tLebanese pound |\n| *LKR* | \tSri Lankan rupee |\n| *LRD* | \tLiberian dollar |\n| *LSL* | \tLesotho loti |\n| *MAD* | \tMoroccan dirham |\n| *MDL* | \tMoldovan leu |\n| *MGA* | \tMalagasy ariary |\n| *MKD* | \tMacedonian denar |\n| *MMK* | \tMyanmar kyat |\n| *MNT* | \tMongolian tögrög |\n| *MOP* | \tMacanese pataca |\n| *MRO* | \tMacanese pataca |\n| *MUR* | \tMauritian rupee |\n| *MVR* | \tMaldivian rufiyaa |\n| *MWK* | \tMalawian kwacha |\n| *MXN* | \tMexican peso |\n| *MYR* | \tMalaysian ringgit |\n| *MZN* | \tMozambican metical |\n| *NAD* | \tNamibian dollar |\n| *NGN* | \tNigerian naira |\n| *NIO* | \tNicaraguan córdoba |\n| *NOK* | \tNorwegian krone |\n| *NPR* | \tNepalese rupee |\n| *NZD* | \tNew Zealand dollar |\n| *PAB* | \tPanamanian balboa |\n| *PEN* | \tPeruvian sol |\n| *PGK* | \tPapua New Guinean kina |\n| *PHP* | \tPhilippine peso[12] |\n| *PKR* | \tPakistani rupee |\n| *PLN* | \tPolish złoty |\n| *PYG* | \tParaguayan guaraní |\n| *QAR* | \tQatari riyal |\n| *RON* | \tRomanian leu |\n| *RSD* | \tSerbian dinar |\n| *RUB* | \tRussian ruble |\n| *RWF* | \tRwandan franc |\n| *SAR* | \tSaudi riyal |\n| *SBD* | \tSolomon Islands dollar |\n| *SCR* | \tSeychelles rupee |\n| *SEK* | \tSwedish krona/kronor |\n| *SGD* | \tSingapore dollar |\n| *SHP* | \tSaint Helena pound |\n| *SLL* | \tSierra Leonean leone |\n| *SOS* | \tSomali shilling |\n| *SRD* | \tSurinamese dollar |\n| *STD* | \tSouth Sudanese pound |\n| *SZL* | \tSwazi lilangeni |\n| *THB* | \tThai baht |\n| *TJS* | \tTajikistani somoni |\n| *TOP* | \tTongan paʻanga |\n| *TRY* | \tTurkish lira |\n| *TTD* | \tTrinidad and Tobago dollar |\n| *TWD* | \tNew Taiwan dollar |\n| *TZS* | \tTanzanian shilling |\n| *UAH* | \tUkrainian hryvnia |\n| *UGX* | \tUgandan shilling |\n| *UYU* | \tUruguayan peso |\n| *UZS* | \tUzbekistan som |\n| *VND* | \tVietnamese đồng |\n| *VUV* | \tVanuatu vatu |\n| *WST* | \tSamoan tala |\n| *XAF* | \tCFA franc BEAC |\n| *XCD* | \tEast Caribbean dollar |\n| *XOF* | \tCFA franc BCEAO |\n| *XPF* | \tCFP franc (franc Pacifique) |\n\n# Tabela tipos de paises e documentos cadastro de Customer\n\n| Country Code | Document Type | Group | Country | Meaning |\n| ---- | --------------- | ------------------ | ---------------------- | ----------------------------------------------------------------------------------- |\n| *AL* | *NIPT* | Vat | Albania | Vat Identifier (Numri i Identifikimit për Personin e Tatueshëm) |\n| *AD* | *NRT* | Tax | Andorra | Tax Identifier (Número de Registre Tributari) |\n| *AR* | *CBU* | Bank | Argentina | Bank Account (Clave Bancaria Uniforme) |\n| *AR* | *CUIT* | Tax | Argentina | Tax Identity (Código Único de Identificación Tributaria) |\n| *AR* | *DNI* | Person | Argentina | National Identity (Documento Nacional de Identidad) |\n| *AT* | *Businessid* | Company | Austria | Austrian Company Register Numbers |\n| *AT* | *TIN* | Tax | Austria | Austrian tax identification number (Abgabenkontonummer) |\n| *AT* | *UID* | VAT | Austria | Austrian VAT number (Umsatzsteuer-Identifikationsnummer) |\n| *AT* | *VNR* | Person | Austria | Austrian social security number(Versicherungsnummer) |\n| *AU* | *ABN* | Company | Australia | Australian Business Number |\n| *AU* | *ACN* | Company | Australia | Australian Company Number |\n| *AU* | *TFN* | Tax/Person/Company | Australia | Australian Tax File Number |\n| *BA* | *JMBG* | Person | Bosnia and Herzegovina | Unique Master Citizen Number |\n| *BZ* | *TIN* | Person/Company | Belize | Brazilian Tax ID () |\n| *BE* | *VAT* | Company | Belgium | Belgian Enterprise Number |\n| *BG* | *EGN* | Person | Bulgaria | ЕГН, Единен граждански номер, Bulgarian personal identity codes |\n| *BG* | *PNF* | Person | Bulgaria | PNF (ЛНЧ, Личен номер на чужденец, Bulgarian number of a foreigner). |\n| *BG* | *VAT* | Company | Bulgaria | Идентификационен номер по ДДС, Bulgarian VAT number |\n| *BR* | *CPF* | Person | Brazil | Brazilian identity number (Cadastro de Pessoas Físicas) |\n| *BR* | *CNPJ* | Company | Brazil | Brazilian company number (Cadastro Nacional da Pessoa Jurídica) |\n| *BY* | *UNP* | Person/Company | Belarus | Учетный номер плательщика, the Belarus VAT number |\n| *CA* | *BN* | Company | Canada | Company Identifier (Canadian Business Number) |\n| *CA* | *SIN* | Person | Canada | Person Identifier (Social Insurance Number) |\n| *CU* | *NI* | Person | Cuba | Número de identidad, Cuban identity card numbers |\n| *CY* | *VAT* | Company | Cyprus | Αριθμός Εγγραφής Φ.Π.Α. (Cypriot VAT number) |\n| *CZ* | *DIC* | Company | Czech Republic | Daňové identifikační číslo, Czech VAT number |\n| *CZ* | *RC* | Person | Czech Republic | Rodné číslo, the Czech birth number |\n| *CH* | *SSN* | Person | Swisserland | Swiss social security number (\"Sozialversicherungsnummer\") |\n| *CH* | *UID* | Company | Swisserland | Unternehmens-Identifikationsnummer, Swiss business identifier |\n| *CH* | *VAT* | Company | Swisserland | Mehrwertsteuernummer, the Swiss VAT number |\n| *CL* | *RUT* | Tax | Chile | Tax Identifier (Rol Unico Tributario) [RUN] |\n| *CN* | *RIC* | Person | China | Person Identifier (Chinese Resident Identity Card Number) |\n| *CN* | *USCC* | Company | China | Company Identifier (Unified Social Credit Code, 统一社会信用代码, China tax number) |\n| *CO* | *NIT* | Tax | Columbia | Tax Identifier (Número de Identificación Tributaria) |\n| *CR* | *CPF* | Person | Costa Rica | Person Identifier (Cédula de Persona Física) |\n| *CR* | *CPJ* | Company | Costa Rica | Company Identifier (Cédula de Persona Jurídica) |\n| *CR* | *CR* | Person | Costa Rica | Person Identifier (Cédula de Residencia) |\n| *DE* | *IDNR* | Person | Germany | Steuerliche Identifikationsnummer, German personal tax number |\n| *DE* | *STNR* | Company | Germany | Steuernummer, German tax number |\n| *DE* | *VAT* | Company | Germany | Vat identifier |\n| *DK* | *VAT* | Company | Denmark | Momsregistreringsnummer, Danish VAT number |\n| *DO* | *CEDULA* | Person | Dominican Republic | Person Identifier (Cédula de Residencia) |\n| *DO* | *NCF* | Vat | Dominican Republic | Tax Receipt Number (Números de Comprobante Fiscal) |\n| *DO* | *RNC* | Tax | Dominican Republic | Person Identifier (Registro Nacional del Contribuyente) |\n| *EC* | *CI* | Person | Ecuador | Ecuadorian person identifier (Cédula de identidad) |\n| *EE* | *IK* | Person | Estonia | Isikukood (Estonian Personcal ID number). |\n| *EE* | *KMKR* | Company | Estonia | KMKR (Käibemaksukohuslase, Estonian VAT number) |\n| *EE* | *Registrikood* | Company | Estonia | Registrikood (Estonian organisation registration code) |\n| *EC* | *RUC* | Tax/Vat | Ecuador | Ecuadorian company tax number (Registro Único de Contribuyentes) |\n| *SV* | *NIT* | Tax | El Salvador | Tax Identifier (Número de Identificación Tributaria) |\n| *GT* | *CUI* | Person | Guatemala | Guatemala person (Código Único de Identificación) |\n| *GT* | *NIT* | Company | Guatemala | Guatemala company tax number (Número de Identificación Tributaria) |\n| *FI* | *ALV* | Company | Finland | ALV nro (Arvonlisäveronumero, Finnish VAT number) |\n| *FI* | *HETU* | Person | Finland | HETU (Henkilötunnus, Finnish personal identity code) |\n| *FI* | *YTUNNUS* | Company | Finland | Y-tunnus (Finnish business identifier) |\n| *FR* | *NIF* | Person | France | NIF (Numéro d'Immatriculation Fiscale, French tax identification number) |\n| *GB* | *UTR* | Person | Great Brittan | UTR (United Kingdom Unique Taxpayer Reference) |\n| *GB* | *VAT* | Company | Great Brittan | VAT (United Kingdom (and Isle of Man) VAT registration number) |\n| *GR* | *AMKA* | Company | Greece | AMKA (Αριθμός Μητρώου Κοινωνικής Ασφάλισης, Greek social security number) |\n| *GR* | *VAT* | Company | Greece | FPA, ΦΠΑ, ΑΦΜ (Αριθμός Φορολογικού Μητρώου, the Greek VAT number) |\n| *FR* | *NIR* | Person | France | NIR (French personal identification number) |\n| *FR* | *SIREN* | Company | France | SIREN (a French company identification number) |\n| *FR* | *SIRET* | Company | France | SIRET (a French company establishment identification number) |\n| *FR* | *TVA* | Vat | France | VAT Identifier |\n| *HR* | *OIB* | Person | Croatia | Osobni identifikacijski broj, Croatian identification number |\n| *HK* | *HKID* | Person | Hong Kong | Hong Kong Identity Card |\n| *HU* | *ANUM* | Vat | Hungaria | ANUM (Közösségi adószám, Hungarian VAT number) |\n| *IS* | *KENNITALA* | Person/Company | Iceland | Icelandic personal and organisation identity code |\n| *IS* | *VSK* | Vat | Iceland | Virðisaukaskattsnúmer, Icelandic VAT number |\n| *ID* | *NPWP* | Person/Company | Indonesia | NPWP (Nomor Pokok Wajib Pajak, Indonesian VAT Number). |\n| *IE* | *PPS* | Person | Ireland | Personal Public Service Number, Irish personal number |\n| *IE* | *VAT* | Tax/Vat | Ireland | Ireland Value Added Tax ID |\n| *IN* | *AADHAAR* | Company | India | Indian digital resident personal identity number |\n| *IN* | *PAN* | Person | India | Permanent Account Number, Indian income tax identifier |\n| *IL* | *IDNR* | Person | Israel | Identity Number (Mispar Zehut, מספר זהות, Israeli identity number) |\n| *IL* | *HR* | Company | Israel | Company Number (מספר חברה, or short ח.פ. Israeli company number) |\n| *IT* | *AIC* | Drug | Italy | Italian code for identification of drugs |\n| *IT* | *CODICEFISCALE* | Person | Italy | Codice Fiscale (Italian tax code for individuals) |\n| *IT* | *IVA* | Vat | Italy | Partita IVA (Italian VAT number) |\n| *LI* | *PEID* | Person/Company | Liechtenstein | Personenidentifikationsnummer |\n| *LT* | *ASMENS* | Person | Lithuanian | Asmens kodas (Person Number) |\n| *LT* | *PVM* | Vat | Lithuanian | Pridėtinės vertės mokestis mokėtojo kodas |\n| *LU* | *TVA* | Vat | Luxembourgian | taxe sur la valeur ajoutée |\n| *LV* | *PVN* | Person/Vat | Latvian | Pievienotās vērtības nodokļa |\n| *MK* | *JMBG* | Person | Macedonia | Unique Master Citizen Number (Единствен матичен број на граѓанинот) |\n| *MC* | *TVA* | Vat | Monaco | taxe sur la valeur ajoutée, Monacan VAT number |\n| *MD* | *IDNO* | Vat | Moldavia | Moldavian VAT number |\n| *MT* | *VAT* | Vat | Malta | Maltese VAT number |\n| *MU* | *NID* | Person | Mauritius | ID number (Mauritian national identifier) |\n| *JP* | *CN* | Company | Japan | 法人番号, hōjin bangō, Japanese Corporate Number |\n| *KR* | *BRN* | Company | South Korea | 사업자 등록 번호, South Korea Business Registration Number) |\n| *KR* | *RRN* | Person | South Korea | South Korean resident registration number |\n| *MX* | *RFC* | Tax/Vat | Mexico | Tax Identifier (Registro Federal de Contribuyentes) |\n| *MX* | *CURP* | Person | Mexico | Individual Identifier (Clave Única de Registro de Población) |\n| *MX* | *CLABE* | Bank | Mexico | Bank Account (Clave Bancaria Estandarizada) |\n| *ME* | *JMBG* | Person | Montenegro | Unique Master Citizen Number |\n| *MY* | *NRIC* | Person | Malaysia | Malaysian National Registration Identity Card Number |\n| *NL* | *BSN* | Person | Netherlands | Burgerservicenummer, the Dutch citizen identification number |\n| *NL* | *BTW* | Vat | Netherlands | Btw-identificatienummer (Omzetbelastingnummer, the Dutch VAT number) |\n| *NL* | *Onderwijsnummer* | Person | Netherlands | Onderwijsnummer (the Dutch student identification number) |\n| *NZ* | *IRD* | Person/Company | New Zealand | New Zealand Inland Revenue Department (Te Tari Tāke) number |\n| *NZ* | *BANK* | Bank | New Zealand | New Zealand Bank Account numbers - checkdigit |\n| *NO* | *Fodsels* | Person | Norway | Fødselsnummer (Norwegian birth number, the national identity number) |\n| *NO* | *Konto* | Bank | Norway | Konto nr. (Norwegian bank account number) |\n| *NO* | *MVA* | Vat | Norway | Merverdiavgift, Norwegian VAT number |\n| *NO* | *Orgnr* | Company | Norway | Organisasjonsnummer, Norwegian organisation number |\n| *PY* | *RUC* | Tax/Vat | Paraguay | Tax Identifier (Registro Único de Contribuyentes) |\n| *PE* | *CUI* | Person | Peru | Person Identifier (Cédula Única de Identidad) |\n| *PE* | *RUC* | Tax/Vat | Peru | Tax Identifier (Registro Único de Contribuyentes) |\n| *PE* | *CE* | Person | Peru | Person Identifier (Carné de Extranjería) |\n| *PK* | *CNIC* | Person | Pakistan | National Identity Card |\n| *PK* | *NTN* | Company | Pakistan | Tax Identification Number |\n| *PL* | *NIP* | Vat | Poland | Numer Identyfikacji Podatkowej, Polish VAT number |\n| *PL* | *PESEL* | Person | Poland | Polish national identification number |\n| *PL* | *REGON* | Company | Poland | Rejestr Gospodarki Narodowej, Polish register of economic units |\n| *PT* | *NIF* | Vat | Portugual | Número de identificação fiscal, Portuguese VAT number |\n| *RU* | *INN* | Tax/Vat | Russia | Tax Identifier (Идентификационный номер налогоплательщика) |\n| *RO* | *CF* | Vat | Romania | Cod de înregistrare în scopuri de TVA, Romanian VAT number |\n| *RO* | *CNP* | Person | Romania | Cod Numeric Personal, Romanian Numerical Personal Code) |\n| *RO* | *CUI* | Tax | Romania | Codul Unic de Înregistrare, Romanian company identifier |\n| *RO* | *ONRC* | Company | Romania | Ordine din Registrul Comerţului, Romanian Trade Register identifier |\n| *SM* | *COE* | Company | San Marcos | Codice operatore economico, San Marino national tax number |\n| *RS* | *PIB* | Vat | Serbia | Poreski identifikacioni broj Tax identification number |\n| *RS* | *JMBG* | Person | Serbia | Unique Master Citizen Number (Jedinstveni matični broj građana) |\n| *SE* | *ORGNR* | Company | Sweden | Organisationsnummer, Swedish company number |\n| *SE* | *PERSONNUMMER* | Person | Sweden | Personnummer (Swedish personal identity number) |\n| *SE* | *VAT* | Vat | Sweden | VAT (Moms, Mervärdesskatt, Swedish VAT number) |\n| *SG* | *UEN* | Company | Singapore | Singapore's Unique Entity Number |\n| *TH* | *IDNR* | Person | Thailand | Thai National ID (บัตรประจำตัวประชาชนไทย) |\n| *TW* | *UBN* | Company | Taiwan | Unified Business Number, 統一編號, Taiwanese tax number |\n| *TR* | *TCKIMLIK* | Person | Turkey | Türkiye Cumhuriyeti Kimlik Numarası (Personal ID) |\n| *TR* | *VKN* | Tax | Turkey | Vergi Kimlik Numarası, Turkish tax identification number |\n| *SI* | *DDV* | Vatl | Slovenia | ID za DDV (Davčna številka, Slovenian VAT number) |\n| *SI* | *JMBG* | Person | Slovenia | Unique Master Citizen Number (Enotna matična številka občana) |\n| *SK* | *DPH* | Vat | Slovakia | IČ DPH (IČ pre daň z pridanej hodnoty, Slovak VAT number) |\n| *SK* | *RC* | Person | Slovakia | RČ (Rodné číslo, the Slovak birth number) |\n| *ES* | *CIF* | Tax/Vat | Spain | Tax Identifier (Código de Identificación Fiscal) |\n| *ES* | *DNI* | Person | Spain | Identity code (Documento Nacional de Identidad) |\n| *ES* | *NIE* | Person | Spain | Identity code foreigner (Número de Identificación de Extranjero) |\n| *ES* | *NIF* | Tax | Spain | Tax Identifier (Número de Identificación Fiscal) |\n| *UY* | *RUT* | Tax/Vat | Uruguay | Tax Identifier (Registro Único Tributario) |\n| *UY* | *CEDULA* | Person | Uruguay | Person Identifier (Cédula de Residencia) |\n| *UY* | *NIE* | Person | Uruguay | ForeignersI identification Number |\n| *UA* | *RNTRC* | Person | Ukraine | КПП, RNTRC (Individual taxpayer registration number in Ukraine) |\n| *UA* | *EDRPOU* | Company | Ukraine | ЄДРПОУ, EDRPOU (Identifier for enterprises and organizations in Ukraine) |\n| *US* | *EIN* | Tax/Company | United States | Tax Identifier (Employer Identification Number) |\n| *US* | *SSN* | Tax/Individual | United States | Tax Identifier (Social Security Number) |\n| *VE* | *RIF* | Vat | Venezuelan | Vat Identifier (Registro de Identificación Fiscal) |\n| *VN* | *MST* | Company | Vietnam | Mã số thuế, Vietnam tax number |\n| *ZA* | *IDNR* | Person | South Africa | ID number (South African Identity Document number). |\n| *ZA* | *TIN* | Person/Company | South Africa | TIN (South African Tax Identification Number). \n| | *noDocument* | Document number | | The document number is not provided\n\n# Tabela códigos dos principais bancos\n\n| Código | Banco |\n| ----- |----------------------- |\n| **001** | Banco do Brasil S.A. |\n| *033* | \tBanco Santander (Brasil) S.A. |\n| *104* | \tCaixa Econômica Federal |\n| *237* | \tBanco Bradesco S.A. |\n| *260* | \tNubank |\n| *341* | \tBanco Itaú S.A. |\n| *356* | Banco Real S.A. (antigo) |\n| *389* | Banco Mercantil do Brasil S.A. |\n| *399* | HSBC Bank Brasil S.A. – Banco Múltiplo |\n| *422* | Banco Safra S.A. |\n| *453* | Banco Rural S.A. |\n| *633* | Banco Rendimento S.A. |\n| *652* | Itaú Unibanco Holding S.A. |\n| *745* | Banco Citibank S.A. |\n" paths: /v1/charges: post: tags: - Charges summary: Realizar nova cobrança operationId: charge requestBody: content: application/json: schema: $ref: '#/components/schemas/ChargeRequest' examples: ChargeCardExample: $ref: '#/components/examples/ChargeCardRequest' ChargePixExample: $ref: '#/components/examples/ChargePixRequest' ChargeBoletoExample: $ref: '#/components/examples/ChargeBoletoRequest' ChargeSplitExample: $ref: '#/components/examples/ChargeSplitRequest' ChargeSplitPixExample: $ref: '#/components/examples/ChargeSplitRequestPix' ChargeSplitBoletoExample: $ref: '#/components/examples/ChargeSplitRequestBoleto' ChargeVendorExample: $ref: '#/components/examples/ChargeVendorExample' Charge3DS2Example: $ref: '#/components/examples/Charge3DS2Request' Charge3DSMPIExterno: $ref: '#/components/examples/Charge3DSMPIExterno' Charge3DSMalgaExample: $ref: '#/components/examples/Charge3DSMalgaRequest' ChargeNupayExample: $ref: '#/components/examples/ChargeNupayRequest' ChargePicpayExample: $ref: '#/components/examples/ChargePicpayRequest' ChargeDripExample: $ref: '#/components/examples/ChargeDripRequest' ChargeVoucherExample: $ref: '#/components/examples/ChargeVoucherRequest' ChargeApplePayCardExample: $ref: '#/components/examples/ChargeApplePayRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/Charge' examples: ChargeCard: $ref: '#/components/examples/ChargeCard' ChargePix: $ref: '#/components/examples/ChargePix' ChargeBoleto: $ref: '#/components/examples/ChargeBoleto' ChargeSplit: $ref: '#/components/examples/ChargeSplit' ChargeSplitPix: $ref: '#/components/examples/ChargeSplitPix' ChargeSplitBoleto: $ref: '#/components/examples/ChargeSplitBoleto' ChargeCard3DSecure2: $ref: '#/components/examples/ChargeCard3DSecure2' ChargeCard3DSMalga: $ref: '#/components/examples/ChargeCard3DSMalga' ChargeNupay: $ref: '#/components/examples/ChargeNupay' ChargePicpay: $ref: '#/components/examples/ChargePicpay' ChargeDrip: $ref: '#/components/examples/ChargeDrip' ChargeVoucher: $ref: '#/components/examples/ChargeVoucher' ChargeApplePayResponse: $ref: '#/components/examples/ChargeApplePayResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: ChargeRequest: properties: merchantId: type: string format: uuid description: Identificação do merchant id a ser utilizado amount: type: number description: Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 currency: type: string description: >- Identificador da moeda para processamento da cobrança, formato ISO 4217. default: BRL statementDescriptor: type: string description: Descrição a ser exibida fatura do comprador capture: type: boolean description: Determina se a transação deve ser capturada automaticamente default: false orderId: type: string description: >- Identificador único da cobrança do lado do cliente para conciliação futura description: type: string description: Descrição da cobrança para consulta futura customerId: type: string format: uuid description: Identificador de comprador para consulta futura paymentMethod: description: Define o método de cobrança oneOf: - $ref: '#/components/schemas/PaymentMethodCard' - $ref: '#/components/schemas/PaymentMethodPix' - $ref: '#/components/schemas/PaymentMethodBoleto' - $ref: '#/components/schemas/PaymentMethodNuPay' - $ref: '#/components/schemas/PaymentMethodDrip' - $ref: '#/components/schemas/PaymentMethodVoucher' - $ref: '#/components/schemas/PaymentMethodPicpay' - $ref: '#/components/schemas/PaymentMethodApplePay' - $ref: '#/components/schemas/PaymentMethodClickToPay' paymentSource: oneOf: - $ref: '#/components/schemas/SourceTypeCard' - $ref: '#/components/schemas/SourceTypeCardOneShot' - $ref: '#/components/schemas/SourceTypeToken' - $ref: '#/components/schemas/SourceTypeCustomer' - $ref: '#/components/schemas/SourceTypeCustomerData' - $ref: '#/components/schemas/SourceTypeCardCvv' - $ref: '#/components/schemas/SourceTypeApplePay' - $ref: '#/components/schemas/SourceTypeClickToPay' fraudAnalysis: description: >- Parâmetros adicionais para análise de fraude, necessários para processamento com provedores específicos allOf: - $ref: '#/components/schemas/FraudAnalysisRequest' splitRules: description: Parâmetros adicionais para transacionar com `Split` type: array items: $ref: '#/components/schemas/SplitRule' vendor: allOf: - $ref: '#/components/schemas/VendorCharge' paymentFlow: type: object description: Campos adicionais para uso em condicionais dos fluxos inteligentes properties: metadata: type: object description: Campos adicionais da transação enviados na criação da mesma required: - metadata threeDSecure2: type: object description: Parâmetros adicionais para transacionar com 3D Secure 2 allOf: - $ref: '#/components/schemas/3DSecure2Request' appInfo: type: object description: Informações sobre a rastreabilidade da cobrança allOf: - $ref: '#/components/schemas/AppInfoObject' required: - amount - merchantId - paymentMethod - paymentSource Charge: properties: id: type: string description: identificador da transação clientId: type: string format: uuid description: identificador do cliente na Malga merchantId: type: string format: uuid description: identificador do merchant id utilizado na transação customerId: type: string format: uuid description: identificador do customer id description: type: string description: Descrição da cobrança para consulta futura amount: type: number description: valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 originalAmount: type: number description: valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 currency: type: string description: >- Identificador da moeda para processamento da cobrança, formato ISO 4217. default: BRL statementDescriptor: type: string description: descrição a ser exibida na fatura do comprador capture: type: boolean description: determina se a transação deve ser capturada automaticamente isDispute: type: boolean description: determina se a transação está em disputa status: type: string description: status da transação na Malga enum: - pending - pre_authorized - authorized - failed - canceled - voided - charged_back - refund_pending - capture_pending orderId: type: string description: >- Identificador único da cobrança do lado do cliente para conciliação futura responsibleProviderType: type: string description: Nome do provedor de pagamento responsável pela transação paymentMethod: oneOf: - $ref: '#/components/schemas/PaymentMethodCardObject' - $ref: '#/components/schemas/PaymentMethodPixObject' - $ref: '#/components/schemas/PaymentMethodBoletoObject' - $ref: '#/components/schemas/PaymentMethodNuPayObject' - $ref: '#/components/schemas/PaymentMethodDripObject' - $ref: '#/components/schemas/PaymentMethodVoucherObject' - $ref: '#/components/schemas/PaymentMethodApplePayObject' paymentSource: oneOf: - $ref: '#/components/schemas/SourceTypeCardObject' - $ref: '#/components/schemas/SourceTypeTokenObject' - $ref: '#/components/schemas/SourceTypeCustomerObject' - $ref: '#/components/schemas/SourceTypeWalletObject' createdAt: type: string description: Data de criação do cartão updatedAt: type: string description: Data de atualização do cartão fraudAnalysisMetadata: description: Parâmetros adicionais para analise de fraude allOf: - $ref: '#/components/schemas/FraudAnalysisMetadata' paymentFlow: type: object description: Campos adicionais para uso em condicionais dos fluxos inteligentes properties: metadata: type: object description: Campos adicionais da transação enviados na criação da mesma required: - metadata transactionRequests: type: array items: $ref: '#/components/schemas/TransactionRequest' threeDSecure2: type: object allOf: - $ref: '#/components/schemas/3DSecure2Response' appInfo: type: object description: Informações sobre a rastreabilidade da cobrança allOf: - $ref: '#/components/schemas/AppInfoObject' splitRules: type: array description: Parâmetros adicionais para transacionar com `Split` items: $ref: '#/components/schemas/ChargeSplitRules' ErrorResponse: properties: error: type: object allOf: - $ref: '#/components/schemas/ErrorItem' PaymentMethodCard: type: object title: Cartão properties: paymentType: type: string enum: - credit - voucher description: Método da cobrança via Cartão Crédito/Débito/Voucher installments: type: number description: Quantidade de parcelas para cobrança do tipo credito recurrence: type: string enum: - initial - subsequent - unscheduled description: >- Indica se a transação é recorrente. Pode assumir o valor `initial` (primeira transação recorrente), `subsequent` (transação recorrente que não é a primeira) ou `unscheduled` (cobrança avulsa dentro de contexto de assinatura recorrente para ajustar débitos). required: - paymentType PaymentMethodPix: title: Pix properties: paymentType: type: string enum: - pix description: Método da cobrança via PIX, o source deve ser um customer válido expiresIn: type: number description: Tempo em segundos que define a validade da cobrança additionalInfo: type: array description: Informações adicionais sobre o pagamento items: $ref: '#/components/schemas/PixAdditionalInfo' items: type: array description: Informações sobre itens que estão sendo pagos items: $ref: '#/components/schemas/PixItem' required: - paymentType - expiresIn PaymentMethodBoleto: title: Boleto properties: paymentType: type: string enum: - boleto description: Método da cobrança via Boleto, o source deve ser um customer válido expiresDate: type: string description: Data de vencimento do boleto em ISO-Date, ex 2017-01-31 default: 7 dias contados da data atual instructions: type: string description: >- Campo instruções do boleto. Máximo de 255 caracteres. Obs. Utilizar \n para quebra de linha interest: type: object description: Informações opcionais da condição de juros para pagamento em atraso properties: days: type: integer description: Dias após a expiração do boleto quando o juros deve ser cobrado. amount: type: integer description: Valor em centavos da taxa de juros que será cobrado ao dia. percentage: type: number description: Valor em porcentagem da taxa de juros que será cobrado ao mês. fine: type: object description: Informações opcionais da condição de multa para pagamento em atraso properties: days: type: integer description: Dias após a expiração do boleto quando a multa deve ser cobrada. amount: type: integer description: Valor em centavos da multa. percentage: type: number description: Valor em porcentagem da multa. items: type: object description: Informações dos itens de pedido properties: id: type: string description: Identificador do item title: type: string description: Descrição do item unitPrice: type: integer description: Valor unitário do item. quantity: type: integer description: Quantidade do item required: - paymentType PaymentMethodNuPay: title: NuPay type: object properties: paymentType: type: string enum: - nupay description: método da cobrança via NuPay delayToAutoCancel: type: integer default: 30 description: >- tempo em minutos para a expiração de uma cobrança criada que não tenha sido paga orderUrl: type: string description: URL da cobrança returnUrl: type: string description: >- URL para a qual o cliente será redirecionado após finalizar o pagamento cancelUrl: type: string description: >- URL para onde o cliente será direcionado caso escolha não finalizar o pagamento e cancele o pedido taxValue: type: integer description: montante do total de taxas aplicadas em centavos required: - paymentType PaymentMethodDrip: type: object title: Drip properties: paymentType: type: string enum: - drip description: método da cobrança via Drip maxInstallments: type: number description: Quantidade de parcelas máxima a serem pagos com a Drip browser: description: informações sobre o navegador do usuário allOf: - $ref: '#/components/schemas/DripBrowser' items: type: array description: Informações sobre itens que estão sendo pagos items: $ref: '#/components/schemas/DripItem' cancelRedirectUrl: type: string description: >- Link de redirecionamento em caso de cancelamento do pagamento no ambiente de checkout da Drip successRedirectUrl: type: string description: >- Link de redirecionamento em caso de aprovação do pagamento no ambiente de checkout da Drip firstInstallmentsDate: type: string description: Data para realizar o pagamento da primeira parcela totalInstallments: type: number description: Número total de parcelas para o pagamento finePercentage: type: number description: Porcentagem da multa interestPercentage: type: number description: Porcentagem do juros cancellationFeePercentage: type: number description: Porcentagem para a taxa de cancelamento minutesToExpire: type: integer description: Tempo em minutos para expiração da transação após sua criação required: - paymentType PaymentMethodVoucher: title: Voucher type: object properties: paymentType: type: string enum: - voucher description: método da cobrança via Voucher items: type: array description: Informações sobre itens do pedido items: $ref: '#/components/schemas/VoucherItem' customer: type: object description: Informações sobre o cliente allOf: - $ref: '#/components/schemas/VoucherCustomer' required: - paymentType PaymentMethodPicpay: type: object title: Picpay properties: paymentType: type: string enum: - picpay description: método da cobrança via Picpay required: - paymentType PaymentMethodApplePay: title: Apple Pay type: object properties: paymentType: type: string enum: - apple_pay description: Método da cobrança via Apple Pay installments: type: number description: Quantidade de parcelas para cobrança do tipo Apple Pay crédito required: - paymentType PaymentMethodClickToPay: title: Click to Pay type: object properties: paymentType: type: string enum: - click_to_pay description: Método da cobrança via Click to Pay installments: type: number description: Quantidade de parcelas para cobrança do tipo Click to Pay required: - paymentType SourceTypeCard: title: Cartão tokenizado type: object description: Dados para cobrança por cartão de crédito salve properties: sourceType: type: string description: >- Tipo da origem da cobrança, usar `card` para cobrança em cartão tokenizado enum: - card cardId: type: string format: uuid description: Identificador do cartão quando source tipo card cardCvv: type: string description: >- Código de verificação cobrança sem tokenização, deve ser enviado sempre que o comprador estiver presente no momento da compra (opcional) required: - sourceType - cardId SourceTypeCardOneShot: title: Cartão one shot type: object description: dados do cartão para cobrança direta properties: sourceType: type: string description: >- tipo da origem da cobrança, usar `card` para cobrança direta no cartão enum: - card card: type: object properties: cardHolderName: type: string description: Nome do portador do cartão quando cobrança sem tokenização cardNumber: type: string description: Número do cartão quando cobrança sem tokenização cardCvv: type: string description: Código de verificação cobrança sem tokenização cardExpirationDate: type: string description: >- Mês e ano de validade no formato MM/YYYY quando cobrança sem tokenização required: - sourceType - cardHolderName - cardNumber - cardCvv - cardExpirationDate SourceTypeToken: title: Token type: object description: dados para cobrança única de token de cartão properties: sourceType: type: string description: >- tipo da origem da cobrança, usar `token` para cobrança no token gerado enum: - token tokenId: type: string format: uuid description: Identificador do token quando source tipo token (opcional) required: - sourceType - tokenId SourceTypeCustomer: title: Cartão com Customer salvo type: object description: identificador do comprador para cobrança properties: sourceType: type: string description: >- tipo da origem da cobrança, usar `customer` para cobrança no cartão default do comprador enum: - customer customerId: type: string format: uuid description: >- Identificador do cliente quando source tipo customer, debitando o cartão default do comprador cardCvv: type: string description: >- Código de verificação cobrança sem tokenização, deve ser enviado sempre que o comprador estiver presente no momento da compra (opcional) required: - sourceType - customerId SourceTypeCustomerData: title: Pagamentos com dados de Customer type: object description: dados do customer para cobrança via Cartão, Pix ou Boleto properties: sourceType: type: string description: >- tipo da origem da cobrança, usar `customer` para cobrança via Cartão, Pix ou Boleto enum: - customer customer: type: object properties: name: type: string description: nome do usuario email: type: string description: email do usuario phoneNumber: type: string description: telefone de contato do usuario document: allOf: - $ref: '#/components/schemas/Document' address: allOf: - $ref: '#/components/schemas/Address' required: - email - phoneNumber - document required: - sourceType - customer SourceTypeCardCvv: title: Cartão com tokenCvv type: object description: Dados para cobrança por cartão de crédito passando o tokenCvv properties: sourceType: type: string description: >- Tipo da origem da cobrança, usar `card` para cobrança em cartão tokenizado enum: - card cardId: type: string format: uuid description: Identificador do cartão quando source tipo card (opcional) tokenCvv: type: string description: Código de verificação da tokenização do cvv do cartão required: - sourceType - cardId - tokenCvv SourceTypeApplePay: title: Apple Pay type: object description: dados para cobrança por Apple Pay properties: sourceType: type: string description: Origem da cobrança, usar "wallet" para cobrança com carteiras enum: - wallet walletPayment: type: string description: Tipo de pagamento, usar `credit` para cobrança por cartão de crédito enum: - credit paymentData: type: object description: Dados do pagamento disponibilizados pela carteira digital properties: data: type: string description: Base64 com os dados do pagamento criptografados signature: type: string description: Assinatura do pagamento header: type: object description: Cabeçalho do pagamento properties: ephemeralPublicKey: type: string description: Ephemeral Public Key version: type: string description: Versão dos tokens de pagamento SourceTypeClickToPay: title: Click to Pay type: object description: dados do Click to Pay properties: sourceType: type: string description: >- tipo da origem da cobrança, usar `click_to_pay` para cobrança via Click to Pay enum: - wallet walletPayment: type: string description: Tipo de pagamento, usar `credit` para cobrança por cartão de crédito enum: - credit walletClickToPay: type: object description: Informações sobre o Click to Pay obtidas pelo SDK da Mastercard properties: dpaId: type: string description: Identificador do Click to Pay correlationId: type: string description: Identificador da correlação do Click to Pay flowId: type: string description: Identificador do fluxo do Click to Pay merchantTransactionId: type: string description: Identificador da transação do Click to Pay required: - sourceType - walletPayment - walletClickToPay FraudAnalysisRequest: properties: sla: type: number description: Valor em Minutos de SLA máximo de Análise do Pedido, se houver customer: description: Dados do comprador type: object properties: name: type: string description: nome do usuario email: type: string description: email do usuario phone: type: string description: telefone de contato do usuario identityType: type: string description: Tipo de documento, consultar tabela de tipos suportados identity: type: string description: Número do documento formato conforme tipo selecionado maritalStatus: type: string description: Estado civil do usuario education: type: string description: Nível de escolaridade do usuario registrationDate: type: string description: Data de registro do cliente deliveryAddress: description: Endereço de entrega allOf: - $ref: '#/components/schemas/FraudAnalysisAddress' billingAddress: description: Endereço de cobrança allOf: - $ref: '#/components/schemas/FraudAnalysisAddress' browser: description: Informações sobre o navegador do usuário allOf: - $ref: '#/components/schemas/FraudAnalysisCustomerBrowser' mfa: description: Dados de Multi factor authentication type: object properties: smsOtpUsed: type: boolean description: Usuario utilizou OTP via SMS emailOtpUsed: type: boolean description: Usuario utilizou OTP via email cart: description: Detalhe do carrinho de produtos type: object properties: items: type: array items: type: object properties: name: type: string description: nome do item/evento quantity: type: integer description: quantidade de itens do pedido sku: type: string description: identificador único do item na loja unitPrice: type: integer description: valor unitário do item/evento em centavos risk: type: string description: definição do indice de risco do item enum: - High - Low description: type: string description: Descrição do item/evento categoryId: type: string description: Categoria a qual o item/evento pertence locality: type: string description: Definição de local, em caso de evento date: type: string description: Definição de data, em caso de evento type: type: number description: Definição de tipo, em caso de evento genre: type: string description: Definição de gênero, em caso de evento tickets: type: object description: Informações relacionadas aos ingressos, em caso de evento properties: quantityTicketSale: type: number description: Quantidade total de ingressos à venda quantityEventHouse: type: number description: >- Quantidade de vezes que o evento será realizado na casa convenienceFeeValue: type: number description: Taxa de Conveniência quantityFull: type: number description: Quantidade de ingressos com valor integral quantityHalf: type: number description: Quantidade de ingresso com desconto (meia entrada) batch: type: number description: Lote do Ingresso location: description: Definição de endereço, em caso de evento allOf: - $ref: '#/components/schemas/FraudAnalysisAddress' device: description: Detalhes do aparelho do consumidor type: object properties: id: type: string description: id do dispositivo sessionId: type: string description: ID da sessão os: type: object properties: type: type: string description: tipo do sistema operacional version: type: string description: versão do sistema operacional model: type: string description: modelo do aparelho ramCapacity: type: integer description: capacidade da memória RAM do aparelho diskCapacity: type: integer description: capacidade de armazenamento do aparelho freeDiskSpace: type: integer description: quantidade de memória livre resolution: type: integer description: resolução do aparelho vendors: type: array items: type: object properties: name: type: string description: name do atributo do fornecedor value: type: string description: valor do atributo do fornecedor vendorAttributes: description: atributos do aparelho fornecidos pelo fornecedor type: object properties: flash: type: boolean description: aparelho possui flash phoneCalls: type: boolean description: aparelho pode realizar chamadas sendSms: type: boolean description: aparelho pode enviar sms videoCamera: type: boolean description: aparelho possui camera de video cpuCount: type: integer description: quantidade de cpus simulator: type: boolean description: aparelho possui simulador language: type: string description: lingua do aparelho idiom: type: string description: idioma do aparelho platform: type: string description: plataforma do sistema name: type: string description: nome do aparelho family: type: string description: família do aparelho retinaDisplay: type: boolean description: aparelho possui display de retina camera: type: boolean description: aparelho possui camera model: type: string description: modelo do aparelho frontCamera: type: boolean description: aparelho possui camera frontal airline: description: Detalhes da reserva de passagem aérea type: object properties: passengers: type: array description: Informações sobre os passageiros items: type: object properties: name: type: string description: Nome do passageiro companyMileCard: type: string description: Cartão de Milhas da empresa mileCard: type: string description: Cartão de Milhas identityType: type: string description: Tipo de identidade identityNumber: type: string description: Número de identidade gender: type: string description: Gênero do passageiro enum: - male - female birthdate: type: string description: Data de nascimento do passageiro connections: type: array description: Detalhes das conexões de voo items: type: object properties: company: type: string description: Companhia aérea identificationNumber: type: integer description: Número de identificação do voo date: type: string description: Data do voo seatClass: type: string description: Classe do assento origin: type: string description: Aeroporto de origem destination: type: string description: Aeroporto de destino boarding: type: string description: Data de embarque arriving: type: string description: Data de chegada fareClass: type: string description: Classe tarifária reservation: type: string description: Data da reserva de passagem aérea orderOrigin: type: string description: Origem do pedido enum: - app - web - telesales - social_network - other operationalSystem: type: string description: Tipo de sistema operacional do cliente marketplaceType: type: string description: Tipo de mercado enum: - b2b - b2c purchaseInformation: type: object description: Informações sobre o canal de compra properties: lastDateInsertedMail: type: string description: Última data de inserção de e-mail lastDateChangePassword: type: string description: Última data de alteração de senha lastDateChangePhone: type: string description: Última data de alteração de telefone lastDateChangeMobilePhone: type: string description: Última data de alteração de telefone móvel lastDateInsertedAddress: type: string description: Última data de inserção de endereço purchaseLogged: type: boolean description: Indica se a compra foi registrada email: type: string description: Endereço de e-mail do comprador login: type: string description: Nome de usuário do comprador socialNetwork: type: object description: Informações da rede social do comprador properties: optInCompreConfie: type: boolean description: Opt-in para Compre Confie socialNetworkType: type: string description: Tipo de rede social enum: - facebook - twitter - linkedin - google - other authenticationToken: type: string description: Token de autenticação giftList: type: object description: Lista de presentes properties: type: type: string description: Tipo de lista enum: - wishlist - wedding_list - birthday_list - other id: type: string description: Identificador da lista de presentes hotels: type: array description: Informações sobre reservas de hotéis items: type: object properties: name: type: string description: Nome do hotel city: type: string description: Cidade do hotel state: type: string description: Estado do hotel country: type: string description: País do hotel reservationDate: type: string description: Data da reserva reserveExpirationDate: type: string description: Data de expiração da reserva checkInDate: type: string description: Data de check-in checkOutDate: type: string description: Data de check-out SplitRule: type: object properties: sellerId: type: string format: uuid description: >- Identificador do recebedor já cadastrado na API de [sellers](/api-reference/sellers/criacao-de-um-novo-recebedor). example: 5323ece6-816d-11ed-a1eb-0242ac120002 percentage: type: integer minimum: 1 maximum: 100 description: >- Campo condicional. Percentual do valor da transação que será enviado ao recebedor. Envie exatamente um dos campos, `percentage` ou `amount`, nunca ambos. example: 70 amount: type: integer minimum: 1 description: >- Campo condicional. Valor em centavos que será enviado ao recebedor. Envie exatamente um dos campos, `amount` ou `percentage`, nunca ambos. example: 5000 processingFee: type: boolean description: >- Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação. example: false chargeEntireFee: type: boolean description: >- Indica se o recebedor será cobrado pela taxa inteira da transação. Não pode ser verdadeiro junto com `chargeRemainderFee`. example: false chargeRemainderFee: type: boolean description: Indica se o recebedor será cobrado pela taxa restante da transação. example: false liable: type: boolean description: >- Indica se o recebedor atrelado assumirá os riscos de chargeback da transação. example: true transactionOwner: type: boolean description: Indica se o recebedor é o responsável pela transação. example: true fares: type: object description: Informações sobre as taxas que serão cobradas do recebedor. properties: mdr: type: number minimum: 0 description: Percentual de MDR que será aplicado ao recebedor. example: 2.5 fee: type: number minimum: 0 description: Taxa fixa que será aplicada ao recebedor. example: 0.3 required: - sellerId VendorCharge: type: object description: Parâmetros adicionais para transacionar com `vendors` properties: id: type: string format: uuid description: >- identificador do vendedor já cadastrado na API de [vendors](/api-reference/vendors/criacao-de-um-novo-vendedor) paymentFacilitatorId: type: string description: >- Seu código de Subadquirente na respectiva bandeira. [Verifique a lista de provedores suportados](/documentations/vendors/provedores) nullable: true required: - id - paymentFacilitatorId 3DSecure2Request: type: object properties: setupId: type: string description: >- Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga dataOnly: type: boolean description: Quando true, apenas coleta os dados 3DS sem realizar a autenticação requiresLiabilityShift: type: boolean description: Indica a ocorrência de mudança de responsabilidade redirectURL: type: string description: >- URL para redirecionamento de autenticação. Este campo não é obrigatório caso o objeto MPI seja enviado. requestorURL: type: string description: >- URL de origem da requisição. Este campo não é obrigatório caso o objeto MPI seja enviado. browser: description: >- Informações sobre o navegador do usuário. Este campo não é obrigatório caso o objeto MPI seja enviado. allOf: - $ref: '#/components/schemas/3DSecure2browser' billingAddress: description: Endereço de cobrança allOf: - $ref: '#/components/schemas/3DSecure2BillingAddress' shippingAddress: description: Endereço para envio allOf: - $ref: '#/components/schemas/3DSecure2ShippingAddress' cardHolder: description: Dados do portador do cartão allOf: - $ref: '#/components/schemas/3DSecure2CardHolder' mpi: description: Campo usado para autenticação com mpi externa allOf: - $ref: '#/components/schemas/3DSecure2MPI' required: - redirectURL - requestorURL - browser AppInfoObject: properties: platform: description: Informações sobre produto das transações (checkout-sdk, vtex, etc..) allOf: - $ref: '#/components/schemas/AppInfoPlatform' device: description: Informações sobre o dispositivo (ios, android, windows, linux) allOf: - $ref: '#/components/schemas/AppInfoDevice' system: description: Informações sobre o sistema proprietário de captura do merchant allOf: - $ref: '#/components/schemas/AppInfoSystem' PaymentMethodCardObject: title: Cartão de crédito type: object properties: paymentType: type: string enum: - credit - debit description: método da cobrança via Cartão Crédito/Débito installments: type: number description: quantidade de parcelas para cobrança do tipo credito recurrence: type: string enum: - initial - subsequent - unscheduled description: >- indica se a transação é recorrente. Pode assumir o valor `initial` (primeira transação recorrente), `subsequent` (transação recorrente que não é a primeira) ou `unscheduled` (cobrança avulsa dentro de contexto de assinatura recorrente para ajustar débitos). threeDS: type: object description: Informações sobre o 3DS2 properties: enabled: type: boolean description: Indica se o 3DS2 deve ser utilizado liabilityShiftRequired: type: boolean default: true description: >- Se verdadeiro, só continuará a cobrança caso haja transferência de responsabilidade pro banco emissor required: - paymentType PaymentMethodPixObject: title: Pix properties: paymentType: type: string enum: - pix description: método da cobrança via PIX, o source deve ser um customer válido. expiresIn: type: number description: tempo em segundos que define a validade da cobrança. qrCodeData: type: string description: >- código copia e cola para o QR code dinâmico gerado, pronto para ser pago. qrCodeImageUrl: type: string description: >- link para download da imagem do QR code dinâmico gerado, pronto para ser scaneado e pago. required: - paymentType - expiresIn - qrCodeData - qrCodeImageUrl PaymentMethodBoletoObject: title: Boleto properties: paymentType: type: string enum: - boleto description: método da cobrança via Boleto, o source deve ser um customer válido expiresDate: type: string description: data de vencimento do boleto em ISO-Date, ex 2017-01-31 default: 7 dias contados da data atual barcodeData: type: string description: >- código copia e cola do boleto registrado gerado, pronto para pagamento; barcodeImageUrl: type: string description: >- link para download do do boleto registrado gerado, pronto para pagamento; required: - paymentType - expiresDate - barcodeData - barcodeImageUrl PaymentMethodNuPayObject: title: NuPay properties: paymentType: type: string enum: - nupay description: método da cobrança via NuPay, o source deve ser um customer válido taxValue: type: integer description: montante do total de taxas aplicadas em centavos delayToAutoCancel: type: integer default: 30 description: >- tempo em minutos para a expiração de uma cobrança criada que não tenha sido paga orderUrl: type: string description: URL da cobrança returnUrl: type: string description: >- URL para a qual o cliente será redirecionado após finalizar o pagamento cancelUrl: type: string description: >- URL para onde o cliente será direcionado caso escolha não finalizar o pagamento e cancele o pedido required: - paymentType PaymentMethodDripObject: title: Drip type: object properties: paymentType: type: string enum: - drip description: método da cobrança via Drip browser: description: informações sobre o navegador do usuário allOf: - $ref: '#/components/schemas/DripBrowser' items: type: array description: Informações sobre itens que estão sendo pagos items: $ref: '#/components/schemas/DripItem' cancelRedirectUrl: type: string description: >- Link de redirecionamento em caso de cancelamento do pagamento no ambiente de checkout da Drip successRedirectUrl: type: string description: >- Link de redirecionamento em caso de aprovação do pagamento no ambiente de checkout da Drip paymentUrl: type: string description: URL para pagamento da cobrança Drip required: - paymentType PaymentMethodVoucherObject: title: Voucher type: object properties: paymentType: type: string enum: - voucher description: método da cobrança via Voucher items: type: array description: Informações sobre itens do pedido items: $ref: '#/components/schemas/VoucherItem' customer: type: object description: Informações sobre o cliente allOf: - $ref: '#/components/schemas/VoucherCustomer' required: - paymentType PaymentMethodApplePayObject: title: ApplePay type: object properties: paymentType: type: string enum: - apple_pay description: método da cobrança via Apple Pay installments: type: number description: quantidade de parcelas para cobrança do tipo apple pay crédito required: - paymentType SourceTypeCardObject: title: Cartão de crédito type: object description: dados para cobrança por cartão de crédito salve properties: sourceType: type: string description: tipo da origem da cobrança enum: - card cardId: type: string format: uuid description: Identificador do cartão quando source tipo card required: - sourceType - cardId SourceTypeTokenObject: title: Cartão tokenizado type: object description: dados para cobrança única de token de cartão properties: sourceType: type: string description: >- tipo da origem da cobrança, usar `token` para cobrança no token gerado enum: - token tokenId: type: string format: uuid description: Identificador do token quando source tipo token (opcional) required: - sourceType - tokenId SourceTypeCustomerObject: title: Customer type: object description: identificador do comprador para cobrança properties: sourceType: type: string description: >- tipo da origem da cobrança, usar `customer` para cobrança no cartão default do comprador enum: - customer customerId: type: string format: uuid description: >- Identificador do cliente quando source tipo customer, debitando o cartão default do comprador required: - sourceType - customerId SourceTypeWalletObject: title: Wallet type: object description: dados para cobrança por apple pay properties: sourceType: type: string description: tipo da origem da cobrança enum: - wallet walletPayment: type: string description: forma de cobrança enum: - credit paymentData: type: object description: Dados da wallet para cobrança properties: data: type: string description: dados para pagamento em base64 signature: type: string description: assinatura para os dados de pagamento e header version: type: string description: versão da criptografia header: type: object properties: ephemeralPublicKey: type: string description: chave x.509 em base64 required: - sourceType - paymentData FraudAnalysisMetadata: type: object properties: sla: type: number description: Valor em Minutos de SLA máximo de Análise do Pedido, se houver customer: description: Dados do comprador type: object properties: name: type: string description: Nome do usuario email: type: string description: E-mail do usuario phone: type: string description: Telefone de contato do usuario identityType: type: string description: Tipo de documento, consultar tabela de tipos suportados identity: type: string description: Número do documento formato conforme tipo selecionado registrationDate: type: string description: Data de registro do cliente deliveryAddress: description: Endereço de entrega allOf: - $ref: '#/components/schemas/FraudAnalysisAddress' billingAddress: description: Endereço de cobrança allOf: - $ref: '#/components/schemas/FraudAnalysisAddress' cart: description: Detalhe do carrinho de produtos type: object properties: items: type: array items: type: object properties: name: type: string description: nome do item/evento quantity: type: integer description: quantidade de itens do pedido sku: type: string description: identificador único do item na loja unitPrice: type: integer description: valor unitário do item/evento em centavos risk: type: string description: definição do indice de risco do item enum: - High - Low description: type: string description: Descrição do item/evento categoryId: type: string description: Categoria a qual o item/evento pertence locality: type: string description: Definição de local, em caso de evento date: type: string description: Definição de data, em caso de evento type: type: number description: Definição de tipo, em caso de evento genre: type: string description: Definição do gênero, em caso de evento tickets: type: object description: Informações relacionadas aos ingressos, em caso de evento properties: quantityTicketSale: type: number description: Quantidade total de ingressos à venda quantityEventHouse: type: number description: >- Quantidade de vezes que o evento será realizado na casa convenienceFeeValue: type: number description: Taxa de Conveniência quantityFull: type: number description: Quantidade de ingressos com valor integral quantityHalf: type: number description: Quantidade de ingresso com desconto (meia entrada) batch: type: number description: Lote do Ingresso location: description: Definição de endereço, em caso de evento allOf: - $ref: '#/components/schemas/FraudAnalysisAddress' TransactionRequest: properties: id: type: string description: identificador único do request feito ao provedor providerId: type: string format: uuid description: >- identificador do provider que processou a requisiçao, consulte a lista de providers configurados na sua conta providerType: type: string description: >- código que identifica o provedor, consultar tabela de provedores suportados pela Malga idempotencyKey: type: string description: >- chave única de referência gerada pela Malga para cada requisição, utilizada para garantir idempotência e evitar duplicidade no provedor, pode ser também consultada na API ou dashboard do provedor como orderId ou referenceKey no provedor. authorizationNsu: type: string description: identificador único da transação retornado pelo provider transactionId: type: string description: >- identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor requestStatus: type: string enum: - running - failed - success - timeout - internal_error - processing description: status do processamento da requisição no provider requestType: type: string enum: - pending - authorization - pre_authorization - void - capture - probe - charge_back - zero_dollar - anti_fraud - dispute description: identifica o tipo da requisição feita para o provider tokenizedPayment: type: boolean description: identifica se a transação foi processada usando um token externo amount: type: number description: >- valor da transação enviada para processamento do provider, em casos de estorno ou captura parcial o valor pode ser diferente do amount original da transação responseTs: type: string description: tempo de duração do processamento da requisição no provider providerError: type: object description: detalhes do erro em caso de falha no processamento da transação properties: message: type: string description: >- mensagem de erro mapeado pela Malga que descreve o motivo de rejeição retornad declinedCode: type: string description: >- codigo de erro mapeado pela Malga com base no tipo de erro apresentado pelo provedor retryable: type: boolean description: identifica se o tipo de erro permite ou não retentativa networkDeniedReason: type: string description: >- código retornado pelo provider que identitifica o motivo da rejeição, consultar o provedor networkDeniedMessage: type: string description: mensagem de erro retornado pelo provider, consultar o provedor providerAuthorization: type: object description: >- dados adicionais do retorno da autorização do provider no processamento da transação properties: networkAuthorizationCode: type: string description: >- código de autorização da transação conforme retornado pelo provider networkResponseCode: type: string description: >- código de resposta da requisição conforme retornado pelo provider createdAt: type: string description: Data de criação do request feito ao provedor updatedAt: type: string description: Data de atualização do request feito ao provedor 3DSecure2Response: type: object properties: setupId: type: string description: >- Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga dataOnly: type: boolean description: Indica se a transação foi processada apenas para coleta de dados 3DS requiresLiabilityShift: type: boolean description: Indica a ocorrência de mudança de responsabilidade redirectURL: type: string description: URL para redirecionamento de autenticação requestorURL: type: string description: URL de origem da requisição browser: description: Informações sobre o navegador do usuário allOf: - $ref: '#/components/schemas/3DSecure2browserResponse' billingAddress: description: Endereço de cobrança allOf: - $ref: '#/components/schemas/3DSecure2BillingAddressResponse' shippingAddress: description: Endereço para envio allOf: - $ref: '#/components/schemas/3DSecure2ShippingAddressResponse' cardHolder: description: Dados do portador do cartão allOf: - $ref: '#/components/schemas/3DSecure2CardHolderResponse' authData: description: Dados de autenticação do provedor allOf: - $ref: '#/components/schemas/3DSecure2AuthResponse' ChargeSplitRules: type: object properties: id: type: string format: uuid description: identificador da regra de split createdAt: type: string description: data de criação da regra de split sellerId: type: string format: uuid description: >- identificador do recebedor já cadastrado na API de [sellers](/api-reference/sellers/criacao-de-um-novo-recebedor) percentage: type: number description: porcentagem do valor da transação que será enviada ao recebedor amount: type: number description: valor que será enviado ao recebedor processingFee: type: boolean description: >- indica se o recebedor vinculado à regra será cobrado pelas taxas da transação chargeEntireFee: type: boolean description: indica se o recebedor será cobrado pela taxa inteira da transação chargeRemainderFee: type: boolean description: indica se o recebedor será cobrado pela taxa restante da transação fareFee: type: boolean description: >- Indica valor em centavos a ser cobrado por transação capturada. É descontado no momento da “montagem” da agenda financeira fareMdr: type: number description: >- Indica o percentual a ser descontado do valor de uma transação, definido por produto (crédito/débito/boleto), bandeira e faixa de parcelamento ErrorItem: properties: type: type: string enum: - api_error - bad_request - invalid_request_error - card_declined declinedCode: type: string description: Código de retorno da transação em caso de falha na autorização message: type: string description: Descrição breve do erro details: type: array description: Lista contendo objetos que detalham o erro de validação PixAdditionalInfo: properties: name: type: string description: Nome da propriedade adicional value: type: string description: Valor da propriedade declarada em `name` PixItem: properties: id: type: string description: Id do item a ser pago com Pix title: type: string description: Descrição do item a ser pago com Pix unitPrice: type: string description: Valor do item a ser pago com Pix quantity: type: array description: Quantidade de itens a serem pagos com Pix DripBrowser: properties: ipAddress: type: string description: IP do usuário browserFingerprint: type: string description: Fingerprint do navegador utilizado pelo usuário DripItem: properties: id: type: string description: Id do item a ser pago com Drip title: type: string description: Descrição do item a ser pago com Drip unitPrice: type: string description: Valor do item a ser pago com Drip quantity: type: array description: Quantidade de itens a serem pagos com Drip VoucherItem: properties: id: type: string description: Id do item a ser pago com Voucher title: type: string description: Descrição do item a ser pago com Voucher unitPrice: type: string description: Valor unitário do item a ser pago com Voucher quantity: type: array description: Quantidade de itens a serem pagos com Voucher VoucherCustomer: type: object properties: name: type: string description: nome do usuário email: type: string description: email do usuário phone: type: string description: telefone de contato do usuário identityType: type: string description: Tipo de documento, consultar tabela de tipos suportados identity: type: string description: Número do documento formato conforme tipo selecionado billingAddress: description: Endereço de cobrança allOf: - $ref: '#/components/schemas/VoucherAddress' Document: type: object properties: type: type: string description: Tipo de documento, consultar tabela de tipos suportados number: type: string description: Número do documento formato conforme tipo selecionado country: type: string description: >- Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados default: BR enum: - AL - AD - AR - AT - AU - BA - BZ - BE - BG - BR - BY - CA - CU - CY - CZ - CH - CL - CN - CO - CR - DE - DK - DO - EC - EE - SV - GT - FI - FR - GB - GR - HR - HK - HU - IS - ID - IE - IN - IL - IT - LI - LT - LU - LV - MK - MC - MD - MT - MU - JP - KR - MX - ME - MY - NL - NZ - 'NO' - PY - PE - PK - PL - PT - RU - RO - SM - RS - SE - SG - TH - TW - TR - SI - SK - ES - UY - UA - US - VE - VN - ZA required: - type - number Address: type: object properties: street: type: string description: Nome da rua/avenida/travessa streetNumber: type: string description: Número onde se localiza o endereço complement: type: string description: Complemento onde se localiza o endereço, caso exista zipCode: type: string description: Codigo postal CEP country: type: string description: Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2 default: BR enum: - AL - AD - AR - AT - AU - BA - BZ - BE - BG - BR - BY - CA - CU - CY - CZ - CH - CL - CN - CO - CR - DE - DK - DO - EC - EE - SV - GT - FI - FR - GB - GR - HR - HK - HU - IS - ID - IE - IN - IL - IT - LI - LT - LU - LV - MK - MC - MD - MT - MU - JP - KR - MX - ME - MY - NL - NZ - 'NO' - PY - PE - PK - PL - PT - RU - RO - SM - RS - SE - SG - TH - TW - TR - SI - SK - ES - UY - UA - US - VE - VN - ZA state: type: string description: Estado onde se localiza o endereço city: type: string description: Cidade onde se localiza o endereço district: type: string description: Bairro onde se localiza o endereço required: - street - streetNumber - zipCode - country - state - city - district FraudAnalysisAddress: type: object properties: country: type: string description: Padrão ISO 3166-1 alpha-2 state: type: string description: Estado city: type: string description: Cidade district: type: string description: Bairro zipCode: type: string description: Codigo postal CEP street: type: string description: Nome da rua/avenida/travessa number: type: string description: Numero da rua complement: type: string description: Complemento caso exista FraudAnalysisCustomerBrowser: type: object properties: browserFingerprint: type: string description: fingerprint gerado do navegador cookiesAccepted: type: boolean description: indica se os cookies foram aceitados email: type: string description: e-mail logado no navegador hostName: type: string description: nome do host do usuário ipAddress: type: string description: endereço de ip do usuário type: type: string description: user-agent do browser 3DSecure2browser: type: object properties: acceptBrowserValue: type: string description: O valor do cabeçalho Accept para o navegador acceptContent: type: string description: O tipo de conteúdo que o navegador aceita acceptHeader: type: string description: O Accept do cabeçalho de requisição HTTP colorDepth: type: number description: A profundidade de cores da tela javaEnabled: type: boolean description: Se Java está habilitado javaScriptEnabled: type: boolean description: Se javaScript está habilitado language: type: string description: A linguagem utilizada pelo sistema do usuário screenHeight: type: number description: Altura da tela screenWidth: type: number description: Largura da tela timeZoneOffset: type: string description: >- Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual userAgent: type: string description: O User-Agent do cabeçalho de requisição HTTP ip: type: string description: Endereço de ip do usuário required: - acceptBrowserValue - acceptContent - acceptHeader - colorDepth - javaEnabled - language - screenHeight - screenWidth - timeZoneOffset - userAgent - ip 3DSecure2BillingAddress: type: object properties: city: type: string description: Cidade country: type: string description: Padrão ISO 3166-1 alpha-2 streetNumber: type: string description: Número da rua zipCode: type: string description: Codigo postal CEP state: type: string description: Estado street: type: string description: Rua required: - city - country - streetNumber - zipCode - state - street 3DSecure2ShippingAddress: type: object properties: city: type: string description: Cidade country: type: string description: Padrão ISO 3166-1 alpha-2 streetNumber: type: string description: Número da rua zipCode: type: string description: Codigo postal CEP state: type: string description: Estado street: type: string description: Rua required: - city - country - streetNumber - zipCode - state - street 3DSecure2CardHolder: type: object properties: email: type: string description: Email mobilePhone: type: string description: Telefone celular required: - email 3DSecure2MPI: type: object properties: acsTransactionId: type: string description: ID da transação ACS cavv: type: string description: Cardholder Authentication Verification Value challenged: type: boolean description: Indica se houve challenge directoryServerTransactionId: type: string description: ID da transação do Directory Server eci: type: string description: Electronic Commerce Indicator threeDSServerTransactionId: type: string description: ID da transação do 3DS Server transStatus: type: string description: Status da transação version: type: string description: Versão do protocolo 3DS xid: type: string description: Transaction ID (XID) AppInfoPlatform: properties: integrator: type: string description: Nome do parceiro que implementou a integração name: type: string description: Nome do produto version: type: string description: Versão do produto required: - name - version AppInfoDevice: properties: sessionId: type: string description: ID da sessão name: type: string description: Nome do sistema operacional version: type: string description: Versão do sistema operacional required: - name - version AppInfoSystem: properties: name: type: string description: Nome da empresa e/ou plataforma version: type: string description: Versão do software da plataforma required: - name - version 3DSecure2browserResponse: type: object properties: acceptBrowserValue: type: string description: O valor do cabeçalho Accept para o navegador acceptContent: type: string description: O tipo de conteúdo que o navegador aceita acceptHeader: type: string description: O Accept do cabeçalho de requisição HTTP colorDepth: type: number description: A profundidade de cores da tela javaEnabled: type: boolean description: Se Java está habilitado javaScriptEnabled: type: boolean description: Se javaScript está habilitado language: type: string description: A linguagem utilizada pelo sistema do usuário screenHeight: type: number description: Altura da tela screenWidth: type: number description: Largura da tela timeZoneOffset: type: string description: >- Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual userAgent: type: string description: O User-Agent do cabeçalho de requisição HTTP ip: type: string description: Endereço de ip do usuário 3DSecure2BillingAddressResponse: type: object properties: city: type: string description: Cidade country: type: string description: Padrão ISO 3166-1 alpha-2 streetNumber: type: string description: Número da rua zipCode: type: string description: Codigo postal CEP state: type: string description: Estado street: type: string description: Rua 3DSecure2ShippingAddressResponse: type: object properties: city: type: string description: Cidade country: type: string description: Padrão ISO 3166-1 alpha-2 streetNumber: type: string description: Número da rua zipCode: type: string description: Codigo postal CEP state: type: string description: Estado street: type: string description: Rua 3DSecure2CardHolderResponse: type: object properties: email: type: string description: Email mobilePhone: type: string description: Telefone celular 3DSecure2AuthResponse: type: object properties: action: type: string enum: - REDIRECT description: Tipo de ação exigida pelo provedor providerType: type: string enum: - ADYEN description: Nome do provedor responseType: type: string enum: - AUTHENTICATION - AUTHORIZATION description: Identifica a etapa do desafio response: type: object description: >- O object retornado do provedor com dados para autenticação ou autorização VoucherAddress: type: object properties: country: type: string description: Padrão ISO 3166-1 alpha-2 state: type: string description: Estado city: type: string description: Cidade district: type: string description: Bairro zipCode: type: string description: Código postal CEP street: type: string description: Nome da rua/avenida/travessa number: type: string description: Número da rua complement: type: string description: Complemento caso exista examples: ChargeCardRequest: summary: Exemplo cobrança Cartão value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: false orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card card: cardNumber: '5261424250184574' cardCvv: '321' cardExpirationDate: 06/2028 cardHolderName: JOAO DA SILVA ChargePixRequest: summary: Exemplo cobrança PIX value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: true orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: pix expiresIn: 3600 paymentSource: sourceType: customer customer: name: Customer test email: jose2@gmail.com document: number: '97055503019' type: cpf phoneNumber: 21 98889999099 ChargeBoletoRequest: summary: Exemplo cobrança Boleto value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: true orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: boleto expiresDate: '2022-12-31' instructions: Instruções para pagamento do boleto interest: days: 1 amount: 100 percentage: 0.2 fine: days: 2 amount: 200 percentage: 0 paymentSource: sourceType: customer customer: name: Customer test email: jose2@gmail.com document: number: '97055503019' type: cpf phoneNumber: 21 98889999099 ChargeSplitRequest: summary: Exemplo de cobrança Cartão com Split value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: 'Pedido #231 loja joão' description: Descrição longa da cobrança capture: false orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card card: cardHolderName: JOAO DA SILVA cardNumber: '5261424250184574' cardCvv: '321' cardExpirationDate: 06/2028 splitRules: - sellerId: 32c68557-902c-408b-b464-cf487c7cda97 percentage: 10 liable: true processingFee: false chargeEntireFee: true chargeRemainderFee: true - sellerId: 50c68557-802c-408b-b464-cf487c7cda97 percentage: 40 liable: true processingFee: false chargeEntireFee: false chargeRemainderFee: true ChargeSplitRequestPix: summary: Exemplo de cobrança Pix com Split value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: 'Pedido #231 loja joão' description: Descrição longa da cobrança capture: false orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: pix expiresIn: 3600 paymentSource: sourceType: customer customer: name: Customer test email: jose2@gmail.com document: number: '97055503019' type: cpf phoneNumber: 21 98889999099 splitRules: - sellerId: 32c68557-902c-408b-b464-cf487c7cda97 percentage: 10 liable: true processingFee: false chargeEntireFee: true chargeRemainderFee: true - sellerId: 50c68557-802c-408b-b464-cf487c7cda97 percentage: 40 liable: true processingFee: false chargeEntireFee: false chargeRemainderFee: true ChargeSplitRequestBoleto: summary: Exemplo de cobrança Boleto com Split value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: 'Pedido #231 loja joão' description: Descrição longa da cobrança capture: false orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: boleto expiresDate: '2022-12-31' instructions: Instruções para pagamento do boleto interest: days: 1 amount: 100 percentage: 0.2 fine: days: 2 amount: 200 percentage: 0 paymentSource: sourceType: customer customer: name: Customer test email: jose2@gmail.com document: number: '97055503019' type: cpf phoneNumber: 21 98889999099 splitRules: - sellerId: 32c68557-902c-408b-b464-cf487c7cda97 percentage: 10 liable: true processingFee: false chargeEntireFee: true chargeRemainderFee: false - sellerId: 50c68557-802c-408b-b464-cf487c7cda97 percentage: 40 liable: true processingFee: false chargeEntireFee: false chargeRemainderFee: true ChargeVendorExample: summary: Exemplo de cobrança Cartão com vendedor value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: 'Pedido #231 loja joão' description: Descrição longa da cobrança capture: false orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card card: cardHolderName: JOAO DA SILVA cardNumber: '5261424250184574' cardCvv: '321' cardExpirationDate: 06/2028 vendor: id: d36274c9-9675-4093-8ef5-cd84bc4a7c5d paymentFacilitatorID: null Charge3DS2Request: summary: Exemplo cobrança Cartão e 3D Secure 2 value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: false orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card card: cardNumber: '5261424250184574' cardCvv: '321' cardExpirationDate: 06/2028 cardHolderName: JOAO DA SILVA threeDSecure2: redirectURL: https://your-company.com/receive requestorURL: https://api/your-company.com browser: acceptHeader: >- text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 colorDepth: 24 javaEnabled: true javaScriptEnabled: true language: BR screenHeight: 1080 screenWidth: 1920 timeZoneOffset: '180' userAgent: >- Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36 ip: 0.0.0.0 cardHolder: email: cardHolder@email.com mobilePhone: 11 99329899 billingAddress: city: Rio de Janeiro country: BR streetNumber: 159 zipCode: '2547896' state: RJ street: Av Brasil shippingAddress: city: São Paulo country: BR streetNumber: 59 zipCode: '2547896' state: SP street: Rua das Flores Charge3DSMPIExterno: summary: Exemplo cobrança Cartão e 3D Secure Com MPI Externo value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: false orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card card: cardNumber: '5261424250184574' cardCvv: '321' cardExpirationDate: 06/2028 cardHolderName: JOAO DA SILVA threeDSecure2: mpi: acsTransactionId: 9502fcb2-f483-4e4f-b9c9-70e01d8f49e2 cavv: AAIBBYNoEwAAACcKhAJkdQAAAAA= challenged: true directoryServerTransactionId: 4e8567db-2f9e-4c9d-9d8c-3da3c2f7ed32 eci: '05' threeDSServerTransactionId: 4830a4b7-b80e-4eeb-bff2-d21699e771f0 transStatus: 'Y' version: 2.2.0 xid: AAIBBYNoEwAAACcKhAJkdQAAAAA= Charge3DSMalgaRequest: summary: Exemplo cobrança Cartão e 3D Secure 2 value: merchantId: b669086b-68b1-4f55-95bd-8ab45e48d670 amount: 150 statementDescriptor: Teste Card Adyen capture: true paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card cardId: f01044c6-1452-43bc-8492-29a17d58ba9d vendor: id: c0a7f5fa-4a8a-48ef-9f46-7727ca2d75b4 threeDSecure2: setupId: 05ee0280-afe2-4b81-991b-383a7feaae5f requiresLiabilityShift: false, redirectURL: https://www.google.com requestorURL: https://localhost browser: acceptBrowserValue: v1 acceptContent: v2 acceptHeader: '*/*' colorDepth: 24 javaEnabled: true javaScriptEnabled: true language: pt-BR screenHeight: 1080 screenWidth: 1920 timeZoneOffset: '180' userAgent: >- Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36 ip: 127.0.0.1 cardHolder: email: email@gmail.com mobilePhone: '123456789' ChargeNupayRequest: summary: Exemplo cobrança Nupay value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: nupay taxValue: 1 delayToAutoCancel: 200 orderUrl: https://order.com.br returnUrl: https://return-url.com.br cancelUrl: https://cancel-url.com.br paymentSource: sourceType: customer customer: name: Customer test email: customer@gmail.com document: number: '97055503019' type: cpf phoneNumber: 21 98889999099 address: street: Rua 1 streetNumber: '120' zipCode: '01714140' state: SP city: São Paulo fraudAnalysis: customer: browser: ipAddress: 127.0.0.1 cart: items: - sku: '123' name: desc quantity: 1 unitPrice: 1 risk: Low ChargePicpayRequest: summary: Exemplo cobrança Picpay value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: picpay paymentSource: sourceType: customer customer: name: Customer test email: jose2@gmail.com document: number: '97055503019' type: cpf phoneNumber: 21 98889999099 ChargeDripRequest: summary: Exemplo cobrança Drip value: merchantId: ba3f0dba-905d-4705-9e61-a75d6a6eca5d amount: 150 currency: BRL orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 capture: true description: Descrição cobrança statementDescriptor: Descrição cobrança paymentMethod: paymentType: drip maxInstallments: 4 items: - id": '12345' quantity": 1 title": title item unitPrice": 150 browser: ipAddress: 127.0.0.1 browserFingerprint: cbd4a441-c63c-4dee-ac6b-bfa7fa1df818 cancelRedirectUrl: https://service-example.com/cancel successRedirectUrl: https://service-example.com/success paymentSource: sourceType: customer customer: name: Customer test email: customer@gmail.com document: number: '97055503019' type: cpf phoneNumber: 21 98889999099 address: street: Rua 1 streetNumber: '120' zipCode: '01714140' state: SP city: São Paulo country: BR district: Moema ChargeVoucherRequest: summary: Exemplo cobrança Voucher value: paymentMethod: customer: name: Customer test identity: '11111111111' paymentType: voucher items: - id: '12345' title: ItemTeste1 quantity: 1 unitPrice: 100 paymentSource: sourceType: card card: cardHolderName: Customer test cardNumber: '6370360004577166' cardCvv: '527' cardExpirationDate: 12/2024 merchantId: ba3f0dba-905d-4705-9e61-a75d6a6eca5d amount: 100 currency: BRL statementDescriptor: Voucher orderId: 15ad136a-520b-40d0-9c0e-05ff008b0fa7 description: 15ad136a-520b-40d0-9c0e-05ff008b0fa7 ChargeApplePayRequest: summary: Exemplo cobrança Apple Pay value: appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: false orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: apple_pay installments: 1 paymentSource: sourceType: wallet walletPayment: credit paymentData: data: >- /ZCUzCmr236kDnnXb9cZsvG1JJOqe8GOuRDfCgJ...7haAXX9ml5c7eCIf+IQa1MSGUZYgawepPy signature: MIAGCSqGSIb3DQEHAqCAMIACAQExDTAL...s9BerKDnL1zoEcmcybKzgAAAAAAAA== header: ephemeralPublicKey: MFkwEwYHKoZIzj0CAQYIKo...ixBMa1KGjnGapsQih+Kdbg2fA== version: EC_v1 ChargeCard: summary: Exemplo resposta cobrança por cartão value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 createdAt: 2012-06-30 23:59:59 +0000 amount: 150 currency: BRL orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: false isDispute: false status: pre_authorized paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card cardId: 148d5db0-f1c3-439f-902d-f1f268086e1d transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 2c3b57d8-ee43-4b19-bc8a-949a88c51df1 providerType: STRIPE transactionId: ch_3JYE7MHjGFBGEeiP0lfTD3Ob amount: 1500 authorizationNsu: 1cc8391c-f0d5-4b7a-9fcf-653cea26be13 requestStatus: success requestType: authorization responseTs: 2633ms createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' providerAuthorization: networkAuthorizationCode: '00' networkResponseCode: '' appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' ChargePix: summary: Exemplo resposta cobrança PIX value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 createdAt: 2012-06-30 23:59:59 +0000 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: true isDispute: false status: pending orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: pix expiresIn: 3600 qrCodeData: >- 00020101021126510014BR.GOV.BCB.PIX0129K89VdiUgWN1B3p0IHrgHkNHg9tX5F52040000530398654040.155802BR5913Customer test600062070503***630431C0 qrCodeImageUrl: https://.... paymentSource: sourceType: customer customerId: 1cdcf0c9-eb04-4e43-b9b2-b7a4acdead1f transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 2c3b57d8-ee43-4b19-bc8a-949a88c51df1 providerType: STRIPE transactionId: ch_3JYE7MHjGFBGEeiP0lfTD3Ob amount: 1500 authorizationNsu: 1cc8391c-f0d5-4b7a-9fcf-653cea26be13 requestStatus: success requestType: authorization responseTs: 2633ms createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' providerAuthorization: networkAuthorizationCode: '00' networkResponseCode: '' appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' ChargeBoleto: summary: Exemplo resposta cobrança Boleto value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 createdAt: 2012-06-30 23:59:59 +0000 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: true status: pending paymentMethod: paymentType: boleto expiresDate: '2021-12-31' barcodeData: '412343241324321431241341' barcodeImageUrl: https://.... paymentSource: sourceType: customer customerId: 1cdcf0c9-eb04-4e43-b9b2-b7a4acdead1f transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 2c3b57d8-ee43-4b19-bc8a-949a88c51df1 providerType: STRIPE transactionId: ch_3JYE7MHjGFBGEeiP0lfTD3Ob amount: 1500 authorizationNsu: 1cc8391c-f0d5-4b7a-9fcf-653cea26be13 requestStatus: success requestType: authorization responseTs: 2633ms createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' providerAuthorization: networkAuthorizationCode: '00' networkResponseCode: '' appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' ChargeSplit: summary: Exemplo resposta de cobrança Cartão com Split value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 description: Descrição longa da cobrança orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 createdAt: '2022-10-04T21:36:21.093Z' amount: 150 originalAmount: 150, currency: BRL statementDescriptor: 'Pedido #231 loja joão' capture: false isDispute: false status: pre_authorized paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card cardId: 148d5db0-f1c3-439f-902d-f1f268086e1d splitRules: - id: 759af8a1-6f5c-4caf-ae79-98e6aa27b7e9 updatedAt: '2022-10-04T20:31:46.776Z' createdAt": '2022-10-04T20:31:46.776Z' sellerId": 32c68557-902c-408b-b464-cf487c7cda97 percentage": 10 amount": null processingFee": false chargeEntireFee: true chargeRemainderFee: true liable: true fareMdr: null fareFee: null - id: 9873712a-3c3a-49ea-a4b1-c6c167c352c3 updatedAt: '2023-10-04T20:31:46.776Z' createdAt": '2023-10-04T20:31:46.776Z' sellerId": 50c68557-802c-408b-b464-cf487c7cda97 percentage": 40 amount": null processingFee": false chargeEntireFee: false chargeRemainderFee: false liable: true fareMdr: null fareFee: null transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 2c3b57d8-ee43-4b19-bc8a-949a88c51df1 providerType: STRIPE transactionId: ch_3JYE7MHjGFBGEeiP0lfTD3Ob amount: 150 authorizationCode: '1560708' authorizationNsu: 1cc8391c-f0d5-4b7a-9fcf-653cea26be13 requestStatus: success requestType: authorization responseTs: 2633ms providerAuthorization: networkAuthorizationCode: '00' networkResponseCode: '' appInfo: device: name: iOS version: '10.12' system: name: VTEX version: '13.12' platform: name: pluging-vtex-ppp version: '1.12' integrator: malga ChargeSplitPix: summary: Exemplo resposta cobrança Pix com Split value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 description: Descrição longa da cobrança orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 createdAt: '2022-10-04T21:36:21.093Z' amount: 150 originalAmount: 150, currency: BRL statementDescriptor: 'Pedido #231 loja joão' capture: false isDispute: false status: pre_authorized paymentMethod: paymentType: pix expiresIn: 3600 qrCodeData: >- 00020101021126510014BR.GOV.BCB.PIX0129K89VdiUgWN1B3p0IHrgHkNHg9tX5F52040000530398654040.155802BR5913Customer test600062070503***630431C0 qrCodeImageUrl: https://.... paymentSource: sourceType: customer customerId: 1cdcf0c9-eb04-4e43-b9b2-b7a4acdead1f splitRules: - id: 759af8a1-6f5c-4caf-ae79-98e6aa27b7e9 updatedAt: '2022-10-04T20:31:46.776Z' createdAt": '2022-10-04T20:31:46.776Z' sellerId": 32c68557-902c-408b-b464-cf487c7cda97 percentage": 10 amount": null processingFee": false chargeEntireFee: true chargeRemainderFee: true liable: true fareMdr: null fareFee: null - id: 9873712a-3c3a-49ea-a4b1-c6c167c352c3 updatedAt: '2023-10-04T20:31:46.776Z' createdAt": '2023-10-04T20:31:46.776Z' sellerId": 50c68557-802c-408b-b464-cf487c7cda97 percentage": 40 amount": null processingFee": false chargeEntireFee: false chargeRemainderFee: true liable: true fareMdr: null fareFee: null transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 2c3b57d8-ee43-4b19-bc8a-949a88c51df1 providerType: STRIPE transactionId: ch_3JYE7MHjGFBGEeiP0lfTD3Ob amount: 150 authorizationCode: '1560708' authorizationNsu: 1cc8391c-f0d5-4b7a-9fcf-653cea26be13 requestStatus: success requestType: authorization responseTs: 2633ms providerAuthorization: networkAuthorizationCode: '00' networkResponseCode: '' appInfo: device: name: iOS version: '10.12' system: name: VTEX version: '13.12' platform: name: pluging-vtex-ppp version: '1.12' integrator: malga ChargeSplitBoleto: summary: Exemplo resposta cobrança Boleto e Split value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 merchantId: 7f8870a2-71c9-4ef0-a531-82000e00b7e1 description: Descrição longa da cobrança orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 createdAt: '2022-10-04T21:36:21.093Z' amount: 150 originalAmount: 150, currency: BRL statementDescriptor: 'Pedido #231 loja joão' capture: false isDispute: false status: pre_authorized paymentMethod: paymentType: boleto expiresDate: '2021-12-31' barcodeData: '412343241324321431241341' barcodeImageUrl: https://.... paymentSource: sourceType: customer customerId: 1cdcf0c9-eb04-4e43-b9b2-b7a4acdead1f splitRules: - id: 759af8a1-6f5c-4caf-ae79-98e6aa27b7e9 updatedAt: '2022-10-04T20:31:46.776Z' createdAt": '2022-10-04T20:31:46.776Z' sellerId": 32c68557-902c-408b-b464-cf487c7cda97 percentage": 10 amount": null processingFee": false chargeEntireFee: false chargeRemainderFee: false liable: true fareMdr: null fareFee: null - id: 9873712a-3c3a-49ea-a4b1-c6c167c352c3 updatedAt: '2023-10-04T20:31:46.776Z' createdAt": '2023-10-04T20:31:46.776Z' sellerId": 50c68557-802c-408b-b464-cf487c7cda97 percentage": 40 amount": null processingFee": false chargeEntireFee: true chargeRemainderFee: true liable: true fareMdr: null fareFee: null transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 2c3b57d8-ee43-4b19-bc8a-949a88c51df1 providerType: STRIPE transactionId: ch_3JYE7MHjGFBGEeiP0lfTD3Ob amount: 150 authorizationCode: '1560708' authorizationNsu: 1cc8391c-f0d5-4b7a-9fcf-653cea26be13 requestStatus: success requestType: authorization responseTs: 2633ms providerAuthorization: networkAuthorizationCode: '00' networkResponseCode: '' appInfo: device: name: iOS version: '10.12' system: name: VTEX version: '13.12' platform: name: pluging-vtex-ppp version: '1.12' integrator: malga ChargeCard3DSecure2: summary: Exemplo resposta cobrança por cartão 3D Secure 2 value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 createdAt: 2012-06-30 23:59:59 +0000 amount: 150 currency: BRL orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: false isDispute: false status: pre_authorized paymentMethod: paymentType: credit installments: 1 paymentSource: sourceType: card cardId: 148d5db0-f1c3-439f-902d-f1f268086e1d transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 2c3b57d8-ee43-4b19-bc8a-949a88c51df1 providerType: STRIPE transactionId: ch_3JYE7MHjGFBGEeiP0lfTD3Ob amount: 1500 authorizationNsu: 1cc8391c-f0d5-4b7a-9fcf-653cea26be13 requestStatus: success requestType: authorization responseTs: 2633ms createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' providerAuthorization: networkAuthorizationCode: '00' networkResponseCode: '' threeDSecure2: redirectURL: https://your-company.com/receive requestorURL: https://api/your-company.com browser: acceptHeader: >- text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 colorDepth: 24 javaEnabled: true javaScriptEnabled: true language: BR screenHeight: 1080 screenWidth: 1920 timeZoneOffset: '180' userAgent: >- Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36 ip: 0.0.0.0 cardHolder: email: cardHolder@email.com mobilePhone: 11 99329899 billingAddress: city: Rio de Janeiro country: BR streetNumber: 159 zipCode: '2547896' state: RJ street: Av Brasil shippingAddress: city: São Paulo country: BR streetNumber: 59 zipCode: '2547896' state: SP street: Rua das Flores authData: action: REDIRECT providerType: ADYEN responseType: AUTHENTICATION response: md: M2RzMi5lZTBiZTgzZTdmZDBlZDk...AkHGAAAA url: >- https://checkoutshopper.adyen.com/checkoutshopper/threeDS2.shtml?pspReference=863677264398111 paReq: BQABAgB-MNl4GsRJSf5EmZE8guLfFQX7Q5Q...L_dRprriZL72QXGCtIPK-Hd termUrl: >- https://checkoutshopper.adyen.com/checkoutshopper/threeDS/return/H4sIAA...Hf appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' ChargeCard3DSMalga: summary: Exemplo resposta cobrança por cartão 3D Secure 2 value: id: cfaf805f-e4b3-4c2b-bceb-031f61e24806 clientId: e234eeb3-483d-4df2-87eb-1e2be5cdaccd merchantId: 1cce7844-d804-451f-ab40-63bff9bf8fcb description: null orderId: null createdAt: '2024-10-01T16:40:35.139Z' amount: 100 originalAmount: 100 currency: BRL statementDescriptor: teste123 capture: true isDispute: false status: authorized responsibleProviderType: SANDBOX paymentFlow: id: 12345fc0-238e-4fd6-af96-8cab57fd6edc paymentMethod: installments: 1 paymentType: credit paymentSource: sourceType: card cardId: a7f3ace8-16ec-4299-9bd4-34219739c7cc fraudAnalysisMetadata: sla: null customer: name: User Username email: user@email.co identity: '45762964850' identityType: CPF birthdate: null phone: '+5511998326199' billingAddress: country: BR street: Rua General nestor passos number: 226 complement: ap 107 zipCode: '02417140' city: Sao Paulo state: SP district: Jardim Paraiso deliveryAddress: country: BR street: Rua General nestor passos number: 226 complement: ap 107 zipCode: '02417140' city: Sao Paulo state: SP district: Jardim Paraiso cart: items: - name: ItemTeste1 quantity: 1 sku: '20170511' unitPrice: 50 risk: High locality: null date: null type: null genre: null tickets: null location: null orderOrigin: null operationalSystem: null country: null transactionRequests: - id: ae383789-7608-4c57-ab01-721f722e98e3 createdAt: '2024-10-01T16:40:44.993Z' updatedAt: '2024-10-01T16:40:44.993Z' idempotencyKey: 3356a581-14b3-43f4-9cfe-0ba39b7d9a1a providerId: 56746c7b-c5ac-4ab6-8513-94fa00fa5064 providerType: SANDBOX transactionId: f5d4cfd6-6813-4ec1-bdfa-8ae4d5d69135 amount: 100 authorizationCode: '6480680' authorizationNsu: '2806774' requestStatus: success requestType: authorization requestStatusReason: null responseTs: 35ms providerAuthorization: networkAuthorizationCode: '2139951' networkResponseCode: '4496916' threeds: authenticated: false - id: d22753f0-2089-49a7-9b03-b11b2eeeb796 createdAt: '2024-10-01T16:40:44.743Z' updatedAt: '2024-10-01T16:40:44.743Z' idempotencyKey: 2bca8426-8857-4d8c-b3d3-464faf26077e providerId: null providerType: CYBERSOURCE transactionId: '7278008445356393004951' amount: 100 authorizationCode: null authorizationNsu: null requestStatus: success requestType: 3DS_authentication_validate requestStatusReason: null responseTs: null threeds: liabilityShift: true - id: 10e80b19-09e7-423e-aaff-57168df78040 createdAt: '2024-10-01T16:40:36.884Z' updatedAt: '2024-10-01T16:40:36.884Z' idempotencyKey: 2bca8426-8857-4d8c-b3d3-464faf26077e providerId: null providerType: CYBERSOURCE transactionId: '7278008364396297404953' amount: 100 authorizationCode: null authorizationNsu: null requestStatus: success requestType: 3DS_authentication_enroll requestStatusReason: null responseTs: null threeds: cardEnrolled: true challenged: true - id: 29945667-094a-4934-898a-8b2713eccbba createdAt: '2024-10-01T16:40:36.859Z' updatedAt: '2024-10-01T16:40:36.859Z' idempotencyKey: 2bca8426-8857-4d8c-b3d3-464faf26077e providerId: null providerType: CYBERSOURCE transactionId: '7278008315186292704953' amount: 100 authorizationCode: null authorizationNsu: null requestStatus: success requestType: 3DS_authentication_setup requestStatusReason: null responseTs: null threeDSecure2: requiresLiabilityShift: true authenticated: false version: 2.1.0 offered: true liabilityShift: true cardEnrolled: true cardTokenId: null offeredType: Unknown challenged: true redirectURL: https://localhost:3000/checkout.html requestorURL: https://localhost:3000 networkTransactionId: null browser: acceptBrowserValue: null acceptContent: null acceptHeader: >- text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 colorDepth: 30 javaEnabled: false javaScriptEnabled: true language: en-US screenHeight: 900 screenWidth: 1440 timeZoneOffset: '240' userAgent: >- Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36 ip: 200.53.196.214 billingAddress: city: Aracaju country: BR streetNumber: '177' zipCode: '49089185' state: Sergipe street: Rua J shippingAddress: null cardHolder: null authData: action: REDIRECT providerType: CYBERSOURCE responseType: AUTHENTICATION response: pareq: >- eyJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMS4wIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiI3ZGViNWZhYS1lM2NkLTRjZDgtYjUxZC1hNmQ5OWQyMWY0YmIiLCJhY3NUcmFuc0lEIjoiM2U0NjZkMjMtMzk5Yy00OWRkLTlhNzItZTk0ZDY0MWM2NTdiIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjAyIn0 token: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJlYjY4NjM5Yi0zMGUwLTRiZDUtYjE0ZC0xYzQ4NjAxNWI2NTMiLCJpYXQiOjE3Mjc4MDA4MzYsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTcyNzgwNDQzNiwiT3JnVW5pdElkIjoiNjU0NDUzNzkzZDJmNTM1NWE3YjljN2IxIiwiUGF5bG9hZCI6eyJBQ1NVcmwiOiJodHRwczovLzBtZXJjaGFudGFjc3N0YWcuY2FyZGluYWxjb21tZXJjZS5jb20vTWVyY2hhbnRBQ1NXZWIvY3JlcS5qc3AiLCJQYXlsb2FkIjoiZXlKdFpYTnpZV2RsVkhsd1pTSTZJa05TWlhFaUxDSnRaWE56WVdkbFZtVnljMmx2YmlJNklqSXVNUzR3SWl3aWRHaHlaV1ZFVTFObGNuWmxjbFJ5WVc1elNVUWlPaUkzWkdWaU5XWmhZUzFsTTJOa0xUUmpaRGd0WWpVeFpDMWhObVE1T1dReU1XWTBZbUlpTENKaFkzTlVjbUZ1YzBsRUlqb2lNMlUwTmpaa01qTXRNems1WXkwME9XUmtMVGxoTnpJdFpUazBaRFkwTVdNMk5UZGlJaXdpWTJoaGJHeGxibWRsVjJsdVpHOTNVMmw2WlNJNklqQXlJbjAiLCJUcmFuc2FjdGlvbklkIjoiSDdocndJaFRLS3ZMbHJHWVN2OTAifSwiT2JqZWN0aWZ5UGF5bG9hZCI6dHJ1ZSwiUmV0dXJuVXJsIjoiaHR0cHM6Ly9hcGkuZGV2Lm1hbGdhLmlvL3YxL2NoYXJnZXMvY2ZhZjgwNWYtZTRiMy00YzJiLWJjZWItMDMxZjYxZTI0ODA2LzNkcy1hdXRob3JpemF0aW9uP2hhc2g9cG4taWNkcHlWaFVJaVowbmppbVdFYVVFeGxGeHFlX3kwVlkxT0lqMlphYyZjbGllbnRJZD1lMjM0ZWViMy00ODNkLTRkZjItODdlYi0xZTJiZTVjZGFjY2QifQ.DzUlK4UPFakvWW_alV0DvtnNSDaJPMBDzWXGX07nTe8 stepUrl: https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp networkTransactionId: '7278008364396297404953' appInfo: null ChargeNupay: summary: Exemplo resposta cobrança nupay value: id: 4cbF2516-b8c0-4222-a28d-2c7e22a9ebe1 clientId: 11111111-36dc-4654-9dba-e7167d0e5e2d merchantId: 7cCf07e8-9798-4bf6-a97e-7f0e0822c176 description: null orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 createdAt: '2022-09-30T21:33:42.955Z' amount: 100 originalAmount: 100 currency: BRL statementDescriptor: null status: pending paymentMethod: paymentType: nupay paymentSource: sourceType: customer customerId: ae1b1f52-ee01-4014-9eb6-e529dd6d3f5f transactionRequests: - id: 1c57caad-136d-4bc4-a265-c72d408d5ef7 createdAt: '2022-09-30T21:33:42.969Z' updatedAt: '2022-09-30T21:33:44.105Z' idempotencyKey: 84d0ed42-0239-4618-b3b9-e31114bba17b providerId: 72cecc64-2079-4128-8cb0-c5a4ed8fa995 providerType: NUPAY transactionId: 2c57caad-136d-4bc4-a265-c72d408d5ef8 amount: 100 authorizationCode: null authorizationNsu: null requestStatus: success requestType: pending responseTs: 1084ms nupay: expiresIn: 200 appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' ChargePicpay: summary: Exemplo resposta cobrança Picpay value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 createdAt: 2012-06-30 23:59:59 +0000 amount: 150 currency: BRL statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: false isDispute: false status: pending orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 paymentMethod: paymentType: picpay expiresIn: 1722971550 qrCodeData: >- 00020101021226860014COM.PICPAY.P2B0164https://app.picpay.com/checkout/NjY4YmZhNjA5OTdhNTU2YTNmMGRmZTIy5204000053039865802BR5906PICPAY6009SAO PAULO62280524668bfa60997a556a3f0dfe2280580020COM.PICPAY.ECOMMERCE0107nc=true0219checkout=stepbystep6304B9EE qrCodeImageUrl: https://.... paymentSource: sourceType: customer customerId: 1cdcf0c9-eb04-4e43-b9b2-b7a4acdead1f transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 72cecc64-2079-4128-8cb0-c5a4ed8fa995 providerType: PICPAY transactionId: 84d0ed42-0239-4618-b3b9-e31114bba17b amount: 150 authorizationNsu: null requestStatus: success requestType: authorization responseTs: 2633ms createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' ChargeDrip: summary: Exemplo resposta cobrança Drip value: id: 4cbF2516-b8c0-4222-a28d-2c7e22a9ebe1 clientId: 290f9fcc-2d89-11ee-be56-0242ac120002 merchantId: ba3f0dba-905d-4705-9e61-a75d6a6eca5d description: null orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 createdAt: '2022-09-30T21:33:42.955Z' amount: 150 originalAmount: 150 currency: BRL statementDescriptor: null status: pending paymentMethod: paymentType: drip maxInstallments: 4 paymentUrl: >- https://sandbox-portal.dripapp.com.br/checkouts/75624dd2-a897-4bb7-8f00-b959eb00b38d items: - id": '12345' quantity": 1 title": title item unitPrice": 150 browser: ipAddress: 127.0.0.1 browserFingerprint: cbd4a441-c63c-4dee-ac6b-bfa7fa1df818 cancelRedirectUrl: https://service-example.com/cancel successRedirectUrl: https://service-example.com/success paymentSource: sourceType: customer customerId: ae1b1f52-ee01-4014-9eb6-e529dd6d3f5f transactionRequests: - id: 1c57caad-136d-4bc4-a265-c72d408d5ef7 createdAt: '2022-09-30T21:33:42.969Z' updatedAt: '2022-09-30T21:33:44.105Z' idempotencyKey: 84d0ed42-0239-4618-b3b9-e31114bba17b providerId: 72cecc64-2079-4128-8cb0-c5a4ed8fa995 providerType: DRIP transactionId: 2c57caad-136d-4bc4-a265-c72d408d5ef8 amount: 150 authorizationCode: 4a87109c-80bc-44da-8170-87bb7d2c52be authorizationNsu: null requestStatus: success requestType: pending responseTs: 1084ms drip: paymentUrl: >- https://sandbox-portal.dripapp.com.br/checkouts/75624dd2-a897-4bb7-8f00-b959eb00b38d items: - id": '12345' quantity": 1 title": title item unitPrice": 150 browser: ipAddress: 127.0.0.1 browserFingerprint: cbd4a441-c63c-4dee-ac6b-bfa7fa1df818 cancelRedirectUrl: https://service-example.com/cancel successRedirectUrl: https://service-example.com/success ChargeVoucher: summary: Exemplo resposta cobrança Voucher value: id: e98d9db9-5c8e-4aa4-b408-7f0e8c53b4d1 clientId: 8b8ef36b-575f-4c74-8642-99e7d1a4b769 merchantId: a29d40e6-49d3-4f17-9a2e-20bd96f6b6d3 description: Charge description orderId: b7e59eeb-8e23-41d1-99d4-6b7c61a5d8e3 createdAt: '2023-11-13T16:54:00.645Z' amount: 100 originalAmount: 100 currency: BRL statementDescriptor: Voucher capture: false isDispute: false status: authorized paymentMethod: name: Customer test identity: '11111111111' billingAddress: city: São Paulo state: SP country: BR zipCode: '01714140' complement: complement items: id: '123' title: ItemTeste1 quantity: 1 unitPrice: 100 paymentType: voucher paymentSource: sourceType: card transactionRequests: id: b7e59eeb-8e23-41d1-99d4-6b7c61a5d8e3 createdAt: '2023-11-13T16:54:00.671Z' updatedAt: '2023-11-13T16:54:01.554Z' idempotencyKey: 43ebbbf7-64ec-4f87-91c0-63a8e3eb12a6 providerId: 32c68ff7-902c-408b-b464-cf487c7cda97 providerType: PAGARME_V5 transactionId: or_lka6LLKSflfOD5z2m amount: 100 authorizationCode: '704' authorizationNsu: '88571' requestStatus: success requestType: authorization responseTs: 795ms ChargeApplePayResponse: summary: Exemplo resposta cobrança Apple Pay crédito value: id: 148d5db0-f1c3-439f-902d-f1f268086e1d clientId: cc0b1e41-2936-45c5-947f-93995ffcdc00 createdAt: 2012-06-30 23:59:59 +0000 amount: 150 currency: BRL orderId: 32c68ff7-902c-408b-b464-cf487c7cda97 statementDescriptor: LOJA JOAO description: Descrição longa da cobrança capture: false isDispute: false responsibleProviderType: CIELO status: pre_authorized paymentMethod: paymentType: apple_pay installments: 1 paymentSource: sourceType: wallet cardId: 148d5db0-f1c3-439f-902d-f1f268086e1d transactionRequests: - id: 78601913-a176-4d71-b7e8-abb6fc49a340 idempotencyKey: fafe857b176e45d6b12e32fcaf228996 providerId: 2c3b57d8-ee43-4b19-bc8a-949a88c51df1 providerType: CIELO transactionId: ch_3JYE7MHjGFBGEeiP0lfTD3Ob amount: 1500 authorizationNsu: 1cc8391c-f0d5-4b7a-9fcf-653cea26be13 requestStatus: success requestType: authorization responseTs: 2633ms createdAt: '2021-08-12T16:08:39.536Z' updatedAt: '2021-08-12T16:08:42.212Z' providerAuthorization: networkAuthorizationCode: '00' networkResponseCode: '' appInfo: platform: integrator: malga name: pluging-vtex-ppp version: '1.12' device: name: iOS version: '10.12' system: name: VTEX version: '13.12' securitySchemes: X-Client-ID: type: apiKey in: header name: X-Client-Id X-Api-Key: type: apiKey in: header name: X-Api-Key ````