IDid - Merchant API V3

O objetivo desta documentação é orientar o desenvolvedor sobre como integrar com as APIs da IDid, descrevendo as funcionalidades e os métodos a serem utilizados, listando informações a serem enviadas e recebidas através de exemplos e com uma linguagem simples e acessível. Desse modo, será necessário apenas conhecimentos básicos em linguagem de programação para Web, requisições HTTP/HTTPS e manipulação de arquivos JSON para interagir com nossas APIs.

Nesse documento, você também encontrará a referência sobre todas as operações disponíveis na API REST da IDid. Essas operações devem ser executadas utilizando sua chave específica (token de autorização) nos respectivos endpoints. Para executar uma operação, combine a URL base do ambiente com o endpoint da operação desejada e envie utilizando o formato HTTP correto.

Para facilitar a integração, nós disponibilizamos um ambiente de Sandbox onde você pode realizar testes antes de mudar o ambiente para Produção.

	SANDBOX	PRODUÇÃO
URL base	https://sandbox.ididsecure.net/v3/merchant	https://prod.ididsecure.net/v3/merchant

Outros formatos

No intuito de facilitar o entendimento técnico e implementação da integração com nossa plataforma, também disponibilizamos outros formatos de especificação:

Headers HTTP

Toda requisição precisa de um cabeçalho contendo as informações detalhadas a seguir:

Nome	Valor	Descrição
Content-type	application/json	Formato do corpo da requisição.
Accept	application/json	Indica o tipo de retorno esperado
Authorization	Bearer “accessToken”	Valor do accessToken obtido no endpoint de autenticação

Requisitos mínimos

Possuir uma loja (merchant) ou criar uma nova no painel de controle da IDid;
Para fins de testes no endpoint de venda, utilizar o adquirente padrão (acquirerId = 2);
Efetivar a troca de certificados para a conexão via mTLS com a IDid.

Respostas de erro

Os códigos HTTP convencionais são usados para indicar os tipos de retornos resultantes das requisições. Quando há um erro, é enviada no corpo da resposta uma mensagem descrevendo o motivo do problema. No caso de erros do tipo 400 (bad request), também é retornado um campo “data” com o dado cujo formato deve ser corrigido. As possíveis mensagens com seus respectivos códigos associados podem ser consultadas na tabela de referência de erros.

⚠️ ATENÇÃO: As requisições aos endpoints podem retornar o HTTP Status 401 quando o token de autorização fornecido for inválido ou estiver expirado.

Autenticação ¶

Certificado mTLS

O mTLS (mutual TLS) é uma solução avançada de segurança que proporciona autenticação mútua, onde tanto o cliente quanto o servidor verificam a identidade um do outro antes de iniciar a troca de informações. Essa verificação é realizada através de certificados digitais, garantindo que ambas as partes sejam quem dizem ser. Além da autenticação, o mTLS também implementa criptografia de ponta a ponta, assegurando que todos os dados transmitidos entre o cliente e o servidor sejam protegidos contra interceptações e acesso não autorizado durante todo o processo de comunicação. Isso torna o mTLS uma escolha robusta para proteger comunicações sensíveis em ambientes onde a segurança é crítica.

Todas as transações entre o integrador e a plataforma IDid acontecem sob protocolo mTLS. Será necessário o envio do certificado através do painel de controle IDId, que precisará ser processado pelo departamento de segurança. Assim que o processo for concluído, o usuário que enviou o certificado através do painel receberá um email com o certificado assinado pela IDid

Merchant API utiliza o OAuth 2.0 como protocolo de autenticação para suas chamadas REST. Portanto, faz-se necessário inicialmente utilizar suas chaves de acesso: “clientId” e “clientSecret” (obtidas no painel de controle da plataforma), no endpoint a seguir:

Obter token de acesso ¶

Obter token de acesso
POST`/oauth2/token`

Obtém o token de autorização (JWT) a ser utilizado nos headers de todas as requisições da IDid API.

Example URI

POST https://sandbox.ididsecure.net/v3/merchant/oauth2/token

Request

Headers

Content-Type: application/json

Body (object)

clientId(string, required)
Credencial de identificação da aplicação integradora
clientSecret(string, required)
Credencial de chave secreta da aplicação integradora

{
  "clientId": "69aic4c2nsdad3doih1290hfb5po",
  "clientSecret": "25dva2j4u2asdasdsadai2rehplj1ca0i81fq8camjsuv258mp0dha6"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "clientId": {
      "type": "string",
      "description": "Credencial de identificação da aplicação integradora"
    },
    "clientSecret": {
      "type": "string",
      "description": "Credencial de chave secreta da aplicação integradora"
    }
  },
  "required": [
    "clientId",
    "clientSecret"
  ]
}

Response (200)

Headers

Content-Type: application/json

Body (object)

accessToken(string)
Token de acesso no formato JWT
tokenType(string)
Tipo de token de autenticação
expiresIn(number)
Tempo de expiração do token (3600 segundos)

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQSflKxwRJSMeKKF2QT4fwpMeJf36POk6yJVadQssw5c",
  "tokenType": "Bearer",
  "expiresIn": 3600
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "accessToken": {
      "type": "string",
      "description": "Token de acesso no formato JWT"
    },
    "tokenType": {
      "type": "string",
      "description": "Tipo de token de autenticação"
    },
    "expiresIn": {
      "type": "number",
      "description": "Tempo de expiração do token (3600 segundos)"
    }
  },
  "required": [
    "accessToken"
  ]
}

Emissores ¶

Emissores disponíveis ¶

Emissores disponíveis
GET`/issuers`

Listar os emissores habilitados na plataforma IDid.

Example URI

GET https://sandbox.ididsecure.net/v3/merchant/issuers

Request

Headers

Authorization: Bearer [ACCESS_TOKEN]

Response (200)

Headers

Content-Type: application/json

Body (array[Issuer])

id(string)
Identificador do emissor
name(string)
Nome do emissor
logoUrl(string)
URL da logo
iconUrl(string)
URL do ícone

[
  {
    "id": "aa72ea877e5453189c440c1f6413f720",
    "name": "Emissor Teste",
    "logoUrl": "www.logourl.com.br",
    "iconUrl": "www.iconurl.com.br"
  }
]

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Identificador do emissor"
      },
      "name": {
        "type": "string",
        "description": "Nome do emissor"
      },
      "logoUrl": {
        "type": "string",
        "description": "URL da logo"
      },
      "iconUrl": {
        "type": "string",
        "description": "URL do ícone"
      }
    },
    "required": [
      "id"
    ]
  }
}

Vendas ¶

Existem duas maneiras para criar um novo pedido de vendas na IDid:

Informando apenas o id do banco emissor habilitado, a fim de que o consumidor selecione o cartão desejado dentro da App do emissor;
Além do id do banco emissor, também informar os seis primeiros dígitos (BIN) e os últimos 4 dígitos do cartão selecionado pelo consumidor, para que o mesmo apenas confirme o pagamento na App do emissor.

Em ambos os casos, é fundamental que seja informado o id de um dos emissores habilitados na IDid. Para obter a lista de emissores habilitados, consulte o endpoint Emissores disponíveis.

Dois tipos de pedidos de venda podem ser requisitados na plataforma: Captura imediata e Pré-autorização (EM BREVE). Independente de qual tipo de pedido de venda, poderá ser fornecido um QRCode específico para que o consumidor prossiga com o pagamento na App do emissor do seu cartão, ou apenas uma mensagem com instruções do emissor.

A escolha do comportamento de incialização do pagamento (QRCode ou pagamento direto na App), depende da estratégia de experiência do usuário que a loja integradora quiser oferecer aos seus consumidores.

Exemplo de implementação do checkout integrado com a plataforma IDid:

Exemplo de implementação do checkout integrado com a plataforma IDid

É obrigatório que a loja integradora sempre renderize a mensagem de instruções para o consumidor, de acordo com o que foi retornado no campo qrCodeDetails do objeto order especificado abaixo.

Criar um QRCode de captura imediata ¶

Criar um QRCode de captura imediata
POST`/order`

Criar um QRCode de uma ordem de venda com captura imediata com ou sem cartão de crédito/débito do consumidor.

Example URI

POST https://sandbox.ididsecure.net/v3/merchant/order

Request

Headers

Content-Type: application/json
Authorization: Bearer [ACCESS_TOKEN]

Body (object)

transactionType(string, required)
Tipo de transação que será executada
acquirerId(number, required)
Identificador do adquirente Consulte a seção de referências
card(object)
Dados do cartão do consumidor

bin(string)
6 primeiros dígitos
lastFour(string)
Últimos 4 dígitos do cartão

productType(enum, required)
OPTIONS:DEBIT | CREDIT | MULTIPLE
Método de compra do cartão
issuerId(string)
Identificador do emissor
amount(number, required)
Valor total a ser processado na venda
currencyCode(string, required)
Código da moeda, segundo o padrão ISO-4217
totalInstallments(number, required)
Total de parcelas
firstInstallmentAmount(number)
Valor da primeira parcela
installmentType(enum)
OPTIONS:INTEREST_FREE | INTEREST_BY_MERCHANT | INTEREST_BY_ISSUER
Tipo do parcelamento
billAddress(object, required)
Endereço de faturamento do cartão

streetAddress(string, required)
Nome da avenida ou rua do endereço de faturamento
streetNumber(string, required)
Número do endereço
complement(string)
Complemento
neighborhood(string, required)
Bairro
city(string, required)
Cidade
state(string, required)
Sigla do estado - Ver tabela de estados brasileiros
country(string, required)
Sigla de país com 2 letras, ex: BRA Tabela de países
zipCode(string, required)
CEP

consumer(object)
Dados do consumidor

name(string, required)
Nome do consumidor
surname(string, required)
Sobrenome do consumidor
email(string, required)
Email do consumidor
phoneNumber(string, required)
Número de telefone do consumidor
documentId(string, required)
Documento do consumidor (ex. CPF)

