Pular para o conteúdo principal

Documentação Malga API (0.5)

Download OpenAPI specification:Download

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

  curl --location --request GET 'https://api.malga.io/v1/' \
    --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
    --header 'X-Api-Key: <YOUR_SECRET_KEY>'

Client-token

É 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:

scope
string
Enum: "tokens" "charges" "cards" "webhooks"

determina o escopo de endpoints que a chave terá acesso

expires
number
Default: 0

prazo de validade da chave em segundos a partir da criação, zero para não expirar

{
}

Retorno da chamada de criação da chave pública:

scope
string
Enum: "tokens" "charges" "cards" "webhooks"

determina o escopo de endpoints que a chave terá acesso

expires
number

prazo de validade da chave em segundos a partir da criação, zero para não expirar

clientId
string <uuid>

identificador do cliente na Malga

publicKey
string <uuid>

chave pública criada

{
}

Criar nova chave pública para uso no client-side

Authorizations:
Request Body schema: application/json

Creat authentication token

scope
string
Enum: "tokens" "charges" "cards" "webhooks"

determina o escopo de endpoints que a chave terá acesso

expires
number
Default: 0

prazo de validade da chave em segundos a partir da criação, zero para não expirar

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Tokens

Dados básicos de uma requisição de criação de card token

cardHolderName
required
string

Nome do portador do cartão

cardNumber
required
string

Número do cartão (Sem espaços)

cardCvv
required
string

Código de verificação

cardExpirationDate
required
string

Mês e ano de validade no formato MM/YYYY

{
}

Criar novo token de cartão

Authorizations:
Request Body schema: application/json

Tokenize credit card

cardHolderName
required
string

Nome do portador do cartão

cardNumber
required
string

Número do cartão (Sem espaços)

cardCvv
required
string

Código de verificação

cardExpirationDate
required
string

Mês e ano de validade no formato MM/YYYY

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Cards

Dados básicos de um objeto cartão

id
string

ID do cartão

expirationMonth
string

Data de expiração MM

expirationYear
string

Data de expiração YYYY

brand
string
Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners"

Bandeira

cvvChecked
boolean

Identifica se o CVV foi verificado

fingerprint
string

Hash de identificação única do cartão com base nos dados sensíveis

first6digits
string

Primeiros 6 digitos do cartão

last4digits
string

Últimos 4 digitos do cartão

status
string
Enum: "failed" "active" "pending"

Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente)

statusReason
string

Contém uma string com um breve descritivo informando o motivo do status do cartão. Em alguns casos uma string vazia é retornada.

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object
id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

{
}

Criar novo cartão a partir de token

Authorizations:
Request Body schema: application/json

Create credit card

tokenId
required
string <uuid>

Identificador do token gerado

merchantId
string <uuid>

Caso queria validar o cartão via zero dollar, informe o merchantId que possui pelo menos 1 provedor com suporte a validação zero dollar.

cvvCheck
boolean

Mesmo informando o merchantId, é possível desabilitar a validação do cvv (zero dollar). Informe true para validar ou false para pular a validação. Caso você informe false, a verificação será pulada e o cartão será criado como pending necessitando validar via uma transação.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Listar cartões

Authorizations:
query Parameters
page
number

número da página

limit
number

quantidade de itens por página

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

items
array

Response samples

Content type
application/json
{
}

Recuperar detalhes de cartão

Authorizations:
path Parameters
id
required
string <uuid>

ID do cartão

Responses

Response Schema: application/json
id
string

ID do cartão

expirationMonth
string

Data de expiração MM

expirationYear
string

Data de expiração YYYY

brand
string
Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners"

Bandeira

cvvChecked
boolean

Identifica se o CVV foi verificado

fingerprint
string

Hash de identificação única do cartão com base nos dados sensíveis

first6digits
string

Primeiros 6 digitos do cartão

last4digits
string

Últimos 4 digitos do cartão

status
string
Enum: "failed" "active" "pending"

Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente)

statusReason
string

Contém uma string com um breve descritivo informando o motivo do status do cartão. Em alguns casos uma string vazia é retornada.

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object
id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

Response samples

Content type
application/json
{
}

Customers

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 anti fraude 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 para criação de customer

Fluxo básico de associação de cartão com customer

  • Crie um customer informando os dados básicos de identificação e endereço
  • Crie um novo token de cartão a partir dos dados do portador
  • Crie um novo card a partir do token gerado e guarde o cardId gerado para associação futura com o customer
  • Associe o card criado com o customer criado através do serviço de associação de cartão com comprador
  • Liste os cartões vinculados ao comprador através do serviço de listagem de cartões por customer
  curl --location --request POST 'https://api.malga.io/v1/customers' \
    --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
    --header 'X-Api-Key: <YOUR_SECRET_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "name": "Jose Bonifacio Da Silveira",
        "phoneNumber": "21 98889999099",
        "email": "jose@gmail.com",
        "document": {
            "number": "72912053013",
            "type": "cpf",
            "country": "BR"
        },
        "address": {
            "country": "BR",
            "state": "Rio de Janeiro",
            "city": "Rio de Janeiro",
            "district": "Leblon",
            "zipCode": "25650-011",
            "street": "Av Geraldo Cardoso",
            "streetNumber": "205",
            "complement": "Apto 203"
        }
    }'

Fluxo básico de cobrança por PIX/Boleto a partir de customer

  • Crie um customer informando os dados básicos de identificação e endereço
  • Crie um novo charge informando como paymentSource o customer criado previamente, dessa forma iremos utilizar os dados do comprador para geração da cobrança.

Dados básicos de um objeto do tipo customer

id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

{
}

Criação de novo customer para cobrança

Authorizations:
Request Body schema: application/json
name
required
string

nome do usuario

email
required
string

email do usuario

phoneNumber
required
string

telefone de contato do usuario

required
object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

Responses

Request samples

Content type
application/json
{
}

Listagem de customers cadastrados

Authorizations:
query Parameters
page
number

número da página

limit
number

quantidade de itens por página

sort
string
Enum: "ASC" "DESC"

ordenação dos itens

id
string

identificador de um customer

document.type
string

tipo de documento

document.number
string

numero do documento

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

object
id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

Response samples

Content type
application/json
{
}

Recuperar detalhes de customer

Authorizations:
path Parameters
id
required
string <uuid>

id do customers que deseja recuperar

Responses

Response Schema: application/json
id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

Response samples

Content type
application/json
{
}

Deletar customer pelo id

Authorizations:
path Parameters
id
required
string <uuid>

id do customers que deseja deletar

Responses

Atualizar customer pelo id

