Pular para o conteúdo principal

Documentação Plug API (0.4)

Download OpenAPI specification:Download

Authentication

Os serviços de API da Plug 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 Plug e a chave secreta de acesso.

X-Client-ID

Identificador única da sua conta na plug. 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.plugpagamentos.com/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 Plug

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

Response Schema: application/json
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 Plug

publicKey
string <uuid>

chave pública criada

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

Response Schema: application/json
id
string <uuid>

Identificador do token gerado

clientId
string <uuid>

identificador do cliente na Plug

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

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

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)

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

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

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)

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

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

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)

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 Plug, 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.plugpagamentos.com/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

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 Plug

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

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

status da transação na plug

orderId
string

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

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (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

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

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 plug

idempotencyKey
string

chave única de referência gerada pela plug 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"

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

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

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

{
}

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)

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.

required
object

Dados do comprador

name
required
string

nome do usuario

email
required
string

email do usuario

phone
required
string

telefone de contato do usuario

identityType
required
string

tipo de documento, consultar tabela de tipos suportados

identity
required
string

numero do documento formato conforme tipo selecionado

object

Endereço de entrega

required
object

Endereço de cobrança

required
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

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

Response Schema: application/json
id
string

identificador da transação

clientId
string <uuid>

identificador do cliente na Plug

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

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

status da transação na plug