{
  "acquirerId": 1,
  "card": {
    "bin": "400000",
    "lastFour": "1000"
  },
  "productType": "DEBIT",
  "issuerId": "aa72ea877e5453189c440c1f6413f720",
  "amount": 1000,
  "currencyCode": "986",
  "totalInstallments": 1,
  "firstInstallmentAmount": 1000,
  "installmentType": "INTEREST_FREE",
  "billAddress": {
    "streetAddress": "rua exemplo",
    "streetNumber": "123",
    "complement": "ao lado do mercado",
    "neighborhood": "liberdade",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "zipCode": "12345678"
  },
  "consumer": {
    "name": "Alexander",
    "surname": "Matos",
    "email": "alexander@email.com",
    "phoneNumber": "99999999",
    "documentId": "12345678910"
  },
  "transactionType": "AUTHORIZATION"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "transactionType": {
      "type": "string",
      "description": "Tipo de transação que será executada"
    },
    "acquirerId": {
      "type": "number",
      "description": "Identificador do adquirente [Consulte a seção de referências](#acquirerTable)"
    },
    "card": {
      "type": "object",
      "properties": {
        "bin": {
          "type": "string",
          "description": "6 primeiros dígitos"
        },
        "lastFour": {
          "type": "string",
          "description": "Últimos 4 dígitos do cartão"
        }
      },
      "additionalProperties": false,
      "description": "Dados do cartão do consumidor"
    },
    "productType": {
      "type": "string",
      "enum": [
        "DEBIT",
        "CREDIT",
        "MULTIPLE"
      ],
      "description": "Método de compra do cartão"
    },
    "issuerId": {
      "type": "string",
      "description": "Identificador do emissor"
    },
    "amount": {
      "type": "number",
      "description": "Valor total a ser processado na venda"
    },
    "currencyCode": {
      "type": "string",
      "description": "Código da moeda, segundo o padrão [ISO-4217](https://pt.wikipedia.org/wiki/ISO_4217)"
    },
    "totalInstallments": {
      "type": "number",
      "description": "Total de parcelas"
    },
    "firstInstallmentAmount": {
      "type": "number",
      "description": "Valor da primeira parcela"
    },
    "installmentType": {
      "type": "string",
      "enum": [
        "INTEREST_FREE",
        "INTEREST_BY_MERCHANT",
        "INTEREST_BY_ISSUER"
      ],
      "description": "Tipo do parcelamento"
    },
    "billAddress": {
      "type": "object",
      "properties": {
        "streetAddress": {
          "type": "string",
          "description": "Nome da avenida ou rua do endereço de faturamento"
        },
        "streetNumber": {
          "type": "string",
          "description": "Número do endereço"
        },
        "complement": {
          "type": "string",
          "description": "Complemento"
        },
        "neighborhood": {
          "type": "string",
          "description": "Bairro"
        },
        "city": {
          "type": "string",
          "description": "Cidade"
        },
        "state": {
          "type": "string",
          "description": "Sigla do estado - [Ver tabela de estados brasileiros](#statesTable)"
        },
        "country": {
          "type": "string",
          "description": "Sigla de país com 2 letras, ex: BRA [Tabela de países](#countryTable)"
        },
        "zipCode": {
          "type": "string",
          "description": "CEP"
        }
      },
      "required": [
        "streetAddress",
        "streetNumber",
        "neighborhood",
        "city",
        "state",
        "country",
        "zipCode"
      ],
      "description": "Endereço de faturamento do cartão"
    },
    "consumer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Nome do consumidor"
        },
        "surname": {
          "type": "string",
          "description": "Sobrenome do consumidor"
        },
        "email": {
          "type": "string",
          "description": "Email do consumidor"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Número de telefone do consumidor"
        },
        "documentId": {
          "type": "string",
          "description": "Documento do consumidor (ex. CPF)"
        }
      },
      "required": [
        "name",
        "surname",
        "email",
        "phoneNumber",
        "documentId"
      ],
      "additionalProperties": false,
      "description": "Dados do consumidor"
    }
  },
  "required": [
    "transactionType",
    "acquirerId",
    "productType",
    "amount",
    "currencyCode",
    "totalInstallments",
    "billAddress"
  ]
}

Response (201)

Headers

Content-Type: application/json

Body (object)

status(string)
Status do request
orderTxId(string)
Identificador do pedido
qrCodeDetails(object)
Objeto com informações do QRCode

qrCodeStr(string)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”
qrCodeStatus(enum)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos
qrCodeDescription(string)
Instruções de pagamento do emissor para instruir o consumidor.

{
  "status": "Order created.",
  "orderTxId": "123txid",
  "qrCodeDetails": {
    "qrCodeStr": "00020126830011COM.USEIDID2564sandbox.ididsecure.net/v3/order/06c066678b4251cbb33444871467d4725204000053039865802BR5915.. Corporations600062070503...6304A3BE",
    "qrCodeStatus": "REVOKED",
    "qrCodeDescription": "Instruções de pagamento do emissor"
  }
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Status do request"
    },
    "orderTxId": {
      "type": "string",
      "description": "Identificador do pedido"
    },
    "qrCodeDetails": {
      "type": "object",
      "properties": {
        "qrCodeStr": {
          "type": "string",
          "description": "Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”"
        },
        "qrCodeStatus": {
          "type": "string",
          "enum": [
            "REVOKED",
            "UNUSED",
            "USED"
          ],
          "description": "status do QRCode em relação a sua utilização no fluxo de pagamentos"
        },
        "qrCodeDescription": {
          "type": "string",
          "description": "Instruções de pagamento do emissor para instruir o consumidor."
        }
      },
      "required": [
        "qrCodeStr",
        "qrCodeStatus",
        "qrCodeDescription"
      ],
      "description": "Objeto com informações do QRCode"
    }
  }
}

Response (400)

Verificar os erros aplicáveis ao status code 400 na tabela de referência de erros

Headers

Content-Type: application/json

Body (object)

message(string)
Descrição de erro da solicitação.
data(object)
Campo da solicitação onde se encontra o erro.

Response (404)

Verificar os erros aplicáveis ao status code 404 na tabela de referência de erros

Headers

Content-Type: application/json

Body (object)

message(string)
Descrição de erro da solicitação.

Consultar um pedido de venda ¶

Consultar um pedido de venda
GET`/order/{orderTxId}`

Consultar detalhes de um pedido de venda.

Example URI

GET https://sandbox.ididsecure.net/v3/merchant/order/123txid

URI Parameters

HideShow

orderTxId: (string, required)
Identificador do pedido
Example: 123txid

Request

Headers

Authorization: Bearer [ACCESS_TOKEN]

Response (200)

Headers

Content-Type: application/json

Body (object)

orderTxId(string)
Identificador do pedido
orderStatus(object)
Situação do pedido

status(string)
Status do pedido - Ver tabela de status do pedido
updatedAt(string)
Data de atualização do status do pedido

acquirerId(number)
Identificador do adquirente Consulte a seção de referências
card(object)
Dados do cartão do consumidor

bin(string)
6 primeiros dígitos do cartão
lastFour(string)
Últimos 4 dígitos do cartão

productType(enum)
OPTIONS:DEBIT | CREDIT | MULTIPLE
Método de compra do cartão
issuer(object)
Emissor do cartão

id(string)
Identificador do emissor
name(string)
Nome do emissor
logoUrl(string)
URL da logo
iconUrl(string)
URL do ícone

amount(number)
Valor total a ser processado na venda
currencyCode(string)
Código da moeda, segundo o padrão ISO-4217
totalInstallments(number)
Total de parcelas
firstInstallmentAmount(number)
Valor da primeira parcela
installmentType(enum)
OPTIONS:INTEREST_FREE | INTEREST_BY_MERCHANT | INTEREST_BY_ISSUER
Tipo do parcelamento
acquirerName(string)
Nome do adquirente
billAddress(object)
Endereço de faturamento do consumidor

streetAddress(string)
Nome da avenida ou rua do endereço de faturamento
streetNumber(string)
Número do endereço
complement(string)
Complemento
neighborhood(string)
Bairro
city(string)
Cidade
state(string)
Sigla do estado - Ver tabela de estados brasileiros
country(string)
Sigla de país com 2 letras, ex: BRA Tabela de países
zipCode(string)
CEP

consumer(object)
Dados do consumidor

name(string)
Nome do consumidor
surname(string)
Sobrenome do consumidor
email(string)
Email do consumidor
phoneNumber(string)
Número de telefone do consumidor
documentId(string)
Documento do consumidor (ex. CPF)

qrCodeDetails(object)
Objeto com informações do QRCode

qrCodeStr(string)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”
qrCodeStatus(enum)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos
qrCodeDescription(string)
Instruções de pagamento do emissor para instruir o consumidor.

transactions(array[object])
Todas as transações do Pedido

transactionType(string)
Tipo da transação
authorizationCode(string)
Código de autorização
amount(string)
Valor do pedido
transmissionDate(string)
Data de envio da transação
acquirer(object)
Informações do acquirer

acquirerTransactionId(string)
Código da transação enviado pelo acquirer

consumerAuthenticationInformation(object)
Informações da autenticação

status(string)
Status da autenticação
liabilityShift(boolean)
Responsabilidade de cobrir as perdas de transações fraudulentas
referenceId(string)
Código de identificação da transação autenticada
cryptogram(string)
Código do criptograma utilizado na autenticação