Authorizations:
path Parameters
id
required
string <uuid>

id do customers que deseja alterar

Request Body schema: application/json
name
string

nome do usuario

phoneNumber
string

telefone de contato do usuario

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

Responses

Request samples

Content type
application/json
{
}

Adicionar cartão de crédito ao customer

Authorizations:
path Parameters
customer_id
required
string <uuid>

id do customers que deseja alterar

Request Body schema: application/json
cardId
required
string

Identificador do cartão a ser associado

Responses

Request samples

Content type
application/json
{
}

Listagem dos cartões do customer

Authorizations:
path Parameters
customer_id
required
string <uuid>

id do customers que deseja alterar

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

items
array

Response samples

Content type
application/json
{
}

Charges

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

id
string

identificador da transação

clientId
string <uuid>

identificador do cliente na Malga

merchantId
string <uuid>

identificador do merchant id utilizado na transação

customerId
string <uuid>

identificador do customer id

description
string

Descrição da cobrança para consulta futura

amount
number

valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

statementDescriptor
string

descrição a ser exibida na fatura do comprador

capture
boolean

determina se a transação deve ser capturada automaticamente

isDispute
boolean

determina se a transação está em disputa

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

status da transação na Malga

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança

cardId
required
string <uuid>

Identificador do cartão quando source tipo card

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object

Parâmetros adicionais para analise de fraude

object

Dados do comprador

name
string

nome do usuario

email
string

email do usuario

phone
string

telefone de contato do usuario

identityType
string

tipo de documento, consultar tabela de tipos suportados

identity
string

numero do documento formato conforme tipo selecionado

registrationDate
string

data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do produto

quantity
integer

quantidade de items comprados

sku
string

identificador unico do produto na loja

unitPrice
integer

valor unitario do produto em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do produto

description
string

descrição do item

categoryId
string

categoria a qual o item pertence

object

Campos adicionais para uso em condicionais dos fluxos inteligentes

metadata
required
object

Campos adicionais da transação enviados na criação da mesma

Array of objects (TransactionRequest) [ items ]
Array
id
string

identificador único do request feito ao provedor

providerId
string <uuid>

identificador do provider que processou a requisiçao, consulte a lista de providers configurados na sua conta

providerType
string

código que identifica o provedor, consultar tabela de provedores suportados pela Malga

idempotencyKey
string

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
string
Deprecated

identificador único da transação retornado pelo provider

transactionId
string

identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

identifica o tipo da requisição feita para o provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status do processamento da requisição no provider

amount
number

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
string

tempo de duração do processamento da requisição no provider

object

detalhes do erro em caso de falha no processamento da transação

object

dados adicionais do retorno da autorização do provider no processamento da transação

createdAt
string

Data de criação do request feito ao provedor

updatedAt
string

Data de atualização do request feito ao provedor

object (3DSecure2Response)
redirectURL
string

URL para redirecionamento de autenticação

requestorURL
string

URL de origem da requisição

object

Informações sobre o navegador do usuário

acceptHeader
string

O Accept do cabeçalho de requisição HTTP

colorDepth
number

A profundidade de cores da tela

javaEnabled
boolean

Se Java está habilitado

javaScriptEnabled
boolean

Se javaScript está habilitado

language
string

A linguagem utilizada pelo sistema do usuário

screenHeight
number

Altura da tela

screenWidth
number

Largura da tela

timeZoneOffset
string

Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual

userAgent
string

O User-Agent do cabeçalho de requisição HTTP

ip
string

Endereço de ip do usuário

object

Endereço de cobrança

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

email
string

Email

mobilePhone
string

Telefone celular

object

Dados de autenticação do provedor

action
string
Value: "REDIRECT"

Tipo de ação exigida pelo provedor

providerType
string
Value: "ADYEN"

Nome do provedor

responseType
string
Enum: "AUTHENTICATION" "AUTHORIZATION"

Identifica a etapa do desafio

response
object

O object retornado do provedor com dados para autenticação ou autorização

{
}

Realizar nova cobrança

Authorizations:
Request Body schema: application/json
merchantId
required
string <uuid>

Identificação do merchant id a ser utilizado

amount
required
number

Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

statementDescriptor
string

Descrição a ser exibida fatura do comprador

capture
boolean
Default: false

Determina se a transação deve ser capturada automaticamente

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

description
string

Descrição da cobrança para consulta futura

customerId
string <uuid>

Identificador de comprador para consulta futura

required
PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object) or PaymentMethodNuPay (object)

Define o método de cobrança

One of
paymentType
required
string
Enum: "credit" "debit"

Método da cobrança via Cartão Crédito/Débito

installments
number

Quantidade de parcelas para cobrança do tipo credito

required
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object)
One of
sourceType
required
string
Value: "card"

Tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string <uuid>

Identificador do cartão quando source tipo card (opcional)

cardCvv
string

Código de verificação cobrança sem tokenização, deve ser enviado sempre que o comprador estiver presente no momento da compra (opcional)

object

Parâmetros adicionais para analise de fraude, obrigatório quando anti-fraude ligado.

object

Dados do comprador

name
string

nome do usuario

email
string

email do usuario

phone
string

telefone de contato do usuario

identityType
string

tipo de documento, consultar tabela de tipos suportados

identity
string

numero do documento formato conforme tipo selecionado

registrationDate
string

data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

informações sobre o navegador do usuário

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do produto

quantity
integer

quantidade de items comprados

sku
string

identificador unico do produto na loja

unitPrice
integer

valor unitario do produto em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do produto

description
string

descrição do item

categoryId
string

categoria a qual o item pertence

object

Detalhes do aparelho do consumidor

object
model
string

modelo do aparelho

ramCapacity
integer

capacidade da memória RAM do aparelho

diskCapacity
integer

capacidade de armazenamento do aparelho

freeDiskSpace
integer

quantidade de memória livre

resolution
integer

resolução do aparelho

Array of objects[ items ]
object

atributos do aparelho fornecidos pelo fornecedor

Array of objects (SplitRules) [ items ]

Parâmetros adicionais para transacionar com Split

Array
sellerId
string <uuid>

identificador do recebedor já cadastrado na API de sellers

percentage
number

porcentagem do valor da transação que será enviada ao recebedor

amount
number

valor que será enviada ao recebedor

processingFee
boolean

indica se o recebedor vinculado à regra será cobrado pelas taxas da transação

liable
boolean

indica se o recebedor atrelado assumirá os riscos de chargeback da transação

object (SplitRulesFaresSchema)

Informações sobre as taxas que serão cobradas do recebedor - Apenas para sellers com provedor Braspag