orderId
string

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

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (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

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

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 plug

idempotencyKey
string

chave única de referência gerada pela plug 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"

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

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

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

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
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
enum - pending - pre_authorized - authorized - voided - canceled - charged_back

status da cobrança

paymentType
enum - credit - pix - boleto

tipo de pagamento

orderId
string

id da cobrança gerado pelo cliente

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

identificador da transação

clientId
string <uuid>

identificador do cliente na Plug

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

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

status da transação na plug

orderId
string

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

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (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

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

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 plug

idempotencyKey
string

chave única de referência gerada pela plug 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"

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

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

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

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

Response Schema: application/json
id
string

identificador da transação

clientId
string <uuid>

identificador do cliente na Plug

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

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

status da transação na plug

orderId
string

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

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (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

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

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 plug

idempotencyKey
string

chave única de referência gerada pela plug 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"

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

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

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

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

Responses

Response Schema: application/json
id
string

identificador da transação

clientId
string <uuid>

identificador do cliente na Plug

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

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

status da transação na plug

orderId
string

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

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (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

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

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 plug

idempotencyKey
string

chave única de referência gerada pela plug 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"

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

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

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

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Webhooks

A Plug 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 Plug 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

Versão da api da Plug 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 Plug

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

Versão da api da Plug que seu webhook implementa

status
boolean
Default: true

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

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

Versão da api da Plug que seu webhook implementa

status
boolean
Default: true

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

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

Versão da api da Plug 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 Plug

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 Plug. Uma sub conta, ou um merchant, é um cadastro de estabelecimento comercial que você tenha junto há um dos provedores de pagamentos integrados pela Plug. 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 Plug.

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 Plug, e definir a prioridade do provedor com suas credenciais de acesso à API do provedor.

O sistema de roteamento inteligente de transações da Plug 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 BS2 (object) or BB (object) or Zoop (object) or Stripe (object) or Rede (object) or MercadoPago (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

{
}

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 BS2 (object) or BB (object) or Zoop (object) or Stripe (object) or Rede (object) or MercadoPago (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

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 BS2 (object) or BB (object) or Zoop (object) or Stripe (object) or Rede (object) or MercadoPago (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 BS2 (object) or BB (object) or Zoop (object) or Stripe (object) or Rede (object) or MercadoPago (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

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

Tabelas de tipos

Provedores e meios de pagamentos suportados

Provedor Cartão Boleto Pix Descrição
PAGSEGURO SIM NÃO NÃO PagSeguro
PAGARME SIM SIM SIM Pagar.me
CIELO SIM NÃO NÃO Cielo
STRIPE SIM SIM NÃO Stripe
ZOOP SIM NÃO NÃO Zoop
BS2 NÃO NÃO SIM Banco BS2 Pix
BS2_BOLETO NÃO SIM NÃO Banco BS2 Boleto
BB NÃO NÃO SIM Banco do Brasil
REDE SIM NÃO NÃO Rede
MERCADO_PAGO SIM NÃO NÃO Mercado pago
PLUG_SANDBOX SIM SIM SIM Simulador ambiente de teste

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 INFORMAÇÃO
4821 TELEGRAFO
4829 ORDENS DE PAGAMENTO POR TRANSFERÊNCIA BANCÁRIA
4899 SERVIÇOS DE TV A CABO/PAGA (CABLE/PAY TV SERVICES)
4900 UTILID./ELEC/GAS/AGUÁ/SANI (UT../ELEC/GAS/H2O/SANI)
5013 ATACADISTAS E DISTRIBUIDORES DE ACESSÓRIOS DE VEÍCULOS
5021 MÓVEIS PARA ESCRITÓRIOS (COMMERCIAL FURNITURE)
5039 MATERIAL PARA CONSTRUÇÃO E AFINS (CONST. MAT. - DEF)
5044 A/D DE EQUIPAMENTOS DE FOTOGRAFIA, CÓPIA E MICROFILME
5045 COMPUTADORES, EQUIPAMENTOS E SOFTWARES
5046 A/D DE MÁQUINAS E EQUIPAMENTOS PARA EC
5047 A/D DE EQUIPAMENTO HOSPITALARES, MÉDICOS E OFTÁLMICOS
5051 CENTROS DE SERVIÇOS DE METAIS (METAL SERVICE CENTERS)
5065 LOJA ARTIGOS ELETRÔNICOS
5072 EQUIP./DISTRIB. DE HARDWARE (HARDWARE EQUIP.SUPPLIES)
5074 EQUIP. DE AQUECIMENTO/ENCANAMENTO (PLUMB./HEAT. E.)
5085 A/D DE SUPRIMENTOS INDUSTRIAIS (NÃO CLASSIFICADO EM OUTRO)
5094 JOALHERIA, PEDRAS PRECIOSAS, METAIS
5099 ATACADISTAS E DISTRIBUIDORES DE MERCADORIAS DURÁVEIS
5111 A/D DE ARTIGOS DE PAPELARIA E SUPRIMENTOS PARA ESCRITÓRIO
5122 FARMACEUTICOS/DROGAS (DRUGS/DRUGGISTS SUNDRIES)
5131 A/D DE TECIDOS E PRODUTOS DE ARMARINHO
5137 ATACADISTAS E DISTRIBUIDORES DE ROUPAS
5139 ATACADISTAS E DISTRIBUIDORES DE CALÇADOS
5169 A/D DE PRODUTOS QUIMICOS E SEMELHANTES (N CLASSIF. EM OUTRO)
5172 PRODUTOS DE PETRÓLEO (PETROLEUM/PETROLEUM PRODUCTS)
5192 ATAC. E DISTRIB. DE LIVROS, PERIÓDICOS E JORNAIS
5193 ATACADISTAS E DISTRIBUIDORES DE FLORES, PLANTAS E SEMENTES
5198 PINTURA, POLIMENTO E SUPRIM. (PAN.,VARN. & SUPPLIES)
5199 A/D DE MERCADORIAS NÃO DURÁVEIS (NÃO CLASSIF. EM OUTRO)
5200 LOJAS DE MATERIAL DE CONSTRUÇÃO (PEQUENO/MÉDIO PORTE)
5211 LOJAS DE MATERIAL DE CONSTRUÇÃO-PRODUTOS BRUTOS (EX: TIJOLO)
5231 LOJAS DE VIDROS, TINTAS E PAPÉIS DE PAREDE
5251 VENDA DE EQUIPAMENTOS, INCLUINDO DE FERRAGEM
5261 JARDINAGEM
5271 CORRETORES DE RESIDÊNCIAS MÓVEIS
5300 VENDA POR ATACADO (WHOLESALE CLUBS)
5309 DUTY FREE STORES
5310 LOJAS DE DESCONTO
5311 LOJAS DE DEPARTAMENTOS (DEPARTMENT STORES)
5331 LOJAS DE VARIEDADES
5399 LOJA MERCADORIAS GERAIS
5411 MERCEARIAS/SUPERMERCADOS (GROCERY STORES/SUPERM.)
5422 AÇOGUEIRO (FREEZER/MEAT LOCKERS)
5441 LOJA DE DOCES
5451 LOJA DE PRODUTOS DE LACTICÍNIOS (DAIRY PROD. STORES)
5462 CONFEITARIAS (BAKERIES)
5499 LOJA DE ALIMENTOS VARIADOS (MISC FOOD S. - DEFAULT)
5511 VENDA DE CARROS E CAMINHÕES (NOVOS E USADOS)
5521 VENDA DE CARROS USADOS
5531 Lojas de Automóveis, Lojas de Acessórios Domésticos
5532 LOJA DE PNEUS
5533 LOJA DE PEÇAS E ACESSÓRIOS DE CARROS
5541 ESTAÇÕES DE SERVIÇOS (SERVICE STATIONS)
5551 VENDA DE BARCOS MOTORIZADOS
5561 ARTIGOS PARA ACAMPAMENTO
5571 LOJAS DE MOTOCICLETAS E ACESSÓRIOS
5592 VENDA DE TRAILLERS
5598 CONSECIONÁRIA DE SNOWMOBILE
5599 SERVIÇOS GERIAS PARA CARROS
5611 ARTIGOS MASCULINOS
5621 LOJA DE ROUPAS FEMININAS "PRONTA PARA USAR"
5631 ACESSORIOS FEMININOS E LINGERIES
5641 ARTIGOS PARA CRIANÇAS E BEBÊS
5651 ROUPAS MASCULINAS, FEMININAS E INFANTIS
5655 ROUPA ESPORTIVA
5661 LOJAS DE SAPATOS
5681 LOJA DE PELES
5691 OJA ROUPA UNISSEX
5697 COSTUREIRAS E ALFAIATES
5698 LOJAS DE PERUCA
5699 SERVIÇOS GERIAS PARA VESTIMENTA
5712 LOJA DE MÓVEIS
5713 Loja de Pisos
5714 LOJA DE ESTOFADOS (DRAPERY & UPHOLSTERY STORES)
5718 LAREIRAS E ACESSÓRIOS (FIREPLACES & ACCESSORIES)
5719 LOJA DE MÓVEIS ESPECIALIZADA (HOME FURNISHING SPEC.)
5722 LOJAS DE ELETRODOMÉSTICOS
5732 LOJA DE ELETRÔNICOS
5733 LOJA INSTRUMENTO MUSICAIS
5734 LOJA DE SOFTWARE
5735 LOJAS DE DISCOS
5811 DISTRIBUIÇÃO E PRODUÇÃO DE ALIMENTOS
5812 RESTAURANTES
5813 BARES, PUBS E CASA NOTURNAS
5814 LANCHONETES DE COMIDAS RÁPIDAS (FAST FOOD)
5815 Produtos Digitais - De comunicação social audiovisual, incluindo Livros, Filmes e Música
5816 Pordutos Digitais - Jogos
5817 Produtos Digitais - Aplicativos de Software (Exceto Jogos)
5818 Produtos Digitais - Diversas Categorias
5912 FARMÁCIAS (DRUG STORES & PHARMACIES)
5921 CERVEJAS, VINHOS E LICORES (STORE/BEER/WINE/LIQUOR)
5931 LOJAS DE ARTIGOS DE SEGUNDA MÃO / BRECHÓS
5932 LOJA DE ANTIGUIDADES (ANTIQUE SHOPS)
5933 LOJAS DE PENHORES
5935 DEMOLIÇÕES, SUCATAS, DESMANCHES DE AUTOMÓVEIS
5937 L. DE REPRODUÇÃO DE ANTIQUIDADES (ANT.REPROD. STORES)
5940 LOJA DE BICICLETAS - VENDAS E SERVIÇOS
5941 SERVIÇOS GERAIS PARA ESPORTES
5942 LIVRARIAS
5943 PAPELARIAS
5944 JOALHERIA (JEWERLY STORE)
5945 LOJA DE BRINQUEDOS
5946 LOJA DE FOTOGRAFIA
5947 LOJA DE PRESENTES
5948 ARTIGOS DE COURO
5949 ARMARINHOS E LOJAS DE TECIDO
5950 LOJA DE COPOS/CRISTAIS (GLASSWARE/CRYSTAL STORES)
5960 MARK.DIRETO DE SEGUROS (DIR. MARKET. INSURANCE SVC)
5962 SERV. DIRETOS DE VIAGENS (D. MKTG-TRAV. RELATED ARR)
5963 VENDA DIRETA (DIRECT SELL/DOOR-TO-DOOR)
5964 CATALOGO DE COMERCIOS (CATALOG MERCHANT)
5965 CATÁLOGO DE VAREJO (COMB.CATALOG & RETAIL)
5966 MARKETING DIRETO-SAÍDA (OUTB. TELEMARKETING M.)
5967 MARKETING DIRETO - ENTRADA (INB. TELEMARKETING M.)
5968 ASSINATURA COMERCIAL (CONTINUITY/SUBSCRIP. MERCHANT)
5969 OUTROS VENDEDORES DE MARKETING DIRETO
5970 PRODUTOS ARTESANAIS
5971 GALERIA DE ARTE (ART DEALERS & GALLERIES)
5972 LOJA DE MOEDAS E SELOS
5973 LOJA DE BENS RELIGIOSOS
5975 APARELHOS AUDITIVOS - VENDAS E SERVIÇOS
5976 BENS ORTOPÉDICOS - PRÓTESES
5977 LOJA DE COSMÉTICOS
5978 MÁQUINAS DE ESCREVER - VENDA, ALUGUEL E SERVIÇOS
5983 REVENDEDORES DE COMBUSTÍVEIS (FUEL DEALERS)
5992 FLORICULTURA
5993 TABACARIA
5994 BANCA DE JORNAL E PROVEDOR DE NOTÍCIAS
5995 PET SHOP
5996 PISCINAS E BANHEIRAS - SERVIÇOS, SUPRIMENTOS E VENDAS
5997 NAVALHA ELÉTRICA - VENDA E SERVIÇOS
5998 LOJAS DE BARRACAS E TOLDOS
5999 LOJAS ESPECIALIZADAS NÃO LISTADAS ANTERIOMENTE
6010 BANCOS / LOJAS DE POUPANÇA E INST. FINANCEIRA
6011 INSTIUIÇÃO FINANCEIRA - CAIXA ELETRÔNICO
6012 INSTIUIÇÃO FINANCEIRA - AGÊNCIAS E SERVIÇOS
6050 Similar a Dinheiro (Quase Cash) - Instituição Financeira Cliente
6051 CASAS DE CÂMBIO
6211 CORRETORES DE IMÓVEIS (SECURITIES BROKERS/DEALERS)
6300 VENDA DE SEGUROS(INSURANCE SALES/UNDERWRITE)
6513 CORRETOR DE IMÓVEIS (ALUGUEL)
6532 PAGTOS DE TRANSAÇÕES DE INST.FINANCEIRAS
6533 PAGTOS DE TRANSAÇÕES COMERCIAIS
7011 HOTEIS (HOTELS/MOTELS/RESORTS)
7012 TEMPO COMPARTILHADO (TIMESHARE)
7032 ACAMPAMENTOS RECREATIVOS E DEPORTIVOS
7033 SERVIÇOS DE ACAMPAMENTOS
7210 LAVANDARIA, LIMPEZA E SERVIÇOS DE VESTUÁRIO
7211 LAVANDERIA - FAMILIAR E COMERCIAL
7216 LAVANDERIA TINTURARIA
7217 LIMPEZA DE TAPETES E ESTOFADOS
7221 ESTÚDIOS DE FOTOGRAFIA
7230 SALAO DE BELEZA / BARBEARIA / DEPILAÇÃO / MANICURE
7251 LOJA/REPARO DE SAPATOS
7261 SERVIÇO FUNERÁRIO
7273 SERVIÇO DE ENCONTROS E ACOMPANHANTE
7276 SERVIÇOS DE PREP. IMPOST. DE RENDA (TAX PREP. SVCS)
7277 S. DE ACONSELHAMENTO DE DÍVIDAS, CASAMENTO E PESSOAL
7278 CLUBES DE COMPRAS
7296 ALUGUEL DE ROUPAS - FANTASIAS, UNIFORMES E ROUPAS SOCIAIS
7297 CENTRO DE SAUNAS E MASSAGENS
7298 CLÍNICAS DE ESTÉTICA FACIAL / CORPORAL
7299 OUTROS SERVIÇOS PESSOAIS
7311 PUBLICIDADES
7321 AGÊNCIAS DE ANÁLISE DE CRÉDITO DE CONSUMIDORES
7333 SERVIÇOS DE IMPRESSÃO E ARTE GRÁFICA
7338 COPIADORAS E FOTOCOPIADORAS
7339 SERVIÇO DE SECRETARIADO E ESTENOGRAFIA
7342 DEDETIZAÇÃO E DESINFECÇÃO
7343 SERVIÇO DE EXTERMINIO E DESINFETAÇÃO
7349 SERVIÇO LIMPEZA E MANUTENÇÃO
7361 AGÊNCIAS DE EMPREGO
7372 SERVIÇOS DE PROGRAMAÇÃO DE COMPUTADORES E PROCESS. DE DADOS
7375 SERVIÇO DE RECUPERAÇÃO DE INFORMAÇÃO
7379 COMPUTADORES: CONCERTOS E REPAROS
7392 CONSULTORIA EMPRESARIAL E SERVIÇOS DE RELAÇÕES PÚBLICAS
7393 AGÊNCIAS DE DETETIVES, PROTECÇÃO E DE SEGURANÇA
7394 ALUGUEL DE EQUIPAMENTO E MOBÍLIA DE ESCRITÓRIOS
7395 LABORATÓRIOS FOTOGRÁFICOS
7399 SERVIÇOS DE NEGÓCIOS
7511 PARADA DE CAMINHÕES (TRUCK STOP)
7512 ALUGUEL DE AUTOMÓVEIS (AUTOMOBILE RENTAL AGENCY)
7513 ALUGUEL DE CAMINHÕES (TRUCK/UTILITY TRAILER RENTALS)
7519 ALUGUEL DE MOTOR HOME (MOTOR HOME/RV RENTALS)
7523 ESTACIONAMENTOS E GARAGENS DE CARRO
7531 FUNILARIAS E PINTURA AUTOMOTIVA
7534 BORRACHARIAS
7535 LOJAS DE PINTURA DE AUTTOMÓVEIS
7538 SERVIÇOS PARA CARROS (NÃO CONCESIONARIA)
7542 LAVA JATO
7549 GUINCHO
7622 CONSERTO DE EQUIP. AUDIO E TV
7623 CONSERTO DE AR CONDICIONADO
7629 CONSERTO DE ELETRONICOS
7631 CONSERTO DE RELÓGIOS E JÓIAS
7641 RESTAURAÇÃO DE MÓVEIS (FURNITURE REPAIR)
7692 SERRALHEIROS E SOLDADORES
7699 LOJA DE CONSERTOS GERAIS E SERVIÇOS RELACIONADOS
7829 PRODUTORES E DISTRIBUIDORES DE FILMES
7832 CINEMAS, PRODUÇÕES CINEMATOGRÁFICAS
7841 LOJAS DE VIDEOS
7911 DANÇA (ESTUDIOS, ESCOLAS E SALÕES)
7922 TEATROS, PRODUC. TEATR. E ESPECTAC.
7929 BANDAS,ORQUESTRAS,ARTISTAS DIVERSOS(N CLASSIFICADO EM OUTRO)
7932 BARES DE SINUCA
7933 BOLICHE
7941 QUADRAS DE ESPORTE / PROPAGANDA ESPORTIVA
7991 ATRAÇÕES TURÍSTICAS E EXPOSIÇÕES
7992 AULAS DE GOLF PUBLICA
7993 FORNECEDORES DE MÁQUINAS DE VIDEOGAME OU JOGOS
7994 LOJAS DE DIVERSÃO / VIDEO GAME / LAN HOUSE / CIBER CAFÉ
7995 CASSINOS, LOTERIAS E JOGOS DE AZAR
7996 PARQUE DE DIVERSAO, CIRCO E AFINS
7997 ACADEMIAS / CLUBES
7998 AQUÁRIOS E ZOOLÓGICOS
7999 SERVIÇOS DE RECREAÇÃO E FESTAS
8011 MÉDICOS (CLÍNICAS E CONSULTÓRIOS)
8021 DENTISTAS E ORTODONTISTAS (CLÍNICAS E CONSULTÓRIOS)
8031 OSTEOPATAS
8041 QUIROPRAXIA
8042 OFTAMOLOGISTA E OPTOMETRISTAS
8043 OPTICIANS, OPTICAL GOODS, AND EYEGLASSES
8049 TRATAMENTOS PODIÁTRICOS
8050 CASAS DE REPOUSO, CLÍN. DE RECUPERAÇÃO E ENFERMAGEM
8062 HOSPITAIS
8071 ANALISES CLÍNICAS MÉDICAS E DENTAIS
8099 MEDICINA EM GERAL E PRATICANTES DE SERVIÇOS DE SAÚDE
8111 SERVIÇOS JURÍDICOS - ADVOGADOS
8211 EDUCAÇÃO PRIMÁRIA E SECUNDÁRIA (ELEM./SEC.S.)
8220 UNIVERSIDADES E FACULDADES (COLLEGES/UNIV/JC/PROF.)
8241 EDUACAÇÃO A DISTÂNCIA (CORRESPONDENCE SCHOOLS)
8244 ESCOLA DE COMÉRCIOS E SECRETARIADO (BUS./SEC. SCHOOL)
8249 ESCOLA DE NEGÓCIOS/VOCAÇÕES (TRADE/VOCATIONS S.)
8299 COLEGIOS (SCHOOLS)
8351 SERVIÇOS DE CUIDADOS DE CRIANÇAS (CHILD CARE SVCS)
8398 ORGANIZAÇÕES DE SERVIÇOS BENEFICENTES E SOCIAIS
8641 ASSOCIAÇÕES CÍVICAS E SOCIAIS
8651 ORGANIZAÇÕES POLITICAS
8661 ORGANIZAÇÕES RELIGIOSAS
8675 ASSOCIAÇÃO DE CARROS
8699 ORG. SIND., ASSOC. CULT. E OTRS ASSOC. NÃO CLASSIF.
8734 LABORATÓRIOS DE TESTE (PARA TESTES NÃO MÉDICOS)
8911 ARQUIRETURA, ENGENHARIA E AGRIMENSURA
8931 CONTABILIDADE, AUDITORIA E SERVIÇOS DE CONTABILIDADE
8999 OUTROS SERVIÇOS PROFISSIONAIS DE ESPECIALIZADOS
9211 PENSÃO ALIMENTÍCIA (COURT COSTS/ALIMONY/SUPPORT)
9222 MULTAS (FINES)
9223 PAGAMENTOS DE TÍTULOS E FINANÇAS (BAIL AND BOND P.)
9311 PAGAMENTOS DE IMPOSTOS (TAX PAYMENTS)
9399 SERVIÇOS GOVERNAMENTAIS (GOVT SERV - DEFAULT)
9402 POSTAGENS (POSTAGE STAMPS)
9405 COMPRAS GOVERNAMENTAIS (INTRA-GOVERNMENT PURCHASES)
9406 Loteria de Propriedade do Governo (Países Específicos
9950 DEPART. DE COMPRAS (INTRA- COMPANY PURCHASES)

Tabela tipos de moedas aceitas

Currency Code Currency
BRL Brazilian real
USD United States dollar
EUR Euro
YER Yemeni rial
ZAR South African rand
AED United Arab Emirates dirham
AFN Afghan afghani
ALL Albanian lek
AMD Armenian dram
ANG Netherlands Antillean guilder
AOA Angolan kwanza
ARS Argentine peso
AUD Australian dollar
AWG Aruban florin
AZN Azerbaijani manat
BAM Bosnia and Herzegovina convertible mark
BBD Barbados dollar
BDT Bangladeshi taka
BGN Bulgarian lev
BIF Burundian franc
BMD Bermudian dollar
BND Brunei dollar
BOB Boliviano
BSD Bahamian dollar
BWP Botswana pula
BZD Belize dollar
CAD Canadian dollar
CDF Congolese franc
CHF Swiss franc
CLP Chilean peso
CNY Chinese yuan[8]
COP Colombian peso
CRC Costa Rican colon
CVE Cape Verdean escudo
CZK Czech koruna
DJF Djiboutian franc
DKK Danish krone
DOP Dominican peso
DZD Algerian dinar
EGP Egyptian pound
ETB Ethiopian birr
ZMW Zambian kwacha
FJD Fiji dollar
FKP Falkland Islands pound
GBP Pound sterling
GEL Georgian lari
GIP Gibraltar pound
GMD Gambian dalasi
GNF Guinean franc
GTQ Guatemalan quetzal
GYD Guyanese dollar
HKD Hong Kong dollar
HNL Honduran lempira
HRK Croatian kuna
HTG Haitian gourde
HUF Hungarian forint
IDR Indonesian rupiah
ILS Israeli new shekel
INR Indian rupee
ISK Icelandic króna
JMD Jamaican dollar
JPY Japanese yen
KES Kenyan shilling
KGS Kyrgyzstani som
KHR Cambodian riel
KMF Comoro franc
KRW South Korean won
KYD Cayman Islands dollar
KZT Kazakhstani tenge
LAK Lao kip
LBP Lebanese pound
LKR Sri Lankan rupee
LRD Liberian dollar
LSL Lesotho loti
MAD Moroccan dirham
MDL Moldovan leu
MGA Malagasy ariary
MKD Macedonian denar
MMK Myanmar kyat
MNT Mongolian tögrög
MOP Macanese pataca
MRO Macanese pataca
MUR Mauritian rupee
MVR Maldivian rufiyaa
MWK Malawian kwacha
MXN Mexican peso
MYR Malaysian ringgit
MZN Mozambican metical
NAD Namibian dollar
NGN Nigerian naira
NIO Nicaraguan córdoba
NOK Norwegian krone
NPR Nepalese rupee
NZD New Zealand dollar
PAB Panamanian balboa
PEN Peruvian sol
PGK Papua New Guinean kina
PHP Philippine peso[12]
PKR Pakistani rupee
PLN Polish złoty
PYG Paraguayan guaraní
QAR Qatari riyal
RON Romanian leu
RSD Serbian dinar
RUB Russian ruble
RWF Rwandan franc
SAR Saudi riyal
SBD Solomon Islands dollar
SCR Seychelles rupee
SEK Swedish krona/kronor
SGD Singapore dollar
SHP Saint Helena pound
SLL Sierra Leonean leone
SOS Somali shilling
SRD Surinamese dollar
STD South Sudanese pound
SZL Swazi lilangeni
THB Thai baht
TJS Tajikistani somoni
TOP Tongan paʻanga
TRY Turkish lira
TTD Trinidad and Tobago dollar
TWD New Taiwan dollar
TZS Tanzanian shilling
UAH Ukrainian hryvnia
UGX Ugandan shilling
UYU Uruguayan peso
UZS Uzbekistan som
VND Vietnamese đồng
VUV Vanuatu vatu
WST Samoan tala
XAF CFA franc BEAC
XCD East Caribbean dollar
XOF CFA franc BCEAO
XPF CFP franc (franc Pacifique)

Tabela tipos de paises e documentos cadastro de Customer

Country Code Document Type Group Country Meaning
AL NIPT Vat Albania Vat Identifier (Numri i Identifikimit për Personin e Tatueshëm)
AD NRT Tax Andorra Tax Identifier (Número de Registre Tributari)
AR CBU Bank Argentina Bank Account (Clave Bancaria Uniforme)
AR CUIT Tax Argentina Tax Identity (Código Único de Identificación Tributaria)
AR DNI Person Argentina National Identity (Documento Nacional de Identidad)
AT Businessid Company Austria Austrian Company Register Numbers
AT TIN Tax Austria Austrian tax identification number (Abgabenkontonummer)
AT UID VAT Austria Austrian VAT number (Umsatzsteuer-Identifikationsnummer)
AT VNR Person Austria Austrian social security number(Versicherungsnummer)
AU ABN Company Australia Australian Business Number
AU ACN Company Australia Australian Company Number
AU TFN Tax/Person/Company Australia Australian Tax File Number
BA JMBG Person Bosnia and Herzegovina Unique Master Citizen Number
BZ TIN Person/Company Belize Brazilian Tax ID ()
BE VAT Company Belgium Belgian Enterprise Number
BG EGN Person Bulgaria ЕГН, Единен граждански номер, Bulgarian personal identity codes
BG PNF Person Bulgaria PNF (ЛНЧ, Личен номер на чужденец, Bulgarian number of a foreigner).
BG VAT Company Bulgaria Идентификационен номер по ДДС, Bulgarian VAT number
BR CPF Person Brazil Brazilian identity number (Cadastro de Pessoas Físicas)
BR CNPJ Company Brazil Brazilian company number (Cadastro Nacional da Pessoa Jurídica)
BY UNP Person/Company Belarus Учетный номер плательщика, the Belarus VAT number
CA BN Company Canada Company Identifier (Canadian Business Number)
CA SIN Person Canada Person Identifier (Social Insurance Number)
CU NI Person Cuba Número de identidad, Cuban identity card numbers
CY VAT Company Cyprus Αριθμός Εγγραφής Φ.Π.Α. (Cypriot VAT number)
CZ DIC Company Czech Republic Daňové identifikační číslo, Czech VAT number
CZ RC Person Czech Republic Rodné číslo, the Czech birth number
CH SSN Person Swisserland Swiss social security number ("Sozialversicherungsnummer")
CH UID Company Swisserland Unternehmens-Identifikationsnummer, Swiss business identifier
CH VAT Company Swisserland Mehrwertsteuernummer, the Swiss VAT number
CL RUT Tax Chile Tax Identifier (Rol Unico Tributario) [RUN]
CN RIC Person China Person Identifier (Chinese Resident Identity Card Number)
CN USCC Company China Company Identifier (Unified Social Credit Code, 统一社会信用代码, China tax number)
CO NIT Tax Columbia Tax Identifier (Número de Identificación Tributaria)
CR CPF Person Costa Rica Person Identifier (Cédula de Persona Física)
CR CPJ Company Costa Rica Company Identifier (Cédula de Persona Jurídica)
CR CR Person Costa Rica Person Identifier (Cédula de Residencia)
DE IDNR Person Germany Steuerliche Identifikationsnummer, German personal tax number
DE STNR Company Germany Steuernummer, German tax number
DE VAT Company Germany Vat identifier
DK VAT Company Denmark Momsregistreringsnummer, Danish VAT number
DO CEDULA Person Dominican Republic Person Identifier (Cédula de Residencia)
DO NCF Vat Dominican Republic Tax Receipt Number (Números de Comprobante Fiscal)
DO RNC Tax Dominican Republic Person Identifier (Registro Nacional del Contribuyente)
EC CI Person Ecuador Ecuadorian person identifier (Cédula de identidad)
EE IK Person Estonia Isikukood (Estonian Personcal ID number).
EE KMKR Company Estonia KMKR (Käibemaksukohuslase, Estonian VAT number)
EE Registrikood Company Estonia Registrikood (Estonian organisation registration code)
EC RUC Tax/Vat Ecuador Ecuadorian company tax number (Registro Único de Contribuyentes)
SV NIT Tax El Salvador Tax Identifier (Número de Identificación Tributaria)
GT CUI Person Guatemala Guatemala person (Código Único de Identificación)
GT NIT Company Guatemala Guatemala company tax number (Número de Identificación Tributaria)
FI ALV Company Finland ALV nro (Arvonlisäveronumero, Finnish VAT number)
FI HETU Person Finland HETU (Henkilötunnus, Finnish personal identity code)
FI YTUNNUS Company Finland Y-tunnus (Finnish business identifier)
FR NIF Person France NIF (Numéro d'Immatriculation Fiscale, French tax identification number)
GB UTR Person Great Brittan UTR (United Kingdom Unique Taxpayer Reference)
GB VAT Company Great Brittan VAT (United Kingdom (and Isle of Man) VAT registration number)
GR AMKA Company Greece AMKA (Αριθμός Μητρώου Κοινωνικής Ασφάλισης, Greek social security number)
GR VAT Company Greece FPA, ΦΠΑ, ΑΦΜ (Αριθμός Φορολογικού Μητρώου, the Greek VAT number)
FR NIR Person France NIR (French personal identification number)
FR SIREN Company France SIREN (a French company identification number)
FR SIRET Company France SIRET (a French company establishment identification number)
FR TVA Vat France VAT Identifier
HR OIB Person Croatia Osobni identifikacijski broj, Croatian identification number
HK HKID Person Hong Kong Hong Kong Identity Card
HU ANUM Vat Hungaria ANUM (Közösségi adószám, Hungarian VAT number)
IS KENNITALA Person/Company Iceland Icelandic personal and organisation identity code
IS VSK Vat Iceland Virðisaukaskattsnúmer, Icelandic VAT number
ID NPWP Person/Company Indonesia NPWP (Nomor Pokok Wajib Pajak, Indonesian VAT Number).
IE PPS Person Ireland Personal Public Service Number, Irish personal number
IE VAT Tax/Vat Ireland Ireland Value Added Tax ID
IN AADHAAR Company India Indian digital resident personal identity number
IN PAN Person India Permanent Account Number, Indian income tax identifier
IL IDNR Person Israel Identity Number (Mispar Zehut, מספר זהות, Israeli identity number)
IL HR Company Israel Company Number (מספר חברה, or short ח.פ. Israeli company number)
IT AIC Drug Italy Italian code for identification of drugs
IT CODICEFISCALE Person Italy Codice Fiscale (Italian tax code for individuals)
IT IVA Vat Italy Partita IVA (Italian VAT number)
LI PEID Person/Company Liechtenstein Personenidentifikationsnummer
LT ASMENS Person Lithuanian Asmens kodas (Person Number)
LT PVM Vat Lithuanian Pridėtinės vertės mokestis mokėtojo kodas
LU TVA Vat Luxembourgian taxe sur la valeur ajoutée
LV PVN Person/Vat Latvian Pievienotās vērtības nodokļa
MK JMBG Person Macedonia Unique Master Citizen Number (Единствен матичен број на граѓанинот)
MC TVA Vat Monaco taxe sur la valeur ajoutée, Monacan VAT number
MD IDNO Vat Moldavia Moldavian VAT number
MT VAT Vat Malta Maltese VAT number
MU NID Person Mauritius ID number (Mauritian national identifier)
JP CN Company Japan 法人番号, hōjin bangō, Japanese Corporate Number
KR BRN Company South Korea 사업자 등록 번호, South Korea Business Registration Number)
KR RRN Person South Korea South Korean resident registration number
MX RFC Tax/Vat Mexico Tax Identifier (Registro Federal de Contribuyentes)
MX CURP Person Mexico Individual Identifier (Clave Única de Registro de Población)
MX CLABE Bank Mexico Bank Account (Clave Bancaria Estandarizada)
ME JMBG Person Montenegro Unique Master Citizen Number
MY NRIC Person Malaysia Malaysian National Registration Identity Card Number
NL BSN Person Netherlands Burgerservicenummer, the Dutch citizen identification number
NL BTW Vat Netherlands Btw-identificatienummer (Omzetbelastingnummer, the Dutch VAT number)
NL Onderwijsnummer Person Netherlands Onderwijsnummer (the Dutch student identification number)
NZ IRD Person/Company New Zealand New Zealand Inland Revenue Department (Te Tari Tāke) number
NZ BANK Bank New Zealand New Zealand Bank Account numbers - checkdigit
NO Fodsels Person Norway Fødselsnummer (Norwegian birth number, the national identity number)
NO Konto Bank Norway Konto nr. (Norwegian bank account number)
NO MVA Vat Norway Merverdiavgift, Norwegian VAT number
NO Orgnr Company Norway Organisasjonsnummer, Norwegian organisation number
PY RUC Tax/Vat Paraguay Tax Identifier (Registro Único de Contribuyentes)
PE CUI Person Peru Person Identifier (Cédula Única de Identidad)
PE RUC Tax/Vat Peru Tax Identifier (Registro Único de Contribuyentes)
PE CE Person Peru Person Identifier (Carné de Extranjería)
PK CNIC Person Pakistan National Identity Card
PK NTN Company Pakistan Tax Identification Number
PL NIP Vat Poland Numer Identyfikacji Podatkowej, Polish VAT number
PL PESEL Person Poland Polish national identification number
PL REGON Company Poland Rejestr Gospodarki Narodowej, Polish register of economic units
PT NIF Vat Portugual Número de identificação fiscal, Portuguese VAT number
RU INN Tax/Vat Russia Tax Identifier (Идентификационный номер налогоплательщика)
RO CF Vat Romania Cod de înregistrare în scopuri de TVA, Romanian VAT number
RO CNP Person Romania Cod Numeric Personal, Romanian Numerical Personal Code)
RO CUI Tax Romania Codul Unic de Înregistrare, Romanian company identifier
RO ONRC Company Romania Ordine din Registrul Comerţului, Romanian Trade Register identifier
SM COE Company San Marcos Codice operatore economico, San Marino national tax number
RS PIB Vat Serbia Poreski identifikacioni broj Tax identification number
RS JMBG Person Serbia Unique Master Citizen Number (Jedinstveni matični broj građana)
SE ORGNR Company Sweden Organisationsnummer, Swedish company number
SE PERSONNUMMER Person Sweden Personnummer (Swedish personal identity number)
SE VAT Vat Sweden VAT (Moms, Mervärdesskatt, Swedish VAT number)
SG UEN Company Singapore Singapore's Unique Entity Number
TH IDNR Person Thailand Thai National ID (บัตรประจำตัวประชาชนไทย)
TW UBN Company Taiwan Unified Business Number, 統一編號, Taiwanese tax number
TR TCKIMLIK Person Turkey Türkiye Cumhuriyeti Kimlik Numarası (Personal ID)
TR VKN Tax Turkey Vergi Kimlik Numarası, Turkish tax identification number
SI DDV Vatl Slovenia ID za DDV (Davčna številka, Slovenian VAT number)
SI JMBG Person Slovenia Unique Master Citizen Number (Enotna matična številka občana)
SK DPH Vat Slovakia IČ DPH (IČ pre daň z pridanej hodnoty, Slovak VAT number)
SK RC Person Slovakia RČ (Rodné číslo, the Slovak birth number)
ES CIF Tax/Vat Spain Tax Identifier (Código de Identificación Fiscal)
ES DNI Person Spain Identity code (Documento Nacional de Identidad)
ES NIE Person Spain Identity code foreigner (Número de Identificación de Extranjero)
ES NIF Tax Spain Tax Identifier (Número de Identificación Fiscal)
UY RUT Tax/Vat Uruguay Tax Identifier (Registro Único Tributario)
UY CEDULA Person Uruguay Person Identifier (Cédula de Residencia)
UY NIE Person Uruguay ForeignersI identification Number
UA RNTRC Person Ukraine КПП, RNTRC (Individual taxpayer registration number in Ukraine)
UA EDRPOU Company Ukraine ЄДРПОУ, EDRPOU (Identifier for enterprises and organizations in Ukraine)
US EIN Tax/Company United States Tax Identifier (Employer Identification Number)
US SSN Tax/Individual United States Tax Identifier (Social Security Number)
VE RIF Vat Venezuelan Vat Identifier (Registro de Identificación Fiscal)
VN MST Company Vietnam Mã số thuế, Vietnam tax number
ZA IDNR Person South Africa ID number (South African Identity Document number).
ZA TIN Person/Company South Africa TIN (South African Tax Identification Number).