{
  "orderTxId": "1txid",
  "orderStatus": {
    "status": "Aprovada emissor",
    "updatedAt": "0000-00-00T00:00:00.000000"
  },
  "acquirerId": 1,
  "card": {
    "bin": "400000",
    "lastFour": "1000"
  },
  "productType": "DEBIT",
  "issuer": {
    "id": "aa72ea877e5453189c440c1f6413f720",
    "name": "Emissor Teste",
    "logoUrl": "www.logourl.com.br",
    "iconUrl": "www.iconurl.com.br"
  },
  "amount": 1000,
  "currencyCode": "986",
  "totalInstallments": 1,
  "firstInstallmentAmount": 1000,
  "installmentType": "INTEREST_FREE",
  "acquirerName": "Adquirente 1",
  "billAddress": {
    "streetAddress": "rua exemplo",
    "streetNumber": "123",
    "complement": "ao lado do mercado",
    "neighborhood": "liberdade",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "zipCode": "12345678"
  },
  "consumer": {
    "name": "Alexander",
    "surname": "Matos",
    "email": "alexander@email.com",
    "phoneNumber": "99999999",
    "documentId": "12345678910"
  },
  "qrCodeDetails": {
    "qrCodeStr": "00020126830011COM.USEIDID2564sandbox.ididsecure.net/v3/order/06c066678b4251cbb33444871467d4725204000053039865802BR5915.. Corporations600062070503...6304A3BE",
    "qrCodeStatus": "REVOKED",
    "qrCodeDescription": "Instruções de pagamento do emissor"
  },
  "transactions": [
    {
      "transactionType": "AUTHORIZATION",
      "authorizationCode": "0",
      "amount": "1000.1",
      "transmissionDate": "0000-00-00T00:00:00.000000",
      "acquirer": {
        "acquirerTransactionId": "1"
      },
      "consumerAuthenticationInformation": {
        "status": "AUTHENTICATION_SUCCESSFUL",
        "liabilityShift": true,
        "referenceId": "7a572650-7690-4fd5-9077-7181cbaa0819",
        "cryptogram": "Y2FyZGluYWxjb21tZXJjZWF1dGg"
      }
    }
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "orderTxId": {
      "type": "string",
      "description": "Identificador do pedido"
    },
    "orderStatus": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "description": "Status do pedido - [Ver tabela de status do pedido](#orderStatus)"
        },
        "updatedAt": {
          "type": "string",
          "description": "Data de atualização do status do pedido"
        }
      },
      "description": "Situação do pedido"
    },
    "acquirerId": {
      "type": "number",
      "description": "Identificador do adquirente [Consulte a seção de referências](#acquirerTable)"
    },
    "card": {
      "type": "object",
      "properties": {
        "bin": {
          "type": "string",
          "description": "6 primeiros dígitos do cartão"
        },
        "lastFour": {
          "type": "string",
          "description": "Últimos 4 dígitos do cartão"
        }
      },
      "required": [
        "bin",
        "lastFour"
      ],
      "additionalProperties": false,
      "description": "Dados do cartão do consumidor"
    },
    "productType": {
      "type": "string",
      "enum": [
        "DEBIT",
        "CREDIT",
        "MULTIPLE"
      ],
      "description": "Método de compra do cartão"
    },
    "issuer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identificador do emissor"
        },
        "name": {
          "type": "string",
          "description": "Nome do emissor"
        },
        "logoUrl": {
          "type": "string",
          "description": "URL da logo"
        },
        "iconUrl": {
          "type": "string",
          "description": "URL do ícone"
        }
      },
      "required": [
        "id"
      ],
      "description": "Emissor do cartão"
    },
    "amount": {
      "type": "number",
      "description": "Valor total a ser processado na venda"
    },
    "currencyCode": {
      "type": "string",
      "description": "Código da moeda, segundo o padrão [ISO-4217](https://pt.wikipedia.org/wiki/ISO_4217)"
    },
    "totalInstallments": {
      "type": "number",
      "description": "Total de parcelas"
    },
    "firstInstallmentAmount": {
      "type": "number",
      "description": "Valor da primeira parcela"
    },
    "installmentType": {
      "type": "string",
      "enum": [
        "INTEREST_FREE",
        "INTEREST_BY_MERCHANT",
        "INTEREST_BY_ISSUER"
      ],
      "description": "Tipo do parcelamento"
    },
    "acquirerName": {
      "type": "string",
      "description": "Nome do adquirente"
    },
    "billAddress": {
      "type": "object",
      "properties": {
        "streetAddress": {
          "type": "string",
          "description": "Nome da avenida ou rua do endereço de faturamento"
        },
        "streetNumber": {
          "type": "string",
          "description": "Número do endereço"
        },
        "complement": {
          "type": "string",
          "description": "Complemento"
        },
        "neighborhood": {
          "type": "string",
          "description": "Bairro"
        },
        "city": {
          "type": "string",
          "description": "Cidade"
        },
        "state": {
          "type": "string",
          "description": "Sigla do estado - [Ver tabela de estados brasileiros](#statesTable)"
        },
        "country": {
          "type": "string",
          "description": "Sigla de país com 2 letras, ex: BRA [Tabela de países](#countryTable)"
        },
        "zipCode": {
          "type": "string",
          "description": "CEP"
        }
      },
      "required": [
        "streetAddress",
        "streetNumber",
        "neighborhood",
        "city",
        "state",
        "country",
        "zipCode"
      ],
      "description": "Endereço de faturamento do consumidor"
    },
    "consumer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Nome do consumidor"
        },
        "surname": {
          "type": "string",
          "description": "Sobrenome do consumidor"
        },
        "email": {
          "type": "string",
          "description": "Email do consumidor"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Número de telefone do consumidor"
        },
        "documentId": {
          "type": "string",
          "description": "Documento do consumidor (ex. CPF)"
        }
      },
      "required": [
        "name",
        "surname",
        "email",
        "phoneNumber",
        "documentId"
      ],
      "description": "Dados do consumidor"
    },
    "qrCodeDetails": {
      "type": "object",
      "properties": {
        "qrCodeStr": {
          "type": "string",
          "description": "Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”"
        },
        "qrCodeStatus": {
          "type": "string",
          "enum": [
            "REVOKED",
            "UNUSED",
            "USED"
          ],
          "description": "status do QRCode em relação a sua utilização no fluxo de pagamentos"
        },
        "qrCodeDescription": {
          "type": "string",
          "description": "Instruções de pagamento do emissor para instruir o consumidor."
        }
      },
      "required": [
        "qrCodeStr",
        "qrCodeStatus",
        "qrCodeDescription"
      ],
      "description": "Objeto com informações do QRCode"
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "transactionType": {
            "type": "string",
            "description": "Tipo da transação"
          },
          "authorizationCode": {
            "type": "string",
            "description": "Código de autorização"
          },
          "amount": {
            "type": "string",
            "description": "Valor do pedido"
          },
          "transmissionDate": {
            "type": "string",
            "description": "Data de envio da transação"
          },
          "acquirer": {
            "type": "object",
            "properties": {
              "acquirerTransactionId": {
                "type": "string",
                "description": "Código da transação enviado pelo acquirer"
              }
            },
            "description": "Informações do acquirer"
          },
          "consumerAuthenticationInformation": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "description": "Status da autenticação"
              },
              "liabilityShift": {
                "type": "boolean",
                "description": "Responsabilidade de cobrir as perdas de transações fraudulentas"
              },
              "referenceId": {
                "type": "string",
                "description": "Código de identificação da transação autenticada"
              },
              "cryptogram": {
                "type": "string",
                "description": "Código do criptograma utilizado na autenticação"
              }
            },
            "description": "Informações da autenticação"
          }
        }
      },
      "description": "Todas as transações do Pedido"
    }
  },
  "required": [
    "acquirerId",
    "productType",
    "amount",
    "currencyCode",
    "totalInstallments",
    "consumer"
  ]
}

Response (404)

Verificar os erros aplicáveis ao status code 404 na tabela de referência de erros

Headers

Content-Type: application/json

Body (object)

message(string)
Descrição de erro da solicitação.

Consultar pedidos por período ¶

Consultar pedidos por período
GET`/order/{?startDate,endDate}`

Consultar detalhes de pedidos de venda por período.

Example URI

GET https://sandbox.ididsecure.net/v3/merchant/order/?startDate=2019-01-01&endDate=2024-01-28

URI Parameters

HideShow

startDate: (string, required)
Data inicial do período de busca (aaaa-mm-dd)
Example: 2019-01-01
endDate: (string, required)
Data final do período de busca (aaaa-mm-dd)
Example: 2024-01-28

Request

Headers

Content-Type: application/json
Authorization: Bearer [ACCESS_TOKEN]

Response (200)

Headers

Content-Type: application/json

Body (object)

next(string)
Endereço da próxima página de registros
previous(string)
Endereço da página anterior de registros
count(number)
Total de registros
results(array[object])
Lista de pedidos do período

orderTxId(string)
Identificador do pedido
orderStatus(object)
Situação do pedido

status(string)
Status do pedido - Ver tabela de status do pedido
updatedAt(string)
Data de atualização do status do pedido

acquirerId(number)
Identificador do adquirente Consulte a seção de referências
card(object)
Dados do cartão do consumidor

bin(string)
6 primeiros dígitos do cartão
lastFour(string)
Últimos 4 dígitos do cartão

productType(enum)
OPTIONS:DEBIT | CREDIT | MULTIPLE
Método de compra do cartão
issuer(object)
Emissor do cartão

id(string)
Identificador do emissor
name(string)
Nome do emissor
logoUrl(string)
URL da logo
iconUrl(string)
URL do ícone

amount(number)
Valor total a ser processado na venda
currencyCode(string)
Código da moeda, segundo o padrão ISO-4217
totalInstallments(number)
Total de parcelas
firstInstallmentAmount(number)
Valor da primeira parcela
installmentType(enum)
OPTIONS:INTEREST_FREE | INTEREST_BY_MERCHANT | INTEREST_BY_ISSUER
Tipo do parcelamento
acquirerName(string)
Nome do adquirente
billAddress(object)
Endereço de faturamento do consumidor

streetAddress(string)
Nome da avenida ou rua do endereço de faturamento
streetNumber(string)
Número do endereço
complement(string)
Complemento
neighborhood(string)
Bairro
city(string)
Cidade
state(string)
Sigla do estado - Ver tabela de estados brasileiros
country(string)
Sigla de país com 2 letras, ex: BRA Tabela de países
zipCode(string)
CEP

consumer(object)
Dados do consumidor

name(string)
Nome do consumidor
surname(string)
Sobrenome do consumidor
email(string)
Email do consumidor
phoneNumber(string)
Número de telefone do consumidor
documentId(string)
Documento do consumidor (ex. CPF)