object

Campos adicionais para uso em condicionais dos fluxos inteligentes

metadata
required
object

Campos adicionais da transação enviados na criação da mesma

object

Parâmetros adicionais para transacionar com 3D Secure 2

redirectURL
required
string

URL para redirecionamento de autenticação

requestorURL
required
string

URL de origem da requisição

required
object

Informações sobre o navegador do usuário

acceptHeader
required
string

O Accept do cabeçalho de requisição HTTP

colorDepth
required
number

A profundidade de cores da tela

javaEnabled
required
boolean

Se Java está habilitado

javaScriptEnabled
boolean

Se javaScript está habilitado

language
required
string

A linguagem utilizada pelo sistema do usuário

screenHeight
required
number

Altura da tela

screenWidth
required
number

Largura da tela

timeZoneOffset
required
string

Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual

userAgent
required
string

O User-Agent do cabeçalho de requisição HTTP

ip
required
string

Endereço de ip do usuário

object

Endereço de cobrança

city
required
string

Cidade

country
required
string

Padrão ISO 3166-1 alpha-2

streetNumber
required
string

Número da rua

zipCode
required
string

Codigo postal CEP

state
required
string

Estado

street
required
string

Rua

object

Endereço para envio

city
required
string

Cidade

country
required
string

Padrão ISO 3166-1 alpha-2

streetNumber
required
string

Número da rua

zipCode
required
string

Codigo postal CEP

state
required
string

Estado

street
required
string

Rua

object

Endereço para envio

email
required
string

Email

mobilePhone
string

Telefone celular

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
Example
{
}

Listar cobranças

Authorizations:
query Parameters
page
number

numero da pagina ativa

limit
number

quantidade de registros por página 1-100

sort
string
Enum: "ASC" "DESC"

tipo de ordenação decrescente ou crescente

merchantId
string <uuid>

id do merchant processado na cobrança

id
string <uuid>

id da cobrança

originalAmount
number

valor em centavos da cobrança

status
string
Enum: "pending" "pre_authorized" "authorized" "voided" "refund_pending" "canceled" "charged_back"

status da cobrança

paymentType
string
Enum: "credit" "pix" "boleto"

tipo de pagamento

orderId
string

id da cobrança gerado pelo cliente

created
string
Example: created=2022-03-12T12:43:53

registros criados em uma data específica

created.gt
string
Example: created.gt=2022-03-12T12:43:53

registros com data maior que

created.lt
string
Example: created.lt=2022-03-12T12:43:53

registros com data menor que

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

items
array

Response samples

Content type
application/json
{
}

Recuperar detalhes de cobrança

Authorizations:
path Parameters
id
required
string <uuid>

id da cobrança que deseja recuperar

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

items
array

Response samples

Content type
application/json
{
}

Alterar o status de uma cobrança no ambiente de sandbox

Authorizations:
path Parameters
id
required
string <uuid>

id da cobrança que deseja alterar no sandbox

Request Body schema: application/json
status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "charged_back" "created" "processed" "capture_pending" "refund_pending"

status da transação

Responses

Response Schema: application/json
id
string

identificador da transação

clientId
string <uuid>

identificador do cliente na Malga

merchantId
string <uuid>

identificador do merchant id utilizado na transação

customerId
string <uuid>

identificador do customer id

description
string

Descrição da cobrança para consulta futura

amount
number

valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

statementDescriptor
string

descrição a ser exibida na fatura do comprador

capture
boolean

determina se a transação deve ser capturada automaticamente

isDispute
boolean

determina se a transação está em disputa

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

status da transação na Malga

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança

cardId
required
string <uuid>

Identificador do cartão quando source tipo card

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object

Parâmetros adicionais para analise de fraude

object

Dados do comprador

name
string

nome do usuario

email
string

email do usuario

phone
string

telefone de contato do usuario

identityType
string

tipo de documento, consultar tabela de tipos suportados

identity
string

numero do documento formato conforme tipo selecionado

registrationDate
string

data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do produto

quantity
integer

quantidade de items comprados

sku
string

identificador unico do produto na loja

unitPrice
integer

valor unitario do produto em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do produto

description
string

descrição do item

categoryId
string

categoria a qual o item pertence

object

Campos adicionais para uso em condicionais dos fluxos inteligentes

metadata
required
object

Campos adicionais da transação enviados na criação da mesma

Array of objects (TransactionRequest) [ items ]
Array
id
string

identificador único do request feito ao provedor

providerId
string <uuid>

identificador do provider que processou a requisiçao, consulte a lista de providers configurados na sua conta

providerType
string

código que identifica o provedor, consultar tabela de provedores suportados pela Malga

idempotencyKey
string

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
string
Deprecated

identificador único da transação retornado pelo provider

transactionId
string

identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

identifica o tipo da requisição feita para o provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status do processamento da requisição no provider

amount
number

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
string

tempo de duração do processamento da requisição no provider

object

detalhes do erro em caso de falha no processamento da transação

object

dados adicionais do retorno da autorização do provider no processamento da transação

createdAt
string

Data de criação do request feito ao provedor

updatedAt
string

Data de atualização do request feito ao provedor

object (3DSecure2Response)
redirectURL
string

URL para redirecionamento de autenticação

requestorURL
string

URL de origem da requisição

object

Informações sobre o navegador do usuário

acceptHeader
string

O Accept do cabeçalho de requisição HTTP

colorDepth
number

A profundidade de cores da tela

javaEnabled
boolean

Se Java está habilitado

javaScriptEnabled
boolean

Se javaScript está habilitado

language
string

A linguagem utilizada pelo sistema do usuário

screenHeight
number

Altura da tela

screenWidth
number

Largura da tela

timeZoneOffset
string

Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual

userAgent
string

O User-Agent do cabeçalho de requisição HTTP

ip
string

Endereço de ip do usuário

object

Endereço de cobrança

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

email
string

Email

mobilePhone
string

Telefone celular

object

Dados de autenticação do provedor

action
string
Value: "REDIRECT"

Tipo de ação exigida pelo provedor

providerType
string
Value: "ADYEN"

Nome do provedor

responseType
string
Enum: "AUTHENTICATION" "AUTHORIZATION"

Identifica a etapa do desafio

response
object

O object retornado do provedor com dados para autenticação ou autorização

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Capturar cobrança pre-autorizada

Authorizations:
path Parameters
id
required
string <uuid>

id da cobrança que deseja capturar

Request Body schema: application/json
amount
number

valor da captura em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Estornar cobrança aprovada

Authorizations:
path Parameters
id
required
string <uuid>