qrCodeDetails(object)
Objeto com informações do QRCode

qrCodeStr(string)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”
qrCodeStatus(enum)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos
qrCodeDescription(string)
Instruções de pagamento do emissor para instruir o consumidor.

transactions(array[object])
Todas as transações do Pedido

transactionType(string)
Tipo da transação
authorizationCode(string)
Código de autorização
amount(string)
Valor do pedido
transmissionDate(string)
Data de envio da transação
acquirer(object)
Informações do acquirer

acquirerTransactionId(string)
Código da transação enviado pelo acquirer

consumerAuthenticationInformation(object)
Informações da autenticação

status(string)
Status da autenticação
liabilityShift(boolean)
Responsabilidade de cobrir as perdas de transações fraudulentas
referenceId(string)
Código de identificação da transação autenticada
cryptogram(string)
Código do criptograma utilizado na autenticação

{
  "next": "https://sandbox.ididsecure.net/v3/merchant/order/?endDate=0000-00-00&page=4&startDate=0000-00-00",
  "previous": "https://sandbox.ididsecure.net/v3/merchant/order/?endDate=0000-00-00&page=2&startDate=0000-00-00",
  "count": 200,
  "results": [
    {
      "orderTxId": "1txid",
      "orderStatus": {
        "status": "Aprovada emissor",
        "updatedAt": "0000-00-00T00:00:00.000000"
      },
      "acquirerId": 1,
      "card": {
        "bin": "400000",
        "lastFour": "1000"
      },
      "productType": "DEBIT",
      "issuer": {
        "id": "aa72ea877e5453189c440c1f6413f720",
        "name": "Emissor Teste",
        "logoUrl": "www.logourl.com.br",
        "iconUrl": "www.iconurl.com.br"
      },
      "amount": 1000,
      "currencyCode": "986",
      "totalInstallments": 1,
      "firstInstallmentAmount": 1000,
      "installmentType": "INTEREST_FREE",
      "acquirerName": "Adquirente 1",
      "billAddress": {
        "streetAddress": "rua exemplo",
        "streetNumber": "123",
        "complement": "ao lado do mercado",
        "neighborhood": "liberdade",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "zipCode": "12345678"
      },
      "consumer": {
        "name": "Alexander",
        "surname": "Matos",
        "email": "alexander@email.com",
        "phoneNumber": "99999999",
        "documentId": "12345678910"
      },
      "qrCodeDetails": {
        "qrCodeStr": "00020126830011COM.USEIDID2564sandbox.ididsecure.net/v3/order/06c066678b4251cbb33444871467d4725204000053039865802BR5915.. Corporations600062070503...6304A3BE",
        "qrCodeStatus": "REVOKED",
        "qrCodeDescription": "Instruções de pagamento do emissor"
      },
      "transactions": [
        {
          "transactionType": "AUTHORIZATION",
          "authorizationCode": "0",
          "amount": "1000.1",
          "transmissionDate": "0000-00-00T00:00:00.000000",
          "acquirer": {
            "acquirerTransactionId": "1"
          },
          "consumerAuthenticationInformation": {
            "status": "AUTHENTICATION_SUCCESSFUL",
            "liabilityShift": true,
            "referenceId": "7a572650-7690-4fd5-9077-7181cbaa0819",
            "cryptogram": "Y2FyZGluYWxjb21tZXJjZWF1dGg"
          }
        }
      ]
    }
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "next": {
      "type": "string",
      "description": "Endereço da próxima página de registros"
    },
    "previous": {
      "type": "string",
      "description": "Endereço da página anterior de registros"
    },
    "count": {
      "type": "number",
      "description": "Total de registros"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "orderTxId": {
            "type": "string",
            "description": "Identificador do pedido"
          },
          "orderStatus": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "description": "Status do pedido - [Ver tabela de status do pedido](#orderStatus)"
              },
              "updatedAt": {
                "type": "string",
                "description": "Data de atualização do status do pedido"
              }
            },
            "description": "Situação do pedido"
          },
          "acquirerId": {
            "type": "number",
            "description": "Identificador do adquirente [Consulte a seção de referências](#acquirerTable)"
          },
          "card": {
            "type": "object",
            "properties": {
              "bin": {
                "type": "string",
                "description": "6 primeiros dígitos do cartão"
              },
              "lastFour": {
                "type": "string",
                "description": "Últimos 4 dígitos do cartão"
              }
            },
            "required": [
              "bin",
              "lastFour"
            ],
            "additionalProperties": false,
            "description": "Dados do cartão do consumidor"
          },
          "productType": {
            "type": "string",
            "enum": [
              "DEBIT",
              "CREDIT",
              "MULTIPLE"
            ],
            "description": "Método de compra do cartão"
          },
          "issuer": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identificador do emissor"
              },
              "name": {
                "type": "string",
                "description": "Nome do emissor"
              },
              "logoUrl": {
                "type": "string",
                "description": "URL da logo"
              },
              "iconUrl": {
                "type": "string",
                "description": "URL do ícone"
              }
            },
            "required": [
              "id"
            ],
            "description": "Emissor do cartão"
          },
          "amount": {
            "type": "number",
            "description": "Valor total a ser processado na venda"
          },
          "currencyCode": {
            "type": "string",
            "description": "Código da moeda, segundo o padrão [ISO-4217](https://pt.wikipedia.org/wiki/ISO_4217)"
          },
          "totalInstallments": {
            "type": "number",
            "description": "Total de parcelas"
          },
          "firstInstallmentAmount": {
            "type": "number",
            "description": "Valor da primeira parcela"
          },
          "installmentType": {
            "type": "string",
            "enum": [
              "INTEREST_FREE",
              "INTEREST_BY_MERCHANT",
              "INTEREST_BY_ISSUER"
            ],
            "description": "Tipo do parcelamento"
          },
          "acquirerName": {
            "type": "string",
            "description": "Nome do adquirente"
          },
          "billAddress": {
            "type": "object",
            "properties": {
              "streetAddress": {
                "type": "string",
                "description": "Nome da avenida ou rua do endereço de faturamento"
              },
              "streetNumber": {
                "type": "string",
                "description": "Número do endereço"
              },
              "complement": {
                "type": "string",
                "description": "Complemento"
              },
              "neighborhood": {
                "type": "string",
                "description": "Bairro"
              },
              "city": {
                "type": "string",
                "description": "Cidade"
              },
              "state": {
                "type": "string",
                "description": "Sigla do estado - [Ver tabela de estados brasileiros](#statesTable)"
              },
              "country": {
                "type": "string",
                "description": "Sigla de país com 2 letras, ex: BRA [Tabela de países](#countryTable)"
              },
              "zipCode": {
                "type": "string",
                "description": "CEP"
              }
            },
            "required": [
              "streetAddress",
              "streetNumber",
              "neighborhood",
              "city",
              "state",
              "country",
              "zipCode"
            ],
            "description": "Endereço de faturamento do consumidor"
          },
          "consumer": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "Nome do consumidor"
              },
              "surname": {
                "type": "string",
                "description": "Sobrenome do consumidor"
              },
              "email": {
                "type": "string",
                "description": "Email do consumidor"
              },
              "phoneNumber": {
                "type": "string",
                "description": "Número de telefone do consumidor"
              },
              "documentId": {
                "type": "string",
                "description": "Documento do consumidor (ex. CPF)"
              }
            },
            "required": [
              "name",
              "surname",
              "email",
              "phoneNumber",
              "documentId"
            ],
            "description": "Dados do consumidor"
          },
          "qrCodeDetails": {
            "type": "object",
            "properties": {
              "qrCodeStr": {
                "type": "string",
                "description": "Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”"
              },
              "qrCodeStatus": {
                "type": "string",
                "enum": [
                  "REVOKED",
                  "UNUSED",
                  "USED"
                ],
                "description": "status do QRCode em relação a sua utilização no fluxo de pagamentos"
              },
              "qrCodeDescription": {
                "type": "string",
                "description": "Instruções de pagamento do emissor para instruir o consumidor."
              }
            },
            "required": [
              "qrCodeStr",
              "qrCodeStatus",
              "qrCodeDescription"
            ],
            "description": "Objeto com informações do QRCode"
          },
          "transactions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "transactionType": {
                  "type": "string",
                  "description": "Tipo da transação"
                },
                "authorizationCode": {
                  "type": "string",
                  "description": "Código de autorização"
                },
                "amount": {
                  "type": "string",
                  "description": "Valor do pedido"
                },
                "transmissionDate": {
                  "type": "string",
                  "description": "Data de envio da transação"
                },
                "acquirer": {
                  "type": "object",
                  "properties": {
                    "acquirerTransactionId": {
                      "type": "string",
                      "description": "Código da transação enviado pelo acquirer"
                    }
                  },
                  "description": "Informações do acquirer"
                },
                "consumerAuthenticationInformation": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Status da autenticação"
                    },
                    "liabilityShift": {
                      "type": "boolean",
                      "description": "Responsabilidade de cobrir as perdas de transações fraudulentas"
                    },
                    "referenceId": {
                      "type": "string",
                      "description": "Código de identificação da transação autenticada"
                    },
                    "cryptogram": {
                      "type": "string",
                      "description": "Código do criptograma utilizado na autenticação"
                    }
                  },
                  "description": "Informações da autenticação"
                }
              }
            },
            "description": "Todas as transações do Pedido"
          }
        },
        "required": [
          "acquirerId",
          "productType",
          "amount",
          "currencyCode",
          "totalInstallments",
          "consumer"
        ]
      },
      "description": "Lista de pedidos do período"
    }
  }
}

Revogar QRCode ¶

Revogar QRCode
PUT`/order/{orderTxId}`

Revogar o QRCode criado para o pedido de venda. Depois de revogado, não será mais possível o cliente escaneá-lo na App do emissor.

Example URI

PUT https://sandbox.ididsecure.net/v3/merchant/order/123txid

URI Parameters

HideShow

orderTxId: (string, required)
Identificador do pedido de venda
Example: 123txid

Request

Headers

Content-Type: application/json
Authorization: Bearer [ACCESS_TOKEN]

Body (object)

qrCodeDetails(object, required)
Objeto com informações do QRCode

qrCodeStatus(string, required)
Status de revogado

{
  "qrCodeDetails": {
    "qrCodeStatus": "REVOKED"
  }
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "qrCodeDetails": {
      "type": "object",
      "properties": {
        "qrCodeStatus": {
          "type": "string",
          "description": "Status de revogado"
        }
      },
      "required": [
        "qrCodeStatus"
      ],
      "description": "Objeto com informações do QRCode"
    }
  },
  "required": [
    "qrCodeDetails"
  ]
}

Response (200)

Headers

Content-Type: application/json

Body (object)

orderTxId(string)
Identificador da ordem de venda
status(string)
Status da ordem de venda

{
  "orderTxId": "123txid",
  "status": "Order updated."
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "orderTxId": {
      "type": "string",
      "description": "Identificador da ordem de venda"
    },
    "status": {
      "type": "string",
      "description": "Status da ordem de venda"
    }
  }
}

Response (400)

Verificar os erros aplicáveis ao status code 400 na tabela de referência de erros

Headers

Content-Type: application/json

Body (object)

message(string)
Descrição de erro da solicitação.
data(object)
Campo da solicitação onde se encontra o erro.

Response (404)

Verificar os erros aplicáveis ao status code 404 na tabela de referência de erros

Headers

Content-Type: application/json

Body (object)

message(string)
Descrição de erro da solicitação.

Webhook ¶

Webhook que será disparado para o comércio sempre que houver uma mudança de status em algum pedido do mesmo.

CLIENT-URL ¶

CLIENT-URL
POST`https://CLIENT-URL`

Example URI

POST https://CLIENT-URL

Request

Headers

Content-Type: application/json

Body (object)

orderTxId(string)
Identificador do pedido
orderStatus(object)
Situação do pedido

status(string)
Status do pedido - Ver tabela de status do pedido
updatedAt(string)
Data de atualização do status do pedido

acquirerId(number, required)
Identificador do adquirente Consulte a seção de referências
productType(enum, required)
OPTIONS:DEBIT | CREDIT | MULTIPLE
Método de compra do cartão
issuer(object)
Emissor do cartão

id(string, required)
Identificador do emissor
name(string, required)
Nome do emissor
logoUrl(string)
URL da logo
iconUrl(string)
URL do ícone

amount(number, required)
Valor total a ser processado na venda
currencyCode(string, required)
Código da moeda, segundo o padrão ISO-4217
totalInstallments(number, required)
Total de parcelas
firstInstallmentAmount(number)
Valor da primeira parcela
installmentType(enum)
OPTIONS:INTEREST_FREE | INTEREST_BY_MERCHANT | INTEREST_BY_ISSUER
Tipo do parcelamento
acquirerName(string)
Nome do adquirente
billAddress(object)
Endereço de faturamento do consumidor

streetAddress(string, required)
Nome da avenida ou rua do endereço de faturamento
streetNumber(string, required)
Número do endereço
complement(string)
Complemento
neighborhood(string, required)
Bairro
city(string, required)
Cidade
state(string, required)
Sigla do estado - Ver tabela de estados brasileiros
country(string, required)
Sigla de país com 2 letras, ex: BRA Tabela de países
zipCode(string, required)
CEP

consumer(object, required)
Dados do consumidor

name(string, required)
Nome do consumidor
surname(string, required)
Sobrenome do consumidor
email(string, required)
Email do consumidor
phoneNumber(string, required)
Número de telefone do consumidor
documentId(string, required)
Documento do consumidor (ex. CPF)

qrCodeDetails(object)
Objeto com informações do QRCode

qrCodeStr(string, required)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”
qrCodeStatus(enum, required)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos
qrCodeDescription(string, required)
Instruções de pagamento do emissor para instruir o consumidor.

transactions(array[object])
Todas as transações do Pedido

transactionType(string)
Tipo da transação
authorizationCode(string)
Código de autorização
amount(string, required)
Valor do pedido
transmissionDate(string)
Data de envio da transação
acquirer(object)
Informações do acquirer

acquirerTransactionId(string)
Código da transação enviado pelo acquirer

consumerAuthenticationInformation(object)
Informações da autenticação

status(string)
Status da autenticação
liabilityShift(boolean)
Responsabilidade de cobrir as perdas de transações fraudulentas
referenceId(string)
Código de identificação da transação autenticada
cryptogram(string)
Código do criptograma utilizado na autenticação

{
  "orderTxId": "1txid",
  "orderStatus": {
    "status": "Aprovada emissor",
    "updatedAt": "0000-00-00T00:00:00.000000"
  },
  "acquirerId": 1,
  "productType": "DEBIT",
  "issuer": {
    "id": "aa72ea877e5453189c440c1f6413f720",
    "name": "Emissor Teste",
    "logoUrl": "www.logourl.com.br",
    "iconUrl": "www.iconurl.com.br"
  },
  "amount": 1000,
  "currencyCode": "986",
  "totalInstallments": 1,
  "firstInstallmentAmount": 1000,
  "installmentType": "INTEREST_FREE",
  "acquirerName": "Adquirente 1",
  "billAddress": {
    "streetAddress": "rua exemplo",
    "streetNumber": "123",
    "complement": "ao lado do mercado",
    "neighborhood": "liberdade",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "zipCode": "12345678"
  },
  "consumer": {
    "name": "Alexander",
    "surname": "Matos",
    "email": "alexander@email.com",
    "phoneNumber": "99999999",
    "documentId": "12345678910"
  },
  "qrCodeDetails": {
    "qrCodeStr": "00020126830011COM.USEIDID2564sandbox.ididsecure.net/v3/order/06c066678b4251cbb33444871467d4725204000053039865802BR5915.. Corporations600062070503...6304A3BE",
    "qrCodeStatus": "REVOKED",
    "qrCodeDescription": "Instruções de pagamento do emissor"
  },
  "transactions": [
    {
      "transactionType": "AUTHORIZATION",
      "authorizationCode": "0",
      "amount": "1000.1",
      "transmissionDate": "0000-00-00T00:00:00.000000",
      "acquirer": {
        "acquirerTransactionId": "1"
      },
      "consumerAuthenticationInformation": {
        "status": "AUTHENTICATION_SUCCESSFUL",
        "liabilityShift": true,
        "referenceId": "7a572650-7690-4fd5-9077-7181cbaa0819",
        "cryptogram": "Y2FyZGluYWxjb21tZXJjZWF1dGg"
      }
    }
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "orderTxId": {
      "type": "string",
      "description": "Identificador do pedido"
    },
    "orderStatus": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "description": "Status do pedido - [Ver tabela de status do pedido](#orderStatus)"
        },
        "updatedAt": {
          "type": "string",
          "description": "Data de atualização do status do pedido"
        }
      },
      "description": "Situação do pedido"
    },
    "acquirerId": {
      "type": "number",
      "description": "Identificador do adquirente [Consulte a seção de referências](#acquirerTable)"
    },
    "productType": {
      "type": "string",
      "enum": [
        "DEBIT",
        "CREDIT",
        "MULTIPLE"
      ],
      "description": "Método de compra do cartão"
    },
    "issuer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identificador do emissor"
        },
        "name": {
          "type": "string",
          "description": "Nome do emissor"
        },
        "logoUrl": {
          "type": "string",
          "description": "URL da logo"
        },
        "iconUrl": {
          "type": "string",
          "description": "URL do ícone"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "additionalProperties": false,
      "description": "Emissor do cartão"
    },
    "amount": {
      "type": "number",
      "description": "Valor total a ser processado na venda"
    },
    "currencyCode": {
      "type": "string",
      "description": "Código da moeda, segundo o padrão [ISO-4217](https://pt.wikipedia.org/wiki/ISO_4217)"
    },
    "totalInstallments": {
      "type": "number",
      "description": "Total de parcelas"
    },
    "firstInstallmentAmount": {
      "type": "number",
      "description": "Valor da primeira parcela"
    },
    "installmentType": {
      "type": "string",
      "enum": [
        "INTEREST_FREE",
        "INTEREST_BY_MERCHANT",
        "INTEREST_BY_ISSUER"
      ],
      "description": "Tipo do parcelamento"
    },
    "acquirerName": {
      "type": "string",
      "description": "Nome do adquirente"
    },
    "billAddress": {
      "type": "object",
      "properties": {
        "streetAddress": {
          "type": "string",
          "description": "Nome da avenida ou rua do endereço de faturamento"
        },
        "streetNumber": {
          "type": "string",
          "description": "Número do endereço"
        },
        "complement": {
          "type": "string",
          "description": "Complemento"
        },
        "neighborhood": {
          "type": "string",
          "description": "Bairro"
        },
        "city": {
          "type": "string",
          "description": "Cidade"
        },
        "state": {
          "type": "string",
          "description": "Sigla do estado - [Ver tabela de estados brasileiros](#statesTable)"
        },
        "country": {
          "type": "string",
          "description": "Sigla de país com 2 letras, ex: BRA [Tabela de países](#countryTable)"
        },
        "zipCode": {
          "type": "string",
          "description": "CEP"
        }
      },
      "required": [
        "streetAddress",
        "streetNumber",
        "neighborhood",
        "city",
        "state",
        "country",
        "zipCode"
      ],
      "description": "Endereço de faturamento do consumidor"
    },
    "consumer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Nome do consumidor"
        },
        "surname": {
          "type": "string",
          "description": "Sobrenome do consumidor"
        },
        "email": {
          "type": "string",
          "description": "Email do consumidor"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Número de telefone do consumidor"
        },
        "documentId": {
          "type": "string",
          "description": "Documento do consumidor (ex. CPF)"
        }
      },
      "required": [
        "name",
        "surname",
        "email",
        "phoneNumber",
        "documentId"
      ],
      "description": "Dados do consumidor"
    },
    "qrCodeDetails": {
      "type": "object",
      "properties": {
        "qrCodeStr": {
          "type": "string",
          "description": "Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”"
        },
        "qrCodeStatus": {
          "type": "string",
          "enum": [
            "REVOKED",
            "UNUSED",
            "USED"
          ],
          "description": "status do QRCode em relação a sua utilização no fluxo de pagamentos"
        },
        "qrCodeDescription": {
          "type": "string",
          "description": "Instruções de pagamento do emissor para instruir o consumidor."
        }
      },
      "required": [
        "qrCodeStr",
        "qrCodeStatus",
        "qrCodeDescription"
      ],
      "description": "Objeto com informações do QRCode"
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "transactionType": {
            "type": "string",
            "description": "Tipo da transação"
          },
          "authorizationCode": {
            "type": "string",
            "description": "Código de autorização"
          },
          "amount": {
            "type": "string",
            "description": "Valor do pedido"
          },
          "transmissionDate": {
            "type": "string",
            "description": "Data de envio da transação"
          },
          "acquirer": {
            "type": "object",
            "properties": {
              "acquirerTransactionId": {
                "type": "string",
                "description": "Código da transação enviado pelo acquirer"
              }
            },
            "description": "Informações do acquirer"
          },
          "consumerAuthenticationInformation": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "description": "Status da autenticação"
              },
              "liabilityShift": {
                "type": "boolean",
                "description": "Responsabilidade de cobrir as perdas de transações fraudulentas"
              },
              "referenceId": {
                "type": "string",
                "description": "Código de identificação da transação autenticada"
              },
              "cryptogram": {
                "type": "string",
                "description": "Código do criptograma utilizado na autenticação"
              }
            },
            "description": "Informações da autenticação"
          }
        }
      },
      "description": "Todas as transações do Pedido"
    }
  },
  "required": [
    "acquirerId",
    "productType",
    "amount",
    "currencyCode",
    "totalInstallments",
    "consumer"
  ]
}