id da cobrança que deseja estornar

Request Body schema: application/json
amount
number

valor do estorno em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00

delayToCompose
number

número de dias para compor o valor a ser estornado. Utilizado apenas pela NuPay.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Sessions

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

id
string

Identificação da sessão a ser utilizada

name
string

Nome que identifica a sessão

status
string
Enum: "created" "paid" "canceled" "voided"

Status da sessão

isActive
boolean

Determina se a sessão está ativa

clientId
string

Identificador do cliente na Malga

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

amount
number

Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string

Identificador da moeda para processamento da cobrança, formato ISO 4217.

capture
boolean

Determina se a transação deve ser capturada automaticamente

merchantId
string

Identificação do merchant id a ser utilizado

dueDate
string

Data de expiração de uma sessão

description
string

Descrição da sessão

statementDescriptor
string

Descrição a ser exibida fatura do comprador

Array of objects (SessionItemObject) [ items ]

Itens do pedido

Array
name
string

Nome do item da sessão

description
string

Descrição do item da sessão

unitPrice
number

Preço unitário em centavos do item, exemplo 100 para cobrar R$ 1,00

quantity
number

Define a quantidade de itens

tangible
boolean

Determina se o item é tangível

paymentLink
string

Link para acessar o Link de Pagamento desta sessão

PaymentMethodCardObject (array) or PaymentMethodPixObject (array) or PaymentMethodBoletoObject (array)

Métodos de pagamento disponíveis na sessão

One of
array
createdAt
string

Data de criação da sessão

updatedAt
string

Data da atualização da sessão

publicKey
string

Chave de acesso com escopo restrito, usada para pagar a sessão

{
}

Criar nova sessão

Authorizations:
Request Body schema: application/json
orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

amount
required
number

Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

isActive
boolean

Determina se a sessão está ativa

capture
boolean

Determina se a transação deve ser capturada automaticamente

merchantId
required
string

Identificação do merchant id a ser utilizado

dueDate
required
string

Data de expiração de uma sessão

name
required
string

Nome que identifica a sessão

description
string

Descrição da sessão

statementDescriptor
string

Descrição a ser exibida fatura do comprador

createLink
boolean

Determina se a sessão terá um Link de Pagamento

required
PaymentMethodCardObject (object) or PaymentMethodPixObjectRequest (object) or PaymentMethodBoletoObjectRequest (object)

Métodos de pagamento disponíveis na sessão

Any of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

required
Array of objects (SessionItemObject) [ items ]

Itens do pedido

Array
name
string

Nome do item da sessão

description
string

Descrição do item da sessão

unitPrice
number

Preço unitário em centavos do item, exemplo 100 para cobrar R$ 1,00

quantity
number

Define a quantidade de itens

tangible
boolean

Determina se o item é tangível

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Recuperar detalhes de uma sessão

Authorizations:
path Parameters
id
required
string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type
application/json
{
}

Atualizar o status de uma sessão

Authorizations:
path Parameters
id
required
string <uuid>

Identificação da sessão a ser alterada

Responses

Response samples

Content type
application/json
{
}

Pagar uma sessão

Authorizations:
path Parameters
id
required
string <uuid>

Identificação da sessão a ser paga

Request Body schema: application/json
customerId
string <uuid>

Identificador de comprador para consulta futura

required
PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object)

Define o método de cobrança

One of
paymentType
required
string
Enum: "credit" "debit"

Método da cobrança via Cartão Crédito/Débito

installments
number

Quantidade de parcelas para cobrança do tipo credito

required
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object)
One of
sourceType
required
string
Value: "card"

Tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string <uuid>

Identificador do cartão quando source tipo card (opcional)

cardCvv
string

Código de verificação cobrança sem tokenização, deve ser enviado sempre que o comprador estiver presente no momento da compra (opcional)

object

Parâmetros adicionais para analise de fraude, obrigatório quando anti-fraude ligado.

object

Dados do comprador

name
string

nome do usuario

email
string

email do usuario

phone
string

telefone de contato do usuario

identityType
string

tipo de documento, consultar tabela de tipos suportados

identity
string

numero do documento formato conforme tipo selecionado

registrationDate
string

data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

informações sobre o navegador do usuário

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do produto

quantity
integer

quantidade de items comprados

sku
string

identificador unico do produto na loja

unitPrice
integer

valor unitario do produto em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do produto

description
string

descrição do item

categoryId
string

categoria a qual o item pertence

object

Detalhes do aparelho do consumidor

object
model
string

modelo do aparelho

ramCapacity
integer

capacidade da memória RAM do aparelho

diskCapacity
integer

capacidade de armazenamento do aparelho

freeDiskSpace
integer

quantidade de memória livre

resolution
integer

resolução do aparelho

Array of objects[ items ]
object

atributos do aparelho fornecidos pelo fornecedor

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
Example
{
}

Cancelar uma sessão

Authorizations:
path Parameters
id
required
string <uuid>

Identificação da sessão a ser cancelada

Responses

Response samples

Content type
application/json
{
}

Recuperar o histórico da sessão

Authorizations:
path Parameters
id
required
string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type
application/json
[
]

Recupera sessão com os dados das configurações da empresa

Authorizations:
path Parameters
id
required
string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type
application/json
{
}

Sellers

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.

Observe que os campos owner e business são opcionais. Entretanto se o provider for Zoop e o campo business for enviado, o owner se torna obrigatório.

merchantId
required
string

identificação do merchant id a ser utilizado

mcc
required
number

código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code.

object
name
string

nome do estabelecimento do recebedor

phoneNumber
string

telefone de contato do estabelecimento do recebedor

email
string

email do estabelecimento do recebedor

openingDate
string

data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

object
name
string

nome que identifica o recebedor

phoneNumber
string

telefone de contato do recebedor

email
string

email do recebedor

birthdate
string

data de nascimento do recebedor em ISO-Date, ex 1996-01-31

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

required
object
holderName
string

nome que identifica o portador da conta bancária

holdeType
string
Enum: "individual" "company"

identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'

holderDocument
string

documento do portador da conta bancária

bank
string

código do banco

branchNumber
string

número da agência bancária

branchCheckDigit
string

código verificador da agência bancária

accountNumber
string

número da conta bancária

accountDigit
string

número verificador da conta bancária

type
string
Enum: "conta_corrente" "poupanca"

tipo de conta.

required
object
transferInterval
string
Enum: "daily" "weekly" "monthly"

intervalo entre as transferências.

transferDay
string

dia no qual o parceiro será pago. Depende do transfer_interval - se for daily, enviar 1. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31. Além disso, se for daily e o provedor for Pagarme, o valor é 0.