Response (200)

Headers

Content-Type: application/json

No content

Simulador ¶

Simulador de aprovação de transações ¶

Simulador de aprovação de transações
POST`/simulation/order/{orderTxId}/transaction`

Simula decisão do consumidor no App do Emissor e a aprovação ou não da transação final.

Example URI

POST https://sandbox.ididsecure.net/v3/merchant/simulation/order/123txid/transaction

URI Parameters

HideShow

orderTxId: (string, required)
Identificador do pedido de venda
Example: 123txid

Request

Headers

Content-Type: application/json
Authorization: Bearer [ACCESS_TOKEN]

Body (object)

isSuccess(boolean, required)
Indica se a transação vai ser aprovada ou não pelo emissor.
consumerDecision(enum, required)
OPTIONS:APPROVE | DISAPPROVE
Indica se o consumidor aceitou ou não.

{
  "isSuccess": true,
  "consumerDecision": "APPROVE"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "isSuccess": {
      "type": "boolean",
      "description": "Indica se a transação vai ser aprovada ou não pelo emissor."
    },
    "consumerDecision": {
      "type": "string",
      "enum": [
        "APPROVE",
        "DISAPPROVE"
      ],
      "description": "Indica se o consumidor aceitou ou não."
    }
  },
  "required": [
    "isSuccess",
    "consumerDecision"
  ]
}

Response (200)

Headers

Content-Type: application/json

Body (object)

status(string)
Indica se a operação foi concluida com sucesso.

{
  "status": "Consumer approved. Transaction sent for authorizer."
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Indica se a operação foi concluida com sucesso."
    }
  }
}

Response (400)

Verificar os erros aplicáveis ao status code 400 na tabela de referência de erros

Headers

Content-Type: application/json

Body (object)

message(string)
Descrição de erro da solicitação.
data(object)
Campo da solicitação onde se encontra o erro.

Response (404)

Verificar os erros aplicáveis ao status code 404 na tabela de referência de erros

Headers

Content-Type: application/json

Body (object)

message(string)
Descrição de erro da solicitação.

Tabelas de referência ¶

Tabelas de informações utilizadas na IDid API.

Acquirers (acquirerId)

ID	Name
1	GLOBAL PAYMENTS
2	CIELO
3	BIN
4	GETNET
5	STONE
6	REDE

Bandeiras de cartão

Bandeira
ELO
VISA
MASTERCARD
AMEX
DISCOVER
INTERLINK
STAR
ACCEL
INTERAC
VISA READYLINK
PULSE
JCB
DINERS

Códigos de estados e DDD

Código	Descrição	DDD
AC	Acre	58
AL	Alagoas	82
AP	Amapá	96
AM	Amazonas	92, 97
BA	Bahia	71, 73, 74, 75, 77
CE	Ceará	85, 88
DF	Distrito Federal	61
ES	Espírito Santo	27, 28
GO	Goiás	62, 64
MA	Maranhão	98, 99
MT	Mato Grosso	65, 66
MS	Mato Grosso do Sul	67
MG	Minas Gerais	31, 32, 33, 34, 35, 37, 38
PA	Pará	91, 93, 94
PB	Paraíba	83
PR	Paraná	41, 42, 43, 44, 45, 46
PE	Pernambuco	81, 87
PI	Piauí	86, 89
RJ	Rio de Janeiro	21, 22, 24
RN	Rio Grande do Norte	84
RS	Rio Grande do Sul	51, 53, 54, 55
RO	Rondônia	69
RR	Roraima	95
SC	Santa Catarina	47, 48, 49
SP	São Paulo	11, 12, 13, 14, 15, 16, 17, 18, 19
SE	Sergipe	79
TO	Tocantins	63

Códigos de localização (países e DDI)

Código	Descrição	DDI
AF	Afghanistan	93
AL	Albania	355
DZ	Algeria	213
AS	American Samoa	1-684
AD	Andorra	376
AO	Angola	244
AI	Anguilla	1-264
AQ	Antarctica	672
AG	Antigua and Barbuda	1-268
AR	Argentina	54
AM	Armenia	374
AW	Aruba	297
AU	Australia	61
AT	Austria	43
AZ	Azerbaijan	994
BS	Bahamas	1-242
BH	Bahrain	973
BD	Bangladesh	880
BB	Barbados	1-246
BY	Belarus	375
BE	Belgium	32
BZ	Belize	501
BJ	Benin	229
BM	Bermuda	1-441
BT	Bhutan	975
BO	Bolivia	591
BA	Bosnia and Herzegovina	387
BW	Botswana	267
BR	Brazil	55
IO	British Indian Ocean Territory	246
VG	British Virgin Islands	1-284
BN	Brunei	673
BG	Bulgaria	359
BF	Burkina Faso	226
BI	Burundi	257
KH	Cambodia	855
CM	Cameroon	237
CA	Canada	1
CV	Cape Verde	238
KY	Cayman Islands	1-345
CF	Central African Republic	236
TD	Chad	235
CL	Chile	56
CN	China	86
CX	Christmas Island	61
CC	Cocos Islands	61
CO	Colombia	57
KM	Comoros	269
CK	Cook Islands	682
CR	Costa Rica	506
HR	Croatia	385
CU	Cuba	53
CW	Curacao	599
CY	Cyprus	357
CZ	Czech Republic	420
CD	Democratic Republic of Congo	243
DK	Denmark	45
DJ	Djibouti	253
DM	Dominica	1-767
DO	Dominican Republic	1-809, 1-829, 1-849
TL	East Timor	670
EC	Ecuador	593
EG	Egypt	20
SV	El Salvador	503
GQ	Equatorial Guinea	240
ER	Eritrea	291
EE	Estonia	372
ET	Ethiopia	251
FK	Falkland Islands	500
FO	Faroe Islands	298
FJ	Fiji	679
FI	Finland	358
FR	France	33
PF	French Polynesia	689
GA	Gabon	241
GM	Gambia	220
GE	Georgia	995
DE	Germany	49
GH	Ghana	233
GI	Gibraltar	350
GR	Greece	30
GL	Greenland	299
GD	Grenada	1-473
GU	Guam	1-671
GT	Guatemala	502
GG	Guernsey	44-1481
GN	Guinea	224
GW	Guinea-Bissau	245
GY	Guyana	592
HT	Haiti	509
HN	Honduras	504
HK	Hong Kong	852
HU	Hungary	36
IS	Iceland	354
IS	Iceland	354
IN	India	91
ID	Indonesia	62
IR	Iran	98
IQ	Iraq	964
IE	Ireland	353
IM	Isle of Man	44-1624
IL	Israel	972
IT	Italy	39
CI	Ivory Coast	225
JM	Jamaica	1-876
JP	Japan	81
JE	Jersey	44-1534
JO	Jordan	962
KZ	Kazakhstan	7
KE	Kenya	254
KI	Kiribati	686
XK	Kosovo	383
KW	Kuwait	965
KG	Kyrgyzstan	996
LA	Laos	856
LV	Latvia	371
LB	Lebanon	961
LS	Lesotho	266
LR	Liberia	231
LY	Libya	218
LI	Liechtenstein	423
LT	Lithuania	370
LU	Luxembourg	352
MO	Macau	853
MK	Macedonia	389
MG	Madagascar	261
MW	Malawi	265
MY	Malaysia	60
MV	Maldives	960
ML	Mali	223
MT	Malta	356
MH	Marshall Islands	692
MR	Mauritania	222
MU	Mauritius	230
YT	Mayotte	262
MX	Mexico	52
FM	Micronesia	691
MD	Moldova	373
MC	Monaco	377
MN	Mongolia	976
ME	Montenegro	382
MS	Montserrat	1-664
MA	Morocco	212
MZ	Mozambique	258
MM	Myanmar	95
NA	Namibia	264
NR	Nauru	674
NP	Nepal	977
NL	Netherlands	31
AN	Netherlands Antilles	599
NC	New Caledonia	687
NZ	New Zealand	64
NI	Nicaragua	505
NE	Niger	227
NG	Nigeria	234
NU	Niue	683
KP	North Korea	850
MP	Northern Mariana Islands	1-670
NO	Norway	47
OM	Oman	968
PK	Pakistan	92
PW	Palau	680
PS	Palestine	970
PA	Panama	507
PG	Papua New Guinea	675
PY	Paraguay	595
PE	Peru	51
PH	Philippines	63
PN	Pitcairn	64
PL	Poland	48
PT	Portugal	351
PR	Puerto Rico	1-787, 1-939
QA	Qatar	974
CG	Republic of Congo	242
RE	Reunion	262
RO	Romania	40
RU	Russia	7
RW	Rwanda	250
BL	Saint Barthelemy	590
SH	Saint Helena	290
KN	Saint Kitts and Nevis	1-869
LC	Saint Lucia	1-758
MF	Saint Martin	590
PM	Saint Pierre and Miquelon	508
VC	Saint Vincent and Grenadines	1-784
WS	Samoa	685
SM	San Marino	378
ST	Sao Tome and Principe	239
SA	Saudi Arabia	966
SN	Senegal	221
RS	Serbia	381
SC	Seychelles	248
SL	Sierra Leone	232
SG	Singapore	65
SX	Sint Maarten	1-721
SK	Slovakia	421
SI	Slovenia	386
SB	Solomon Islands	677
SO	Somalia	252
ZA	South Africa	27
KR	South Korea	82
SS	South Sudan	211
ES	Spain	34
LK	Sri Lanka	94
SD	Sudan	249
SR	Suriname	597
SJ	Svalbard and Jan Mayen	47
SZ	Swaziland	268
SE	Sweden	46
CH	Switzerland	41
SY	Syria	963
TW	Taiwan	886
TJ	Tajikistan	992
TZ	Tanzania	255
TH	Thailand	66
TG	Togo	228
TK	Tokelau	690
TO	Tonga	676
TT	Trinidad and Tobago	1-868
TN	Tunisia	216
TR	Turkey	90
TM	Turkmenistan	993
TC	Turks and Caicos Islands	1-649
TV	Tuvalu	688
VI	U.S. Virgin Islands	1-340
UG	Uganda	256
UA	Ukraine	380
AE	United Arab Emirates	971
GB	United Kingdom	44
US	United States	1
UY	Uruguay	598
UZ	Uzbekistan	998
VU	Vanuatu	678
VA	Vatican	379
VE	Venezuela	58
VN	Vietnam	84
WF	Wallis and Futuna	681
EH	Western Sahara	212
YE	Yemen	967
ZM	Zambia	260
ZW	Zimbabwe	263