transferEnabled
boolean

determina se as transferências estão autorizadas a acontecer ou não.

{
}

Criar um novo recebedor

Authorizations:
Request Body schema: application/json
merchantId
string

identificação do merchant

mcc
string

código de segmento do lojista no adquirente

Array of objects (SellerProviders) [ items ]
Array
id
string <uuid>

identificação do provedor

providerType
string
Value: "SANDBOX"

nome do provedor

status
string

status do recebedor

createdAt
string

data de criação

updatedAt
string

data de edição

object
name
string

nome do estabelecimento do recebedor

phoneNumber
string

telefone de contato do estabelecimento do recebedor

email
string

email do estabelecimento do recebedor

openingDate
string

data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

object
name
string

nome que identifica o recebedor

phoneNumber
string

telefone de contato do recebedor

email
string

email do recebedor

birthdate
string

data de nascimento do recebedor em ISO-Date, ex 1996-01-31

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

object
holderName
string

nome que identifica o portador da conta bancária

holdeType
string
Enum: "individual" "company"

identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'

holderDocument
string

documento do portador da conta bancária

bank
string

código do banco

branchNumber
string

número da agência bancária

branchCheckDigit
string

código verificador da agência bancária

accountNumber
string

número da conta bancária

accountDigit
string

número verificador da conta bancária

type
string
Enum: "conta_corrente" "poupanca"

tipo de conta.

object
transferInterval
string
Enum: "daily" "weekly" "monthly"

intervalo entre as transferências.

transferDay
string

dia no qual o parceiro será pago. Depende do transfer_interval - se for daily, enviar 1. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31. Além disso, se for daily e o provedor for Pagarme, o valor é 0.

transferEnabled
boolean

determina se as transferências estão autorizadas a acontecer ou não.

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
Example
{
}

Recuperar seller pelo id

Authorizations:
path Parameters
id
required
string <uuid>

id do seller

Responses

Response Schema: application/json
merchantId
string

identificação do merchant

mcc
string

código de segmento do lojista no adquirente

Array of objects (SellerProviders) [ items ]
Array
id
string <uuid>

identificação do provedor

providerType
string
Value: "SANDBOX"

nome do provedor

status
string

status do recebedor

createdAt
string

data de criação

updatedAt
string

data de edição

object
name
string

nome do estabelecimento do recebedor

phoneNumber
string

telefone de contato do estabelecimento do recebedor

email
string

email do estabelecimento do recebedor

openingDate
string

data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

object
name
string

nome que identifica o recebedor

phoneNumber
string

telefone de contato do recebedor

email
string

email do recebedor

birthdate
string

data de nascimento do recebedor em ISO-Date, ex 1996-01-31

object
type
required
string

tipo de documento, consultar tabela de tipos suportados

number
required
string

numero do documento formato conforme tipo selecionado

country
string
Default: "BR"

pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
country
string

Padrão ISO 3166-1 alpha-2

state
string

Estado

city
string

Cidade

district
string

Bairro

zipCode
string

Codigo postal CEP

street
string

Nome da rua/avenida/travessa

streetNumber
string

Numero da rua

complement
string

Complemento caso exista

object
holderName
string

nome que identifica o portador da conta bancária

holdeType
string
Enum: "individual" "company"

identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'

holderDocument
string

documento do portador da conta bancária

bank
string

código do banco

branchNumber
string

número da agência bancária

branchCheckDigit
string

código verificador da agência bancária

accountNumber
string

número da conta bancária

accountDigit
string

número verificador da conta bancária

type
string
Enum: "conta_corrente" "poupanca"

tipo de conta.

object
transferInterval
string
Enum: "daily" "weekly" "monthly"

intervalo entre as transferências.

transferDay
string

dia no qual o parceiro será pago. Depende do transfer_interval - se for daily, enviar 1. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31. Além disso, se for daily e o provedor for Pagarme, o valor é 0.

transferEnabled
boolean

determina se as transferências estão autorizadas a acontecer ou não.

Response samples

Content type
application/json
Example
{
}

Webhooks

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:

id
string

identificador único do evento, também enviado no header

createdAt
string

data de criação do evento

object
string

Tipo do objeto atualizado

event
string

Tipo do evento de atualização que ocorreu no objeto atualizado

apiVersion
number

Versão da api da Malga que seu webhook implementa

data
object

Dados do objeto alterado com base na definição do schema de cada objeto

{
}

Criação de novo webhook para notificação

Authorizations:
Request Body schema: application/json
event
required
string

Evento que deseja receber notificações no seu webhook conforme descrito na seção Eventos suportados para notificação via webhooks. Deve ser criado um webhook para cada evento, podendo ser utilizado o wildcard * no lugar do evento para receber todos os eventos em um único webhook.

endpoint
required
string

URL do seu sistema que deverá receber as notificações de evento

version
required
number
Default: 1.1

Versão da api da Malga que seu webhook implementa

status
required
boolean
Default: true
Enum: true false

Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
}

Listagem de webhooks cadastrados

Authorizations:
query Parameters
page
number

número da página

limit
number

quantidade de itens por página

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

object
id
string

identificador do webhook

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

event
string

Tipo do evento que deseja receber notificações no seu webhook

endpoint
string

URL do seu sistema que deverá receber as notificações de evento

version
number
Default: 1.1

Versão da api da Malga que seu webhook implementa

publicKey
string

Chave pública ed25519

status
boolean
Default: true

Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga

Response samples

Content type
application/json
{
}

Recuperar detalhes de webhook

Authorizations:
path Parameters
id
required
string <uuid>

id do webhook que deseja recuperar

Responses

Response Schema: application/json
id
string

identificador do webhook

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

event
string

Tipo do evento que deseja receber notificações no seu webhook

endpoint
string

URL do seu sistema que deverá receber as notificações de evento

version
number
Default: 1.1

Versão da api da Malga que seu webhook implementa

publicKey
string

Chave pública ed25519

status
boolean
Default: true

Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga

Response samples

Content type
application/json
{
}

Deletar webhook pelo id

Authorizations:
path Parameters
id
required
string <uuid>

id do webhook que deseja deletar

Responses

Atualizar webhook pelo id

Authorizations:
path Parameters
id
required
string <uuid>

id do webhook que deseja alterar

Request Body schema: application/json
event
required
string

Evento que deseja receber notificações no seu webhook conforme descrito na seção Eventos suportados para notificação via webhooks. Deve ser criado um webhook para cada evento, podendo ser utilizado o wildcard * no lugar do evento para receber todos os eventos em um único webhook.