Erros

Código HTTP	Mensagem
400	Acquirer not found
400	Body validation error. Please check the request body for missing or incorrect parameters
400	Card bin must have exactly 6 characters
400	Consumer must have an email, and it cannot be longer than 255 characters
400	Consumer must have a document ID, and it cannot be longer than 14 characters
400	Consumer must have a name, and it cannot be longer than 80 characters
400	Consumer must have a phone number, and it cannot be longer than 20 characters
400	Consumer must have a surname, and it cannot be longer than 100 characters
400	Invalid merchant [id]={merchant_id}
400	Last four digits of a card must have exactly four characters
400	pan differs from order card BIN / last 4 digits
400	productType differs from order card productType
400	QRCode already revoked
400	QRCode already used
400	Required parameter String OTP (maximum length 36 and minimum length 6)
400	Required parameter String otpReferenceId (minimum length 3)
400	Required parameter String otpTimeStamp (ISO Date Format - YYYY-MM-DDTHH:MM:SS.mmmmmm)
400	Required parameter String securityCode
400	The minimum amount for installment is 10.01
400	These fields are mandatory
401	Unauthorized
401	Forbidden
404	Issuer not found
404	Merchant not found
404	Order not found
404	Transaction not found

Status dos pedidos (orderStatus)

Status	Descrição
Em Processamento	Pedido criado
Consumidor aceitou	Consumidor aceitou a compra na App do Emissor
Consumidor rejeitou	Consumidor rejeitou a compra na App do Emissor
Aprovada emissor	Pagamento aprovado no arranjo de pagamentos
Negada emissor	Pagamento negado no arranjo de pagamentos
Negada autenticação	Autenticação recusada
Cancelada	Ordem de compra cancelada pela loja
Estornada	Ordem de compra estornada pela loja
Tempo excedido	Tempo de resposta excedido no processamento da ordem
Erro no servidor	Erro no servidor da IDid
Erro no parceiro	Erro externo, relacionado ao serviço do parceiro de pagamentos da loja

Estruturas de dados

AuthRequest
clientId(string, required)
Credencial de identificação da aplicação integradora

clientSecret(string, required)
Credencial de chave secreta da aplicação integradora

AuthResponse
accessToken(string, required)
Token de acesso no formato JWT

tokenType(string)
Tipo de token de autenticação

expiresIn(number)
Tempo de expiração do token (3600 segundos)

AddressBase
streetAddress(string, required)
Nome da avenida ou rua do endereço de faturamento

streetNumber(string, required)
Número do endereço

complement(string)
Complemento

neighborhood(string, required)
Bairro

city(string, required)
Cidade

state(string, required)
Sigla do estado - Ver tabela de estados brasileiros

country(string, required)
Sigla de país com 2 letras, ex: BRA Tabela de países

zipCode(string, required)
CEP

Acquirer
acquirerTransactionId(string)
Código da transação enviado pelo acquirer

ConsumerDataOrder
name(string, required)
Nome do consumidor

surname(string, required)
Sobrenome do consumidor

email(string, required)
Email do consumidor

phoneNumber(string, required)
Número de telefone do consumidor

documentId(string, required)
Documento do consumidor (ex. CPF)

ConsumerCardProductType
productType(enum, required)
OPTIONS:DEBIT | CREDIT | MULTIPLE
Método de compra do cartão

OrderBase
acquirerId(number, required)
Identificador do adquirente Consulte a seção de referências

card(CardPost)
Dados do cartão do consumidor

bin(string)
6 primeiros dígitos

lastFour(string)
Últimos 4 dígitos do cartão

issuerId(string)
Identificador do emissor

amount(number, required)
Valor total a ser processado na venda

currencyCode(string, required)
Código da moeda, segundo o padrão ISO-4217

billAddress(AddressBase, required)
Endereço de faturamento do cartão

streetAddress(string, required)
Nome da avenida ou rua do endereço de faturamento

streetNumber(string, required)
Número do endereço

complement(string)
Complemento

neighborhood(string, required)
Bairro

city(string, required)
Cidade

state(string, required)
Sigla do estado - Ver tabela de estados brasileiros

country(string, required)
Sigla de país com 2 letras, ex: BRA Tabela de países

zipCode(string, required)
CEP

consumer(ConsumerDataOrder)
Dados do consumidor

name(string, required)
Nome do consumidor

surname(string, required)
Sobrenome do consumidor

email(string, required)
Email do consumidor

phoneNumber(string, required)
Número de telefone do consumidor

documentId(string, required)
Documento do consumidor (ex. CPF)

CardPost
bin(string)
6 primeiros dígitos

lastFour(string)
Últimos 4 dígitos do cartão

CardGet
bin(string)
6 primeiros dígitos do cartão

lastFour(string)
Últimos 4 dígitos do cartão

Order
orderTxId(string)
Identificador do pedido

orderStatus(OrderStatus)
Situação do pedido

status(string)
Status do pedido - Ver tabela de status do pedido

updatedAt(string)
Data de atualização do status do pedido

acquirerName(string)
Nome do adquirente

qrCodeDetails(QRCode)
Objeto com informações do QRCode

qrCodeStr(string, required)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”

qrCodeStatus(enum, required)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos

qrCodeDescription(string, required)
Instruções de pagamento do emissor para instruir o consumidor.

transactions(TransactionList)
Todas as transações do Pedido

Issuer
id(string, required)
Identificador do emissor

name(string)
Nome do emissor

logoUrl(string)
URL da logo

iconUrl(string)
URL do ícone

OrderGETResponse
orderTxId(string)
Identificador do pedido

orderStatus(OrderStatus)
Situação do pedido

status(string)
Status do pedido - Ver tabela de status do pedido

updatedAt(string)
Data de atualização do status do pedido

acquirerId(number, required)
Identificador do adquirente Consulte a seção de referências

card(CardGet)
Dados do cartão do consumidor

bin(string)
6 primeiros dígitos do cartão

lastFour(string)
Últimos 4 dígitos do cartão

issuer(Issuer)
Emissor do cartão

id(string, required)
Identificador do emissor

name(string)
Nome do emissor

logoUrl(string)
URL da logo

iconUrl(string)
URL do ícone

amount(number, required)
Valor total a ser processado na venda

currencyCode(string, required)
Código da moeda, segundo o padrão ISO-4217

acquirerName(string)
Nome do adquirente

billAddress(AddressBase)
Endereço de faturamento do consumidor

streetAddress(string, required)
Nome da avenida ou rua do endereço de faturamento

streetNumber(string, required)
Número do endereço

complement(string)
Complemento

neighborhood(string, required)
Bairro

city(string, required)
Cidade

state(string, required)
Sigla do estado - Ver tabela de estados brasileiros

country(string, required)
Sigla de país com 2 letras, ex: BRA Tabela de países

zipCode(string, required)
CEP

consumer(ConsumerDataOrder, required)
Dados do consumidor

name(string, required)
Nome do consumidor

surname(string, required)
Sobrenome do consumidor

email(string, required)
Email do consumidor

phoneNumber(string, required)
Número de telefone do consumidor

documentId(string, required)
Documento do consumidor (ex. CPF)

qrCodeDetails(QRCode)
Objeto com informações do QRCode

qrCodeStr(string, required)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”

qrCodeStatus(enum, required)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos

qrCodeDescription(string, required)
Instruções de pagamento do emissor para instruir o consumidor.

transactions(array[Transaction])
Todas as transações do Pedido

WebhookResponse
orderTxId(string)
Identificador do pedido

orderStatus(OrderStatus)
Situação do pedido

status(string)
Status do pedido - Ver tabela de status do pedido

updatedAt(string)
Data de atualização do status do pedido