endpoint
required
string

URL do seu sistema que deverá receber as notificações de evento

version
required
number
Default: 1.1

Versão da api da Malga que seu webhook implementa

status
required
boolean
Default: true
Enum: true false

Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga

Responses

Request samples

Content type
application/json
{
}

Merchants

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 para cadastro de credenciais

Consulte a tabela de código MCC para cadastro de Merchants

Dados básicos do objeto do tipo merchant

id
string

dentificador do merchant

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

mcc
string

codigo mcc do cadatro do lojista no adquirente

status
string
Enum: "active" "deleted" "pending"

status do merchant

object (ProviderDto)
name
required
string

nome opcional de identificação do provedor

priority
required
number

define a prioridade do provedor no roteamento da transação, (usar 1 para o prioritário)

required
PagSeguro (object) or Pagarme (object) or Cielo (object) or Braspag (object) or BS2 (object) or BS2_BOLETO (object) or BB (object) or Braintree (object) or Klap (object) or Zoop (object) or Stripe (object) or Rede (object) or MercadoPago (object) or Clearsale (object) or NuPay (object) or Adyen (object) or Getnet (object)
One of
type
required
string
Value: "PAGSEGURO"
token
required
string

Token de uso na API V4 da pagseguro

email
required
string

Email do usuário da conta principal da paseguro

ClearsaleOptions (object) or NuPayOptions (object)
One of
type
required
string
Value: "ANTIFRAUD"
captureOnError
boolean

Captura a transação em caso de erro no provedor antifraude

refundOnError
boolean

Estorna a transação em caso de erro no provedor antifraude

{
}

Criação de novo merchant para cobrança

Authorizations:
Request Body schema: application/json
mcc
required
string

código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code.

object (ProviderDto)
name
required
string

nome opcional de identificação do provedor

priority
required
number

define a prioridade do provedor no roteamento da transação, (usar 1 para o prioritário)

required
PagSeguro (object) or Pagarme (object) or Cielo (object) or Braspag (object) or BS2 (object) or BS2_BOLETO (object) or BB (object) or Braintree (object) or Klap (object) or Zoop (object) or Stripe (object) or Rede (object) or MercadoPago (object) or Clearsale (object) or NuPay (object) or Adyen (object) or Getnet (object)
One of
type
required
string
Value: "PAGSEGURO"
token
required
string

Token de uso na API V4 da pagseguro

email
required
string

Email do usuário da conta principal da paseguro

ClearsaleOptions (object) or NuPayOptions (object)
One of
type
required
string
Value: "ANTIFRAUD"
captureOnError
boolean

Captura a transação em caso de erro no provedor antifraude

refundOnError
boolean

Estorna a transação em caso de erro no provedor antifraude

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Listagem de merchants cadastrados

Authorizations:
query Parameters
page
number

número da página

limit
number

quantidade de itens por página

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

object
id
string

dentificador do merchant

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

mcc
string

codigo mcc do cadatro do lojista no adquirente

status
string
Enum: "active" "deleted" "pending"

status do merchant

object (ProviderDto)
name
required
string

nome opcional de identificação do provedor

priority
required
number

define a prioridade do provedor no roteamento da transação, (usar 1 para o prioritário)

required
PagSeguro (object) or Pagarme (object) or Cielo (object) or Braspag (object) or BS2 (object) or BS2_BOLETO (object) or BB (object) or Braintree (object) or Klap (object) or Zoop (object) or Stripe (object) or Rede (object) or MercadoPago (object) or Clearsale (object) or NuPay (object) or Adyen (object) or Getnet (object)
ClearsaleOptions (object) or NuPayOptions (object)

Response samples

Content type
application/json
{
}

Recuperar detalhes de merchant pelo id

Authorizations:
path Parameters
id
required
string <uuid>

id do merchant

Responses

Response Schema: application/json
id
string

dentificador do merchant

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

mcc
string

codigo mcc do cadatro do lojista no adquirente

status
string
Enum: "active" "deleted" "pending"

status do merchant

object (ProviderDto)
name
required
string

nome opcional de identificação do provedor

priority
required
number

define a prioridade do provedor no roteamento da transação, (usar 1 para o prioritário)

required
PagSeguro (object) or Pagarme (object) or Cielo (object) or Braspag (object) or BS2 (object) or BS2_BOLETO (object) or BB (object) or Braintree (object) or Klap (object) or Zoop (object) or Stripe (object) or Rede (object) or MercadoPago (object) or Clearsale (object) or NuPay (object) or Adyen (object) or Getnet (object)
One of
type
required
string
Value: "PAGSEGURO"
token
required
string

Token de uso na API V4 da pagseguro

email
required
string

Email do usuário da conta principal da paseguro

ClearsaleOptions (object) or NuPayOptions (object)
One of
type
required
string
Value: "ANTIFRAUD"
captureOnError
boolean

Captura a transação em caso de erro no provedor antifraude

refundOnError
boolean

Estorna a transação em caso de erro no provedor antifraude

Response samples

Content type
application/json
{
}

Atualizar configurações de merchant

Authorizations:
path Parameters
id
required
string <uuid>

id do merchant

Request Body schema: application/json
mcc
string

código de segmento do lojista no adquirente formado por quatro números, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code.

Responses

Request samples

Content type
application/json
{
}

Deletar merchant pelo id

Authorizations:
path Parameters
id
required
string <uuid>

id do merchant

Responses

Flows

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.

Recuperar todos os fluxos paginado

Authorizations:
query Parameters
page
number

número da página

limit
number

quantidade de itens por página

merchantId
string

usado para filtrar os fluxos por merchantId

paymentMethod
string

usado para filtrar os fluxos por método de pagamento

Responses

Response Schema: application/json
Array of objects[ items ]
Array
id
string

identificador único do fluxo

paymentMethod
string

método de pagamento a qual aquele fluxo é relacionado

clientId
string

identificador do cliente dono do fluxo

Array of objects[ items ]
parentId
string

identificador do fluxo que originou o novo

restoredFrom
string

identificador do fluxo do qual este foi restaurado

createdAt
string

data e hora em que o fluxo foi criado (UTC)

flow
object

dados do fluxo que será cadastrado

object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

Response samples

Content type
application/json
{
}

Consultar um fluxo pelo id

Authorizations:
path Parameters
id
required
string <uuid>

flow id

Responses

Response Schema: application/json
id
string

identificador único do fluxo

paymentMethod
string

método de pagamento a qual aquele fluxo é relacionado

clientId
string

identificador do cliente dono do fluxo

Array of objects[ items ]
Array
merchantId
string

identificador do merchant relacionado ao fluxo

parentId
string

identificador do fluxo que originou o novo

restoredFrom
string

identificador do fluxo do qual este foi restaurado

createdAt
string

data e hora em que o fluxo foi criado (UTC)

flow
object

dados do fluxo que será cadastrado

Response samples

Content type
application/json
{
}

Reports

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

Exportar dados da base

Authorizations:
header Parameters
accept-language
string
Default: en-US
Enum: "en-US" "pt-BR"

Idioma da exportação

X-User-Timezone
string
Default: America/Sao_Paulo

Timezone local do cliente no formato tz database

Request Body schema: application/json
sendTo
email

E-mail para qual a exportação será enviada

type
string
Value: "transactions"

Tabela de dados que será exportada

fields
array
Items Enum: "card_brand__brand" "card__number" "card__holder_name" "customer__client_id" "customer__name" "customer__email" "customer__phone_number" "customer__document_number" "customer__customer_adress_id" "customer_address__street" "customer_address__street_number" "customer_address__complement" "customer_address__zip_code" "customer_address__state" "customer_address__city" "customer_address__district" "customer_address__country" "nupay__payment_type" "provider__name" "session__id" "transaction__id" "transaction__currency" "transaction__created_at" "transaction__order_id" "transaction__merchant_id" "transaction__description" "transaction__original_amount" "transaction__amount" "transaction__installments" "transaction__status" "transaction__statement_descriptor" "transaction_request__created_at" "transaction_request__payment_method" "transaction_request__provider_id"

Campos que serão exportados

object

Filtros que serão aplicados aos dados para a exportação

transactionRequestPaymentMethod
array
Items Enum: "credit" "pix" "boleto" "nupay"

Métodos de pagamentos para exportação

transactionStatus
array
Items Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "charged_back" "capture_pending" "refund_pending"

Status dos pagamentos que serão exportados

transactionProviderId
string

Id do provedor

transactionId
string

Id da transação no provedor

object

Objeto que define o escopo de datas a ser exportada

gte
string <2019-08-24T14:15:22Z> (UTC)

Início do período no formato ISO 8601

lte
string <2019-09-24T14:15:22Z> (UTC)

Fim do período no formato ISO 8601

transactionMerchantId
string

Id do merchant

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Recuperar detalhes de uma exportação

Authorizations:
path Parameters
id
required
string <uuid>

Id da exportação

Responses

Response Schema: application/json
id
string

Id da exportação

clientId
string

Identificador do cliente na Malga

email
email

E-mail para qual a exportação foi enviada

language
string
Enum: "pt-BR" "en-US"

Língua usada para montar a tabela de dados

status
array
Items Enum: "created" "pending" "processing" "uploaded" "sent" "opened" "expired" "error" "empty"
pagesCount
number

Número de arquivos gerados

files
array

Lista do nome dos arquivos gerados

fields
array
Items Enum: "card_brand__brand" "card__holder_name" "customer__client_id" "customer__name" "customer__email" "customer__phone_number" "customer__document_number" "customer__customer_adress_id" "customer_address__complement" "customer_address__zip_code" "customer_address__street" "customer_address__street_number" "customer_address__state" "customer_address__city" "customer_address__district" "customer_address__country" "nupay__payment_type" "transaction__id" "transaction__amount" "transaction__original_amount" "transaction__created_at" "transaction__currency" "transaction__description" "transaction__order_id" "transaction__merchant_id" "transaction_request__created_at" "transaction_request__payment_method" "transaction_request__provider_id" "transaction__installments" "transaction__status" "transaction_source__card_id" "transaction__statement_descriptor" "provider__name" "session__id"

Lista de filtros que foram exportados

createdAt
string <2023-04-01T00:00:00Z>

Data da criação

updatedAt
string <2023-04-01T00:01:00Z>

Data da atualização

expiredAt
string <2023-05-01T00:00:00Z>

Data de expiração dos links para download dos arquivos

timezone
string <America/Sao_Paulo>

Timezone utilizado para as datas

object

Filtros que foram aplicados aos dados para a exportação

transactionRequestPaymentMethod
array
Items Enum: "credit" "pix" "boleto" "nupay"

Métodos de pagamentos para exportação

transactionStatus
array
Items Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "charged_back" "capture_pending" "refund_pending"

Status dos pagamentos que serão exportados

transactionProviderId
string

Id do provedor

transactionId
string

Id da transação no provedor

object

Objeto que define o escopo de datas a ser exportada

gte
string <2019-08-24T14:15:22Z> (UTC)

Início do período no formato ISO 8601

lte
string <2019-09-24T14:15:22Z> (UTC)

Fim do período no formato ISO 8601

transactionMerchantId
string

Id do merchant

Response samples

Content type
application/json
{
}

Fazer download de um arquivo

Os arquivos podem ser baixados durante um período de até 30 dias após a data de exportação. Depois desse período, os arquivos não estarão mais disponíveis para download.

Authorizations:
path Parameters
id
required
string <uuid>

Id da exportação

pageNumber
required
int

Número da página

Responses

Response Schema: application/csv
file

Response samples

Content type
application/csv
Data da Criação, ID da Cobrança, ID do pedido, Subconta, Descrição, Data do Pagamento, Método de Pagamento, ID do provedor, Provedor, Moeda, Valor Original, Valor Final, Parcelas, Status, Descrição no Recibo, ID do Cliente, Nome, Email, Telefone, Documento, ID Endereço, Endereço, Número, Complemento, CEP, Estado, Cidade, Bairro, País

Tabelas de tipos

Provedores e meios de pagamentos suportados

Provedor Cartão Boleto Pix Split 3DS2 Descrição
ADYEN SIM SIM SIM NÃO SIM Adyen
BB NÃO NÃO SIM NÃO NÃO Banco do Brasil
BRAINTREE SIM NÃO NÃO NÃO NÃO Braintree
BRASPAG SIM NÃO NÃO SIM NÃO Braspag
BS2_BOLETO NÃO SIM NÃO NÃO NÃO Banco BS2 Boleto
BS2 NÃO NÃO SIM NÃO NÃO Banco BS2 Pix
CIELO SIM NÃO NÃO NÃO NÃO Cielo
GETNET SIM SIM SIM NÃO NÃO Getnet
KLAP SIM NÃO NÃO NÃO NÃO Klap
MERCADO_PAGO SIM SIM SIM NÃO NÃO Mercado pago
PAGARME SIM SIM SIM SIM NÃO Pagar.me
PAGSEGURO SIM NÃO SIM NÃO NÃO PagSeguro
REDE SIM NÃO NÃO NÃO NÃO Rede
STRIPE SIM SIM NÃO NÃO NÃO Stripe
ZOOP SIM SIM SIM SIM NÃO Zoop
SANDBOX SIM SIM SIM SIM SIM Simulador ambiente de teste