acquirerId(number, required)
Identificador do adquirente Consulte a seção de referências

issuer(Issuer)
Emissor do cartão

id(string, required)
Identificador do emissor

name(string)
Nome do emissor

logoUrl(string)
URL da logo

iconUrl(string)
URL do ícone

amount(number, required)
Valor total a ser processado na venda

currencyCode(string, required)
Código da moeda, segundo o padrão ISO-4217

acquirerName(string)
Nome do adquirente

billAddress(AddressBase)
Endereço de faturamento do consumidor

streetAddress(string, required)
Nome da avenida ou rua do endereço de faturamento

streetNumber(string, required)
Número do endereço

complement(string)
Complemento

neighborhood(string, required)
Bairro

city(string, required)
Cidade

state(string, required)
Sigla do estado - Ver tabela de estados brasileiros

country(string, required)
Sigla de país com 2 letras, ex: BRA Tabela de países

zipCode(string, required)
CEP

consumer(ConsumerDataOrder, required)
Dados do consumidor

name(string, required)
Nome do consumidor

surname(string, required)
Sobrenome do consumidor

email(string, required)
Email do consumidor

phoneNumber(string, required)
Número de telefone do consumidor

documentId(string, required)
Documento do consumidor (ex. CPF)

qrCodeDetails(QRCode)
Objeto com informações do QRCode

qrCodeStr(string, required)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”

qrCodeStatus(enum, required)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos

qrCodeDescription(string, required)
Instruções de pagamento do emissor para instruir o consumidor.

transactions(array[Transaction])
Todas as transações do Pedido

OrderRequest
transactionType(string, required)
Tipo de transação

OrderResponse
status(string)
Status do request

orderTxId(string)
Identificador do pedido

qrCodeDetails(QRCode)
Objeto com informações do QRCode

qrCodeStr(string, required)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”

qrCodeStatus(enum, required)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos

qrCodeDescription(string, required)
Instruções de pagamento do emissor para instruir o consumidor.

OrderInstallment
totalInstallments(number, required)
Total de parcelas

firstInstallmentAmount(number)
Valor da primeira parcela

installmentType(enum)
OPTIONS:INTEREST_FREE | INTEREST_BY_MERCHANT | INTEREST_BY_ISSUER
Tipo do parcelamento

OrderStatus
status(string)
Status do pedido - Ver tabela de status do pedido

updatedAt(string)
Data de atualização do status do pedido

OrderPaginator
next(string)
Endereço da próxima página de registros

previous(string)
Endereço da página anterior de registros

count(number)
Total de registros

results(array[OrderGETResponse])
Lista de pedidos do período

ResultError
message(string)
Descrição de erro da solicitação.

data(object)
Informações relativas ao erro.

QRCode
qrCodeStr(string, required)
Conteúdo a ser renderizado na tela em formato QRCode, ou utilizado como string na funcionalidade “copia e cola”

qrCodeStatus(enum, required)
OPTIONS:REVOKED | UNUSED | USED
status do QRCode em relação a sua utilização no fluxo de pagamentos

qrCodeDescription(string, required)
Instruções de pagamento do emissor para instruir o consumidor.

SimulatorRequest
isSuccess(boolean, required)
Indica se a transação vai ser aprovada ou não pelo emissor.

consumerDecision(enum, required)
OPTIONS:APPROVE | DISAPPROVE
Indica se o consumidor aceitou ou não.

Transaction
transactionType(string)
Tipo da transação

authorizationCode(string)
Código de autorização

amount(string)
Valor do pedido

transmissionDate(string)
Data de envio da transação

acquirer(Acquirer)
Informações do acquirer

acquirerTransactionId(string)
Código da transação enviado pelo acquirer

consumerAuthenticationInformation(ConsumerAuthenticationInformation)
Informações da autenticação

status(string)
Status da autenticação

liabilityShift(boolean)
Responsabilidade de cobrir as perdas de transações fraudulentas

referenceId(string)
Código de identificação da transação autenticada

cryptogram(string)
Código do criptograma utilizado na autenticação

TransactionList (array[Transaction])
transactionType(string)
Tipo da transação

authorizationCode(string)
Código de autorização

amount(string)
Valor do pedido

transmissionDate(string)
Data de envio da transação

acquirer(Acquirer)
Informações do acquirer

acquirerTransactionId(string)
Código da transação enviado pelo acquirer

consumerAuthenticationInformation(ConsumerAuthenticationInformation)
Informações da autenticação

status(string)
Status da autenticação

liabilityShift(boolean)
Responsabilidade de cobrir as perdas de transações fraudulentas

referenceId(string)
Código de identificação da transação autenticada

cryptogram(string)
Código do criptograma utilizado na autenticação

ConsumerAuthenticationInformation
status(string)
Status da autenticação

liabilityShift(boolean)
Responsabilidade de cobrir as perdas de transações fraudulentas

referenceId(string)
Código de identificação da transação autenticada

cryptogram(string)
Código do criptograma utilizado na autenticação

Outros formatos ¶

Headers HTTP ¶

Requisitos mínimos ¶

Respostas de erro ¶

Autenticação ¶

Certificado mTLS ¶

Obter token de acesso ¶

Obter token de acessoPOST/oauth2/token

Example URI

Headers

Body (object)

Headers

Body (object)

Emissores ¶

Emissores disponíveis ¶

Emissores disponíveisGET/issuers

Example URI

Headers

Headers

Body (array[Issuer])

Vendas ¶

Criar um QRCode de captura imediata ¶

Criar um QRCode de captura imediataPOST/order

Example URI

Headers

Body (object)

Headers

Body (object)

Headers

Body (object)

Headers

Body (object)

Consultar um pedido de venda ¶

Consultar um pedido de vendaGET/order/{orderTxId}

Example URI

Headers

Headers

Body (object)

Headers

Body (object)

Consultar pedidos por período ¶

Consultar pedidos por períodoGET/order/{?startDate,endDate}

Example URI

Headers

Headers

Body (object)

Revogar QRCode ¶

Revogar QRCodePUT/order/{orderTxId}

Example URI

Headers

Body (object)

Headers

Body (object)

Headers

Body (object)

Headers

Body (object)

Webhook ¶

CLIENT-URL ¶

CLIENT-URLPOSThttps://CLIENT-URL

Example URI

Headers

Body (object)

Headers

Simulador ¶

Simulador de aprovação de transações ¶

Simulador de aprovação de transaçõesPOST/simulation/order/{orderTxId}/transaction

Example URI

Headers

Body (object)

Headers

Body (object)

Headers

Body (object)

Headers

Body (object)

Tabelas de referência ¶

Acquirers (acquirerId) ¶

Bandeiras de cartão ¶

Códigos de estados e DDD ¶

Outros formatos

Headers HTTP

Requisitos mínimos

Respostas de erro

Certificado mTLS

Obter token de acesso
POST`/oauth2/token`

Emissores disponíveis
GET`/issuers`

Criar um QRCode de captura imediata
POST`/order`

Consultar um pedido de venda
GET`/order/{orderTxId}`

Consultar pedidos por período
GET`/order/{?startDate,endDate}`

Revogar QRCode
PUT`/order/{orderTxId}`

CLIENT-URL
POST`https://CLIENT-URL`

Simulador de aprovação de transações
POST`/simulation/order/{orderTxId}/transaction`

Acquirers (acquirerId)

Bandeiras de cartão

Códigos de estados e DDD

Códigos de localização (países e DDI)

Erros

Status dos pedidos (orderStatus)

AuthRequest
clientId(string, required)
Credencial de identificação da aplicação integradora

clientSecret(string, required)
Credencial de chave secreta da aplicação integradora

AuthResponse
accessToken(string, required)
Token de acesso no formato JWT

tokenType(string)
Tipo de token de autenticação

expiresIn(number)
Tempo de expiração do token (3600 segundos)

Acquirer
acquirerTransactionId(string)
Código da transação enviado pelo acquirer

ConsumerDataOrder
name(string, required)
Nome do consumidor

surname(string, required)
Sobrenome do consumidor

email(string, required)
Email do consumidor

phoneNumber(string, required)
Número de telefone do consumidor

documentId(string, required)
Documento do consumidor (ex. CPF)

ConsumerCardProductType
productType(enum, required)
OPTIONS:DEBIT | CREDIT | MULTIPLE
Método de compra do cartão

CardPost
bin(string)
6 primeiros dígitos

lastFour(string)
Últimos 4 dígitos do cartão

CardGet
bin(string)
6 primeiros dígitos do cartão

lastFour(string)
Últimos 4 dígitos do cartão

Issuer
id(string, required)
Identificador do emissor

name(string)
Nome do emissor

logoUrl(string)
URL da logo

iconUrl(string)
URL do ícone

OrderRequest
transactionType(string, required)
Tipo de transação

OrderInstallment
totalInstallments(number, required)
Total de parcelas

firstInstallmentAmount(number)
Valor da primeira parcela

installmentType(enum)
OPTIONS:INTEREST_FREE | INTEREST_BY_MERCHANT | INTEREST_BY_ISSUER
Tipo do parcelamento

OrderStatus
status(string)
Status do pedido - Ver tabela de status do pedido

updatedAt(string)
Data de atualização do status do pedido

OrderPaginator
next(string)
Endereço da próxima página de registros

previous(string)
Endereço da página anterior de registros

count(number)
Total de registros

results(array[OrderGETResponse])
Lista de pedidos do período

ResultError
message(string)
Descrição de erro da solicitação.

data(object)
Informações relativas ao erro.

SimulatorRequest
isSuccess(boolean, required)
Indica se a transação vai ser aprovada ou não pelo emissor.

consumerDecision(enum, required)
OPTIONS:APPROVE | DISAPPROVE
Indica se o consumidor aceitou ou não.

Error400
message(string)
Descrição de erro da solicitação.

data(object)
Campo da solicitação onde se encontra o erro.

Error401
message(string)
Descrição de erro da solicitação.

data(object)
Campo da solicitação onde se encontra o erro.

ErrorNot400
message(string)
Descrição de erro da solicitação.