Provedores de AntiFraude

Provedor Realtime Assíncrono Descrição
CLEARSALE SIM NÃO Clearsale Realtime Decision e Behaviour Analytics

Tabela de código de negação para declinedCode

DeclinedCode ResponseMessage O que fazer (ABECS)
card_not_supported The card does not support this type of purchase UTILIZE FUNÇÃO DÉBITO
expired_card The card expiration date is invalid VERIFIQUE OS DADOS DO CARTÃO
fraud_confirmed The charge has been declined for confirmed fraud TRANSAÇÃO NÃO PERMITIDA PARA O CARTÃO - NÃO TENTE NOVAMENTE
fraud_suspect The charge has been declined for suspect it is fraudulent CONTATE A CENTRAL DO SEU CARTÃO
generic The card has been declined for a unknown reason CONTATE A CENTRAL DO SEU CARTÃO
insufficient_funds The card has insufficient funds NÃO AUTORIZADA
invalid_amount The charge amount is not valid or exceeded maximum allowed VALOR DA TRANSAÇÃO NÃO PERMITIDO - NÃO TENTE NOVAMENTE
invalid_cvv The security code is invalid SENHA INVÁLIDA
invalid_data The card has been declined for invalid data VERIFIQUE OS DADOS DO CARTÃO
invalid_installment The charge has been declined because invalid number of installments PARCELAMENTO INVÁLIDO - NÃO TENTE NOVAMENTE
invalid_merchant The charge has been declined because merchant is not valid TRANSAÇÃO NÃO PERMITIDA - NÃO TENTE NOVAMENTE
invalid_merchant The charge has been declined because merchant is not valid CONTA ORIGEM INVÁLIDA - NÃO TENTE NOVAMENTE
invalid_number The card number is invalid VERIFIQUE OS DADOS DO CARTÃO
invalid_pin The card has been declined because pin is invalid SENHA INVÁLIDA - NÃO TENTE NOVAMENTE
issuer_not_available The card issuer could not be reached, charge not authorized DADOS DO CARTÃO INVÁLIDO - NÃO TENTE NOVAMENTE
lost_card The card has been declined because the card is reported lost TRANSAÇÃO NÃO PERMITIDA - NÃO TENTE NOVAMENTE
not_permitted The charge is not permited to the card TRANSAÇÃO NÃO PERMITIDA PARA O CARTÃO- NÃO TENTE NOVAMENTE
pickup_card The card cannot be used to make this charges CONTATE A CENTRAL DO SEU CARTÃO - NÃO TENTE NOVAMENTE
pin_try_exceeded The card has been declined because exceeded maximum pin tries EXCEDIDAS TENTATIVAS DE SENHA.CONTATE A CENTRAL DO SEU CARTÃO
restricted_card The card cannot be used to make this charge DESBLOQUEIE O CARTÃO
security_violation The card has been declined for a unknown reason VERIFIQUE OS DADOS DO CARTÃO
service_not_allowed The card has been declined because do not support international charge CARTÃO NÃO PERMITE TRANSAÇÃO INTERNACIONAL
stolen_card The card has been declined because the card is reported stolen TRANSAÇÃO NÃO PERMITIDA - NÃO TENTE NOVAMENTE
transaction_not_allowed The card has been declined for a unknown reason ERRO NO CARTÃO - NÃO TENTE NOVAMENTE
try_again The card has been declined for a unknown reason REFAZER A TRANSAÇÃO

Tabela de códigos MCC

MCC Descrição
742 VETERINARIA
744 Carefree Resorts
763 COOPERATIVA AGRÍCOLA
780 SERVIÇOS DE PAISAGISMO E HORTICULTURA
1520 EMPREITEIROS EM GERAL - COMERCIAL E RESIDENCIAL
1711 PREST. DE SERV. PARA AR COND., ENCANAMENTO E AQUEC.
1731 ELETRICISTAS E SERVIÇOS ELÉTRICOS
1740 PEDREIROS E SERVIÇOS DE INSTALAÇÃO
1750 MARCENEIROS E SERVIÇOS DE CARPINTARIA
1761 METALURGICOS
1771 EMPREITEIO PARA SERVIÇOS ESPECIALIZADO
1799 DEMAIS SVS DE REFORMA E CONSTRUÇÃO NÃO-CLASSIFICADOS
2741 EDITORAS - PUBLICAÇÕES E IMPRESSÕES
2791 TYPESETTING, PLATE MAKING AND RELATED SERVICES
2842 SERVIÇOS DE LIMPEZA E POLIMENTO
4011 TRANSPORTE FERROVIÁRIO DE CARGA
4111 TRANSPORTE LOCAL DE PASSAGEIROS, INCLUINDO BALSAS
4112 TRANSPORTE DE PASSAGEIROS EM TREM (LONGA DISTÂNCIA)
4119 AMBULANCIAS
4121 LIMUSINES E TÁXIS (TAXICABS AND LIMOUSINES)
4131 COMPANHIAS DE ONIBUS
4214 TRANSPORTE DE CARGA RODOVIÁRIO E ARMAZENAMENTO
4215 CORREIOS - AÉREO, TERRESTRE E TRANSITÓRIOS
4225 ARMAZENAM. PROD AGRÍCOLAS,MERCAD REFRIGERADAS,BENS DOMÉSTICO
4411 LINHAS DE CRUZEROS (CRUISE LINES)
4457 ALUGUEL E ARRENDAMENTO DE BARCOS, ESQUIS E IATES
4468 MARINAS, SERVIÇOS E FORNECEDORES
4511 OUTRAS CIAS AÉREAS
4582 AEROPORTOS E SERVIÇOS LIGADOS A AERONAVES
4722 AGÊNCIAS DE VIAGENS (TRAVEL AGENCIES)
4723 AGÊNCIAS DE VIAGEM TUI (TUI TRAVEL AGENCY)
4784 PEDÁGIOS
4789 SERVIÇOS DE TRANSPORTE
4812 TELEFONES E EQUIPAMENTOS DE TELECOMUN.
4813 SERVIÇOS DE TELEC.- CHAM. LOCAIS E LONGA DISTÂNCIA
4814 SERVIÇOS DE TELECOMUNICAÇÃO
4816 REDES DE COMPUTADORES / SERVIÇOS DE INFOR