JSONS

Dados Adicionais

Este parâmetro serve para adicionar campos para serem enviados para o host da Getnet.

Atenção: Se precisar utilizar este campo, entre em contato com a Getnet.

Abaixo segue a tabela de requisição e seus respectivos campos do JSON:

Request

Obrigatoriedade	Campo	Formato	Descrição
OBRIGATÓRIO	extradata.tags[].tag	String n4	O campo tags é uma lista do tipo tag que possui os campos: String numérica de 4 dígitos. Código utilizado para integração com serviços específicos da Getnet. Atenção: Se precisar utilizar este campo, entre em contato com a Getnet.
OBRIGATÓRIO	extradata.tags[].value	String ans99	É o conteúdo da tag. Formato String de até no máximo 99 caracteres

Exemplo JSON:

{
  "tags": [
    {
      "tag": "0000",
      "value": "ABCDEF1234123"
    }
  ]
}

Telas Adicionais

Ao utilizar a funcionalidade Telas Adicionais, será apresentada uma tela adicional após o portador do cartão preencher a senha. Nesta tela adicional pode ser requisitado ao usuário algum dado pessoal. Este parâmetro define as informações que vão aparecer nesta tela.

Pode ser requisitado ao usuário o preenchimento de CPF ou Celular.

Como montar uma tela para CPF

Abaixo seguem exemplos de como montar uma tela para CPF:

CPF - Exemplo JSON da requisição:

{
  "pages": [
    {
      "buttons": [
        {
          "action": "skip",
          "key": "btn1",
          "text": "Não preencher"
        },
        {
          "action": "append",
          "key": "btn2",
          "text": "Continuar"
        }
      ],
      "fields": [
        {
          "hint": "Digite seu cpf.",
          "key": "cpf",
          "type": "edit_text",
          "v_cpf": {
            "err": "CPF inválido",
            "value": "true"
          },
          "v_required": {
            "err": "Campo obrigatório",
            "value": "true"
          }
        }
      ],
      "subTitle": "Digite seu cpf.",
      "title": "CPF"
    }
  ]
}

CPF - Exemplo JSON de Resposta

Exemplo de JSON de resposta com todos os campos enviados na requisição e o campo “value” com o dado preenchido pelo usuário (sem máscara de CPF).

{
  "pages": [
    {
      "buttons": [
        {
          "action": "skip",
          "key": "btn1",
          "text": "Não preencher"
        },
        {
          "action": "append",
          "key": "btn2",
          "text": "Continuar"
        }
      ],
      "fields": [
        {
          "hint": "Digite seu cpf.",
          "key": "cpf",
          "type": "edit_text",
          "v_cpf": {
            "err": "CPF inválido",
            "value": "true"
          },
          "v_required": {
            "err": "Campo obrigatório",
            "value": "true"
          },
          "value":"01910000000"
        }
      ],
      "subTitle": "Digite seu cpf.",
      "title": "CPF"
    }
  ]
}

Como montar uma tela para Celular?

Abaixo seguem exemplos de como montar uma tela para Celular:

Celular - Exemplo JSON da requisição

{
  "pages": [
    {
      "buttons": [
        {
          "action": "skip",
          "key": "btn1",
          "text": "Não preencher"
        },
        {
          "action": "append",
          "key": "btn2",
          "text": "Continuar"
        }
      ],
      "fields": [
        {
          "hint": "Digite seu telefone.",
          "key": "phone",
          "type": "edit_text",
          "v_phone": {
            "err": "Telefone inválido",
            "value": "true"
          },
          "v_required": {
            "err": "Campo obrigatório",
            "value": "true"
          }
        }
      ],
      "subTitle": " Digite seu telefone.",
      "title": "Telefone"
    }
  ]
}

Celular - Exemplo JSON de Resposta

Exemplo de JSON de resposta com todos os campos enviados na requisição e o campo “value” com o dado preenchido pelo usuário (sem máscara de celular).

{
  "pages": [
    {
    "buttons": [
      {
        "action": "skip",
        "key": "btn1",
        "text": "Não preencher"
      },
      {
        "action": "append",
        "key": "btn2",
        "text": "Continuar"
      }
    ],
    "fields": [
      {
        "hint": "Digite seu telefone.",
        "key": "phone",
        "type": "edit_text",
        "v_phone": {
          "err": "Telefone inválido",
          "value": "true"
        },
        "v_required": {
          "err": "Campo obrigatório",
          "value": "true"
        },
        "value":"51999911445"
      }
    ],
    "subTitle": "Digite seu telefone.",
    "title": "Telefone"
    }
  ]
}

Abaixo seguem as tabelas de requisição e resposta e seus respectivos campos do JSON:

Request

Obrigatoriedade	Campo	Formato	Descrição
OBRIGATÓRIO	extrascreens.pages[].buttons[].action	String	Strings que devem ser enviadas neste campo: "action":"skip" Ignora o que foi digitado pelo usuário e fecha ou vai pra próxima tela. "action":"append" Guarda o que o usuário digitou e fecha ou vai pra próxima tela.
OBRIGATÓRIO	extrascreens.pages[].buttons[].key	String	O nome/id para o botão. Campo fixo: usar “btn1” e “btn2”
OBRIGATÓRIO	extrascreens.pages[].buttons[].text	String	Texto que vai aparecer no botão. Sugestão de texto para botão esquerdo (“btn1”) e direito (“btn2”): “Não preencher” e "Continuar"
OBRIGATÓRIO	extrascreens.pages[].fields[].hint	String 30	Texto que aparece no hint do editText. Tamanho máximo: 30 caracteres.
OPCIONAL	extrascreens.pages[].fields[].TAG	String 4	String numérica de 4 dígitos. Código utilizado para integração com serviços específicos da Getnet. Atenção: Se precisar utilizar este campo, entre em contato com a Getnet.
OBRIGATÓRIO	extrascreens.pages[].fields[].key	String	Strings que podem ser enviadas neste campo: "key":"cpf" Utilize esta String para requisitar ao usuário o preenchimento de CPF. "key":"phone" Utilize esta String para requisitar ao usuário o preenchimento de Celular.
OBRIGATÓRIO	extrascreens.pages[].fields[].type	String	Define o tipo de input do field. Atualmente é somente: “edit_text”
OPCIONAL (Só utilize este campo para CPF)	extrascreens.pages[].fields[].v_cpf		Define que o input tem que ser um número de CPF válido. Possui os subcampos: “err” e “value”.
OPCIONAL (Só utilize este campo para CPF)	extrascreens.pages[].fields[].v_cpf.err	String 20	Mensagem de erro que aparece quando não passar no validador de CPF. Tamanho máximo: 20 caracteres.
OPCIONAL (Só utilize este campo para CPF)	extrascreens.pages[].fields[].v_cpf.value	String	Habilita o validador de CPF ao mandar “true”. Opções de string: “true” ou “false”
OPCIONAL (Só utilize este campo para Celular)	extrascreens.pages[].fields[].v_phone		Define que o input tem que ser um número de celular válido. Possui os subcampos: “err” e “value”.
OPCIONAL (Só utilize este campo para Celular)	extrascreens.pages[].fields[].v_phone.err	String 20	Mensagem de erro que aparece quando não passar no validador de Celular. Tamanho máximo: 20 caracteres.
OPCIONAL (Só utilize este campo para Celular)	extrascreens.pages[].fields[].v_phone.value	String	Habilita o validador de Celular ao mandar “true”. Opções de string: “true” ou “false”
OBRIGATÓRIO	extrascreens.pages[].fields[].v_required		Define o preenchimento do campo como obrigatório. Verifica se o campo foi preenchido pelo usuário ao clicar no botão “btn2”
OBRIGATÓRIO	eExtrascreens.pages[].fields[].v_required.err	String 20	Mensagem de erro mostrada ao usuário quando o campo não tiver sido preenchido e o “btn2” for apertado. Tamanho máximo: 20 caracteres.
OBRIGATÓRIO	extrascreens.pages[].fields[].v_required.value	String	Habilita se o campo é obrigatório para preencher. Opções de string: “true” ou “false”
OBRIGATÓRIO	extrascreens.pages[].subTitle	String 50	Texto que será mostrado no subtítulo da tela. Tamanho máximo: 50 caracteres.
OBRIGATÓRIO	extrascreens.pages[].title	String 10	Texto que será mostrado no título da tela. Tamanho máximo: 10 caracteres

Pix | Informação adicional

Este parâmetro serve para acrescentar informações adicionais sobre o pagamento Pix que está sendo iniciado. Estas informações serão apresentadas ao pagador, em seu aplicativo de pagamento, após a leitura do QR Code Pix.

Abaixo segue a tabela de requisição e seus respectivos campos do JSON:

Request

Obrigatoriedade	Campo	Formato	Descrição
OBRIGATÓRIO	additional_info[].name	String 50	Informação adicional sobre o pagamento. Este campo representa o título da informação. Esta informação será apresentada ao pagador, em seu aplicativo de pagamento, após a leitura do QR Code Pix. Tamanho máximo: 50 caracteres.
OBRIGATÓRIO	additional_info[].value	String 200	Informação adicional sobre o pagamento. Este campo representa a descrição da informação. Esta informação será apresentada ao pagador, em seu aplicativo de pagamento, após a leitura do QR Code Pix. Tamanho máximo: 200 caracteres.

Exemplo JSON

{
  "additional_info": [
    {
      "name": "Campo1",
      "value": "Informação Adicional do PSP - Recebedor"
    }
  ]
}

Payload do Pix

Neste parâmetro retornamos informações relacionadas a transações do tipo Pix.

Abaixo segue a tabela de resposta e seus respectivos campos do JSON:

Response

Obrigatoriedade	Campo	Formato	Descrição
OBRIGATÓRIO	automationPixSlip	JSON (String)	Neste parâmetro enviamos as informações que devem ser incluídas nos Comprovantes Impressos do estabelecimento e do cliente para transações Pix. Seu aplicativo só é obrigado a imprimir esses campos caso você opte por usar a funcionalidade Responsabilidade de Impressão, pois nesse caso o aplicativo Pagamento não irá imprimir os comprovantes. Mais detalhes na seção Dados do Comprovante.
OBRIGATÓRIO	status	String 2	O campo status representa a situação da transação no momento da resposta. Este pode retornar os seguintes estados: 00 – Pago 81 – A pagar 86 - Expirado
OBRIGATÓRIO	transactionId	String 35	Código de identificação da transação Pix.

Exemplo JSON

{
  "automationPixSlip": "", //Exemplo da resposta na seção Dados do Comprovante
  "status": "00",
  "transactionId": "000000050081910000120648"
}

Dados do comprovante

Neste parâmetro enviamos as informações que devem ser incluídas nos Comprovantes do estabelecimento e do cliente.

Atenção! Seu aplicativo só é obrigado a imprimir esses campos caso você opte por usar a funcionalidade Responsabilidade de Impressão, pois nesse caso o aplicativo Pagamento não irá imprimir os comprovantes.

Abaixo estão os subitens que virão no campo “automationSlip” ou “automationPixSlip”:

• mandatory_all_receipts_fields: Campos obrigatórios nas Vias do Cliente e do Estabelecimento;
• mandatory_client_fields: Campos obrigatórios na Via do Cliente;
• mandatory_ec_fields: Campos obrigatórios na Via do Estabelecimento.

Dependendo do tipo da transação (Credito, Débito, Pix, Chip, Tarja, Qr Code, com Conversão de Moedas* e etc.) alguns campos podem vir, ou não. O aplicativo Pagamento será responsável por retornar os campos que devem ser impressos/armazenados, ou seja, todos os campos que vierem no JSON são mandatórios.

A coluna “Nome no comprovante” da tabela abaixo deve ser colocada à frente do campo na hora de imprimir o comprovante. Exemplo: “authorizationCode” deve aparecer no comprovante como “AUT”. O formato de todos os campos é String, e os campos getnetLogo e pixLogo são em formato String Base64.

Abaixo você pode verificar os campos para:

• Comprovantes de crédito, débito e voucher;
• Comprovantes de Pix.

* *Obs:Transações com Conversão de Moeda(DCC) só acontecerão na modalidade credito e debito.

Comprovante | Crédito, Débito e Voucher

Tabela de resposta e seus respectivos campos do JSON:

Response

Campo	Nome no comprovante	Descrição
mandatory_all_receipts_fields.amount		Valor da transação com simbolo da moeda
mandatory_all_receipts_fields.authorizationCode	AUT	Código único de autorização
mandatory_all_receipts_fields.brand		Bandeira do cartão utilizado
mandatory_all_receipts_fields.cardLastDigits		Os 4 últimos dígitos do cartão
mandatory_all_receipts_fields.city		Cidade do estabelecimento
mandatory_all_receipts_fields.ecDocument	CPF ou CNPJ	CPF ou CNPJ do estabelecimento
mandatory_all_receipts_fields.ecName		Nome do estabelecimento
mandatory_all_receipts_fields.ecNumber	EC	Código do estabelecimento
mandatory_all_receipts_fields.getnetLogo		Logo Getnet em formato String base64
mandatory_all_receipts_fields.dateTime		Data e hora da transação
mandatory_all_receipts_fields.letterTypeTransaction		Letra que mostra o modo de captura da transação: C = Chip; D = Venda digitada; M = Tarja magnética; S = Contactless; Q = Qr Code.
mandatory_all_receipts_fields.nsu	CV	Código de autorização da transação na Getnet – ele é único por transação/por terminal.
mandatory_all_receipts_fields.terminal	TERM	Número lógico do terminal, cadastrado na Getnet
mandatory_all_receipts_fields.version		Versão do aplicativo Pagamento
mandatory_client_fields.client_body		Corpo da transação. Neste campo podem vir informações como: valor, tipo da transação, informações relativas a parcelamento, entre outras.
mandatory_client_fields.receiptTypeClient		Texto para informar que esta é a Via do cliente
mandatory_ec_fields.aid	AID	Código AID da bandeira
mandatory_ec_fields.arqc	ARQC	Código ARQC da transação
mandatory_ec_fields.ec_body		Corpo da transação. Neste campo podem vir informações como: valor, tipo da transação, informações relativas a parcelamento, entre outras.
mandatory_ec_fields.nsuLocal	DOC	NSU gerado no terminal
mandatory_ec_fields.receiptTypeEc		Texto para informar que esta é a Via do estabelecimento
mandatory_ec_fields.dcc_ec_fields.messageToEc		Mensagem ao estabelecimento quando houve conversão de moeda
mandatory_client_fields.dcc_client_fields.totalAmount	Total Amount	Valor total cobrado na transação
mandatory_client_fields.dcc_client_fields.exchangeRate	Exchange Rate	Valor da cotação utilizada
mandatory_client_fields.dcc_client_fields.markup	Markup	Valor do Markup em reais
mandatory_client_fields.dcc_client_fields.amountCharged	Amount Charged	Valor total cobrado do Portador
mandatory_client_fields.dcc_client_fields.messageToClient		Mensagem para informar o portador do cartão

Exemplo JSON de resposta

automationSlip={
  "mandatory_all_receipts_fields": {
    "amount": "R$ 50,00",
    "authorizationCode": "006734",
    "brand": "MASTERCARD",
    "cardLastDigits": "4283",
    "city": "PORTO ALEGRE",
    "ecDocument": "69.600.609/0001-06",
    "ecName": "CREDENCIAMENTO ELO V",
    "ecNumber": "000000051523906",
    "getnetLogo": "", //Logo da Getnet em formato String Base64
    "dateTime": "09/11/21 17:27:05",
    "letterTypeTransaction": "C",
    "nsu": "000000443",
    "terminal": "10001593",
    "version": "V0A57.0004.0021"
  },
  "mandatory_client_fields": {
    "clientBody": "CREDITO A VISTA \nVALOR: 10,00",
    "receiptTypeClient": "Via Cliente",
    "dcc_client_fields": {
      "totalAmount": "50,00 BRL",
      "exchangeRate": "1 BRL = 0.20310 USD",
      "markup": "1,2%",
      "amountCharged": "10.20 USD",
      "messageToClient": "I HAVE BEEN OFFERED A CHOICE OF CURRENCIES AND AGREED TO PAY IN UNITED STATES DOLLAR (USD). Dynamic Currency Conversion (DCC) is offered by GETNET"
    }
  },
  "mandatory_ec_fields": {
    "aid": "A0000000041010",
    "arqc": "3D084907A1C169DC",
    "ecBody": "CREDITO A VISTA \nVALOR: 50,00\n \nTRANSACAO APROVADA
    MEDIANTE\n USO DE SENHA PESSOAL",
    "nsuLocal": "000204",
    "receiptTypeEc": "Via Estabelecimento",
    "dcc_ec_fields": {
      "messageToEc":"VOCÊ RECEBEU UMA COMISSÃO POR UTILIZAR O CONVERSOR DE MOEDAS, CONFIRA NO EXTRATO DE VENDAS NO APLICATIVO GETNET BRASIL OU NO PORTAL MINHA CONTA."
    }
  }

Comprovante | Pix

Tabela de resposta e seus respectivos campos do JSON:

Response

Campo	Nome no comprovante	Descrição
mandatory_all_receipts_fields.getnetLogo		Logo Getnet em formato String base64
mandatory_all_receipts_fields.pixLogo		Logo Pix em formato String base64
mandatory_all_receipts_fields.city		Cidade do estabelecimento
mandatory_all_receipts_fields.amount	VALOR	Valor da trnasação
mandatory_all_receipts_fields.nsu	CV	Código de autorização da transação na Getnet – ele é único por transação/por terminal.
mandatory_all_receipts_fields.dateTime		Data e hora da transação
mandatory_all_receipts_fields.terminal	TERM	Número lógico do terminal, cadastrado na Getnet
mandatory_all_receipts_fields.transaction_id	ID/TRANSAÇÃO	Identificador da transação Pix
mandatory_all_receipts_fields.payer.title		Texto para informar que estes são os Dados do Cliente
mandatory_all_receipts_fields.payer.pspName		PSP do Cliente (Ex:Banco)
mandatory_all_receipts_fields.payer.name		Nome do Cliente
mandatory_all_receipts_fields.payer.document		Documento do Cliente (CPF ou CNPJ)
mandatory_all_receipts_fields.receiver.title		Texto para informar que estes são os Dados do Estabelecimento
mandatory_all_receipts_fields.receiver.pspName		PSP do Estabelecimento (Ex:Banco)
mandatory_all_receipts_fields.receiver.name		Nome do Estabelecimento
mandatory_all_receipts_fields.receiver.document		Documento do Estabelecimento (CPF ou CNPJ)
mandatory_all_receipts_fields.slip_footer		Texto extra informativo que deve ser mostrado no comprovante quando enviado
mandatory_all_receipts_fields.receiptTypeClient		Texto para informar que esta é a Via do cliente
mandatory_all_receipts_fields..receiptTypeEc		Texto para informar que esta é a Via do estabelecimento

Exemplo JSON de resposta

automationPixSlip={
  "mandatory_all_receipts_fields": {
  "getnetLogo": "", //Logo da Getnet em formato String Base64
  "pixLogo": "", //Logo do Pix em formato String Base64
  "city": "PORTO ALEGRE",
  "amount": "R$ 126,20",
  "nsu": "000000443",
  "dateTime": "09/11/21 17:27:05",
  "terminal": "10001593",
  "transaction_id": "123412341234123",
  "payer": {
    "title": "Dados do Cliente",
    "pspName": "PSP BANCO XYZ",
    "name": "João Silva",
    "document": "123*****-09"
  },
  "receiver": {
    "title": "Dados do Estabelecimento",
    "pspName": "PSP BANCO XYZ",
    "name": "Restaurante X",
    "document": "12.345.678/0001-90"
  },
  "slip_footer": "Informativo de Taxas..."
  },
  "mandatory_client_fields": {
    "receiptTypeClient": "Via Cliente"
  },
  "mandatory_ec_fields": {
    "receiptTypeEc": "Via Estabelecimento"
  }
}

Exemplos de layout do comprovante

Disponibilizamos para download arquivos de exemplo de como montar os comprovantes com os dados recebidos. O arquivo Exemplo de Comprovante pode ser baixado no Portal do Desenvolvedor | Get Store no menu Downloads.

No arquivo Exemplo de Comprovante você irá encontrar os seguintes exemplos:

• receipt_example.xml – Exemplo de estruturação de um comprovante em XML para transações Crédito, Débito e Voucher;
• pix_receipt_example.xml – Exemplo de estruturação de um comprovante em XML para transações Pix;
• SlipUtil.java – Exemplo de como mapear os campos do XML para colocar as informações vindas do JSON para transações Crédito, Débito e Voucher;
• PixReceipt.kt – Exemplo de como mapear os campos do XML para colocar as informações vindas do JSON para transações Pix;
• AutomationSlip.kt e PixSlip.kt – Data Class principal da estrutura;
• Data Class MandatoryAllReceiptsFields – Representa o JSON dos campos mandatórios para ambas as vias do comprovante;
• Data Class MandatoryClientFields – Representa o JSON dos campos mandatórios da via do cliente;
• Data Class MandatoryEcFields – Representa o JSON dos campos mandatórios da via do estabelecimento;

Abaixo imagens do comprovante de Crédito, Débito ou Voucher montado com os arquivos do Exemplo de Comprovante:

Visualização do XML no Android Studio

Comprovante impresso no POS Digital

Abaixo imagens do comprovante Pix montado com os arquivos do Exemplo de Comprovante:

Visualização do XML no Android Studio

Comprovante impresso no POS Digital

Abaixo imagens do comprovante de transação com Conversão de Moeda(DCC):

Comprovante cliente	Comprovante Estabelecimento
Visualização do XML no Android Studio	Visualização do XML no Android Studio
Comprovante impresso no POS Digital	Comprovante impresso no POS Digital

Comprovante antigo cliente	Comprovante antigo Estabelecimento
Visualização do XML no Android Studio	Visualização do XML no Android Studio

Atenção! Caso os comprovantes sejam reimpressos, é obrigatório imprimir a palavra reimpressão da seguinte forma: ****REIMPRESSÃO****

Em letras maiúscula, em negrito, com tamanho de fonte maior que dos outros campos e com asteriscos antes e depois do texto. Esta regra vale para as Vias do Cliente e do Estabelecimento.

Exemplo de comprovante de reimpressão

Exemplo de comprovante de reimpressão

Payload do Split de Pagamento

Este parâmetro define quais os dados a serem enviados para a utilização do Split de Pagamento.

A tabela indica os campos e abaixo um exemplo de JSON de requisição e um exemplo de JSON de resposta do servidor.

Abaixo seguem as tabelas de requisição e resposta e seus respectivos campos do JSON:

Request

Obrigatoriedade	Campo	Formato	Descrição
OBRIGATÓRIO	splitPayloadRequest[].market_place_id	String 36	ID do marketplace/estabelecimento
OBRIGATÓRIO	splitPayloadRequest[].order_id	String 36	Número do pedido Atenção! Este order_id não precisa ser igual ao orderId da requisição Pagamento v3.
OBRIGATÓRIO	splitPayloadRequest[].subsellers_list_payment[].subseller_id	String 9	ID dos vendedores cadastrados no âncora.
OBRIGATÓRIO	splitPayloadRequest[].subsellers_list_payment[].sale_amount_subseller	number	Parte do valor da loja em relação ao pedido(em centavos)
OBRIGATÓRIO	splitPayloadRequest[].subsellers_list_payment[].items[].id	String 15	Identificador do item/produto
OBRIGATÓRIO	splitPayloadRequest[].subsellers_list_payment[].items[].amount	Number	Valor do item/produto (em centavos)
OBRIGATÓRIO	splitPayloadRequest[].subsellers_list_payment[].items[].description	String 80	Descrição do item/produto
OPCIONAL(*)	splitPayloadRequest[].subsellers_list_payment[].items[].transaction_rate_percent	String 9	Taxa em percentual a ser cobrada no item. Esta porcentagem é a comissão repassada para o âncora (estabelecimento), retirada do valor do item. Caso esta taxa seja enviada na requisição, irá substituir a taxa padrão que foi previamente cadastrada, através do Portal Minha Conta ou da API, para este "Subseller". Utilizar a formatação NNNDDDDDD, onde:NNN é a parte inteira. Completar com zeros a esquerda até atingir 3 dígitos. DDDDDD é a parte fracionária. Completar com zeros a direita até atingir 6 dígitos. Exemplo: 025070000 é igual a 25,07%.
OPCIONAL(*)	splitPayloadRequest[].subsellers_list_payment[].items[].transaction_rate_amount	Number	Taxa em valor (em centavos) a ser cobrada no item. Este valor é a comissão repassada para o âncora, retirada do valor do item. Caso esta taxa seja enviada na requisição, irá substitui a taxa padrão em valor que foi previamente cadastrada, através do Portal Minha Conta ou da API, para este "Subseller".

(*) Atenção: Somente um dos campos, transaction_rate_percent ou transaction_rate_amount, pode ser enviado em uma requisição. Caso as duas taxas sejam enviadas em uma mesma requisição, a transação será negada.

Exemplo JSON da requisição

{
// O valor TOTAL da venda foi de R$110,00 divididos em R$100,00 do almoço + R$10,00 gorjeta
"market_place_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", // Id do EC
"order_id": "0001", // Um id de ordem gerado pela automação 
"subsellers_list_payment": 
  [ // Quem vai receber parte dos valores
    { 
    "subseller_id": "7000001", // Id do Restaurante
    "sale_amount_subseller": 10000, // R$100,00 valor que será enviado para o Restaurante
    "items": 
      [ // Lista de produtos ou serviços
        {
        "id": "X0001", // Id do Produto gerado pela automação
        "description": "Pizza de calabresa",
        "amount": 5000 // Note que não faz sentido o Restaurante receber a comissão.
        },
        {
        "id": "X0005",
        "description": "Pizza de brocolis",
        "amount": 5000
        }
      ]
    },
    {
    "subseller_id": "7000002", // Id do Garçom 1
    "sale_amount_subseller": 1000, // R$10,00 valor que será enviado para o Garçom 1
    "items": 
      [
        {
        "id": "G0001", // Id do Serviço feito pelo Garçom 1 gerado pela automação
        "description": "Gorjeta para garçom 1",
        "amount": 1000
        // R$10,00 valor que será enviado para o Garçom 1 e no sistema o valor da comissão estará cadastrada como 0% ou R$0,00
        } 
      ]
    }
  ]
}  

Tabela de resposta e seus respectivos campos do JSON:

Response

Quando retorna?	Campo	Formato	Descrição
SEMPRE	splitPayloadResponse.market_place_id	String 36	ID do marketplace/estabelecimento
SEMPRE	splitPayloadResponse.order_id	String 36	Número do pedido
SEMPRE	splitPayloadResponse.payment_id	String 36	Código de identificação do pagamento
SEMPRE	splitPayloadResponse.merchant_transaction_id	String 19	NSU do sistema de gestão de Marketplace

Exemplo JSON de resposta

{
 "market_place_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28",
 "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3",
 "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e",
 "merchant_transaction_id": "0023972834623476365"
}

Resposta da Consulta Subsellers

Este parâmetro mostra quais os dados a serem recebidos na consulta de Marketplace do Estabelecimento.

Abaixo segue a tabela de resposta e seus respectivos campos do JSON:

Atenção: O primeiro Subseller da lista de subSellers, que retornará nesta resposta, é o Subseller do próprio âncora.

Response

Campo	Formato	Quando retorna?	Descrição
marketPlaceId	String ans36	SEMPRE	ID do marketplace/estabelecimento
id (subSellers)	number	SEMPRE	Número de identificação único do "Subseller". Até 9 dígitos. Exemplo: 700000
document (subSellers)	number	SEMPRE	CPF ou CNPJ do "Subseller" O valor do contém apenas dígitos numéricos sem zeros à esquerda; Para CPF o valor contém no máximo 11 dígitos; Para CNPJ o valor contém no máximo 14 dígitos.
name (subSellers)	String	SEMPRE	Nome cadastrado a este "Subseller" PF: Deve ter no mínimo dois nomes (ex: Mario Silveira); Não pode conter caráteres especiais, acentos ou abreviações; Deverá ser informado o nome completo do CPF conforme registrado na receita federal. PJ: Não pode conter caráteres especiais, acentos ou abreviações; Deverá ser informado o nome completo da razão social conforme registrado na receita federal.
occupation (subSellers)	String	OPCIONAL	Ocupação cadastrada para esse "Subseller" . Campo livre para definir a ocupação do “Subseller” da forma desejada. Exemplo: Fornecedor
comissionPercentage (subSellers)	number	OPCIONAL(*)	Taxa padrão em percentual cadastrada para este "Subseller". Esta porcentagem é a comissão repassada para o âncora, retirada do valor dositens vendidos por este Subseller. Esta taxa padrão será substituída caso alguma taxa seja enviada nos campos transaction_rate_percent ou transaction_rate_amount durante uma transação de Split de Pagamento.
comissionValue (subSellers)	number	OPCIONAL(*)	Taxa padrão em valor cadastrada para este "Subseller". Este valor é a comissão repassada para o âncora, retirada do valor dos itens vendidos por este Subseller. Esta taxa padrão será substituída caso alguma taxa seja enviada nos campos transaction_rate_percent ou transaction_rate_amount durante uma transação de Split de Pagamento.

(*) Atenção: Somente um dos campos, comissionPercentage ou comissionValue, pode retornar com valor maior que zero na Consulta Subsellers. Pois o âncora poderá cadastrar somente um tipo de comissão para cada Subseller, comissionPercentage ou comissionValue. Também existe a possibilidade dos dois campos serem zero, caso nenhuma comissão tenha sido cadastrada pelo âncora.

Exemplo JSON de resposta

{
"marketPlaceId": "6eb2412c-165a-41cd-b1d9-76c575d70a28", // Id que será utilizado no Request de Pagamento
"subSellers": 
  [
    {
    "id": 7000001, // Id do EC Restaurante Ancora
    "document": "12345678901", // CNPJ do restaurante
    "name": "Restaurante 3 Delicias",
    "occupation": "Restaurante",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    },
    {
    "id": 7000002, // Id do Garçom 1
    "document": "22444555000133", // CPF do Garçom
    "name": "João da Silva",
    "occupation": "Garçom",
    "comissionPercentage": 10.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    API de Pagamento - POS Digital - Getnet 66
    },
    {
    "id": 7000003, // Id do Garçom 2
    "document": "86167223212", // CPF do Garçom
    "name": "Pedro Henrique Matos",
    "occupation": "Garçom",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 5.0 // Valor padrão de comissão cadastrada
    }
  ]
}

Exemplos de Fluxos para Pagamentos Split

Você e um restaurante e quer repartir a gorjeta para os seus empregados?

O valor TOTAL da venda foi de R$110,00 divididos em R$100,00 do almoço + R$10,00 gorjeta:

Exemplo de fluxox para Pagamento Split

O deeplink getnet://pagamento/v1/checksubsellers irá retornar os dados de Marketplace (âncora) do Estabelecimento (Restaurante):

{
"marketPlaceId": "6eb2412c-165a-41cd-b1d9-76c575d70a28", // Id que será utilizado no Request de Pagamento 
"subSellers": 
  [
    {
    "id": 7000001, // Id do EC Restaurante Ancora
    "document": "12345678901", // CNPJ do restaurante
    "name": "Restaurante 3 Delicias",
    "occupation": "Restaurante",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    },
    {
    "id": 7000002, // Id do Garçom 1
    "document": "22444555000133", // CPF do Garçom
    "name": "João da Silva",
    "occupation": "Garçom",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    },
    {
    "id": 7000003, // Id do Garçom 2
    "document": "86167223212", // CPF do Garçom
    "name": "Pedro Henrique Matos",
    "occupation": "Garçom",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    }
  ]
}

Depois de ter os dados vamos gerar o Json do Split do Pagamento da seguinte forma dentro do parâmetro do Bundle “splitPayloadRequest”:

{
"market_place_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", // Id do EC
"order_id": "0001", // Um id de ordem gerado pela automação 
"subsellers_list_payment": 
  [ // Quem vai receber parte dos valores
    {
    "subseller_id": "7000001", // Id do Restaurante
    "sale_amount_subseller": 10000, // R$100,00 valor que será enviado para o Restaurante
    "items": 
      [ // Lista de produtos ou serviços
        {
        "id": "X0001", // Id do Produto gerado pela automação
        "description": "Pizza de calabresa",
        "amount": 5000, // Note que não faz sentido o Restaurante receber a comissão.
        "transaction_rate_percent": "000000000" // 0%
        },
        {
        "id": "X0005",
        "description": "Pizza de brocolis",
        "amount": 5000,
        "transaction_rate_amount": 0 // R$0,00
        },
      ]
    },
    {
    "subseller_id": "7000002", // Id do Garçom 1
    "sale_amount_subseller": 1000, // R$10,00 valor que será enviado para o Garçom 1
    "items": 
      [
        {
        "id": "G0001", // Id do Serviço feito pelo Garçom 1 gerado pela automação
        "description": "Gorjeta para garçom 1",
        "amount": 1000, // R$10,00
        "transaction_rate_percent": "000000000" // 0% 
        // R$10,00 valor que será enviado para o Garçom 1
        }
      ]
    }
  ]   
}

Observação: Os valores mostrados acimas não contemplam taxas e serviços adicionais, como por exemplo MDR (Merchant Discount Rate).

Você e um estabelecimento de Estética e quer dividir o valor dos serviços?

O deeplink getnet://pagamento/v1/checksubsellers irá retornar os dados de Marketplace (âncora) do Estabelecimento:

{
"marketPlaceId": "8cd2412c-165a-35aa-b1d9-76c575d70a28", // Id que será utilizado na requisição de Pagamento
"subSellers": 
  [
    {
    "id": 2000001, // Id do Estética (âncora)
    "document": "00045678901", // CNPJ do Estética
    "name": "Estética Embeleze",
    "occupation": "Estética",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    },
    {
    "id": 2000005, // Id do Cabelereiro
    "document": "12345678901", // CPF do Cabelereiro
    "name": "João da Silva",
    "occupation": "Cabelereiro",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    },
    {
    "id": 2000008, // Id Manicure
    "document": "22444555000133", // CPF da Manicure
    "name": "Vanessa Silva",
    "occupation": "Manicure",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    }
  ]
}

O valor TOTAL do Serviço foi de R$135,90 divididos em R$70,00 de corte + R$40,00 escova + R$25,90 manicure.

Depois de ter os dados vamos gerar o Json do Split do Pagamento da seguinte forma dentro do parâmetro do Bundle “splitPayloadRequest”:

{ 
"market_place_id": "8cd2412c-165a-35aa-b1d9-76c575d70a28", // Id do EC da Estetica
"order_id": "4451", // Um id de ordem gerado pela automação 
"subsellers_list_payment": 
  [ // Quem vai receber parte dos valores e comissões
    {
    "subseller_id": "2000005", // Id do Cabelereiro
    "sale_amount_subseller": 11000, // R$70,00 de corte + R$40,00 escova
    "items": 
      [ // Lista de produtos ou serviços
        {
        "id": "C0001", // Id do Serviço do Cabelereiro gerado pela automação
        "description": "Corte cabelo",
        "amount": 7000, // R$70,00 
        "transaction_rate_percent": "020000000" // 20,00% dos R$70,00 para a Estética = R$14,00
        // R$14,00 para a Estética e R$56,00 para o cabelereiro
        },
        {
        "id": "C0007",
        "description": "Escova cabelo",
        "amount": 4000, // R$40,00 
        "transaction_rate_percent": "020000000" // 20,00% dos R$40,00 para a Estética = R$8,00
        // R$8,00 para a Estética e R$32,00 para o cabelereiro
        }
      ]
    },
    {
    "subseller_id": "2000008", // Id Manicure
    "sale_amount_subseller": 2590, // R$25,90 valor de manicure
    "items": 
      [
        {
        "id": "M0001", // Id do Serviço da Manicure gerado pela automação
        "description": "Manicure",
        "amount": 2590, // R$25,90
        "transaction_rate_amount": 200 // R$2,00 para a Estética
        // R$2,00 para a Estética e R$23,90 para Manicure
        }
      ]
    }
  ]
}

Observação: Os valores mostrados acimas não contemplam taxas e serviços adicionais, como por exemplo MDR (Merchant Discount Rate).

Você e uma automação/aplicativo trabalhando em um Evento?

O deeplink getnet://pagamento/v1/checksubsellers irá retornar os dados de Marketplace (âncora) do organizador de eventos:

{
"marketPlaceId": "2xk2412c-165a-35aa-b1d9-76c575d70a28", // Id que será utilizado na requisição de Pagamento
"subSellers": 
  [
    {
    "id": 50188885, // Id do organizador do Evento (âncora)
    "document": "12345678901", // CNPJ do organizador do Evento
    "name": "Eventos S.A.",
    "occupation": "Eventos",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    },
    {
    "id": 5012345, // Id do criador automação/aplicativo do Evento
    "document": "12345678901", // CNPJ do criador automação/aplicativo do Evento
    "name": "Tech App Industrial",
    "occupation": "TI",
    "comissionPercentage": 0.0, // Porcentagem padrão de comissão cadastrada
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    },
    {
    "id": 5054321, // Id da lancheria cadastra no Evento
    "document": "22444555000133", // CNPJ da Lancheria
    "name": "Benja Burguers",
    "occupation": "Restaurante",
    "comissionPercentage": 2.0, // Porcentagem padrão de comissão cadastrada. 2,00% do valor de todas as vendas deste Subseller é repassado para o organizador do Evento (âncora), caso nenhuma comissão (transaction_rate_percent ou transaction_rate_amount) seja enviada no Payload do Pagamento. 
    "comissionValue": 0.0 // Valor padrão de comissão cadastrada
    }
  ]
}

O valor TOTAL da venda foi de R$50,00 do lanche no evento, vamos fazer o Split do Pagamento.

Depois de ter os dados vamos gerar o Json do Split do Pagamento da seguinte forma dentro do parâmetro do Bundle “splitPayloadRequest”:

{
"market_place_id": "2xk2412c-165a-35aa-b1d9-76c575d70a28", // Id do EC do Organizador do Evento
"order_id": "211232311", // Um id de ordem gerado pela automação 
"subsellers_list_payment": 
  [ // Quem vai receber parte dos valores e comissões
    {
    "subseller_id": "5012345", // Id do criador automação/aplicativo do Evento
    "sale_amount_subseller": 50, // R$0,50 centavos
    "items": 
      [ // Lista de produtos ou serviços
        {
        "id": "A0001", // Id do Serviço da automação
        "description": "Automação do Evento",
        "amount": 50, // R$0,50
        "transaction_rate_percent": "000000000" // 0%
        }
      ]
    },
    {
    "subseller_id": "5054321", // Id da Lancheria
    "sale_amount_subseller": 4950, // R$49,50 valor do lanche
    "items": 
      [
        {
        "id": "L0013", // Id do produto Lancheria
        "description": "Lanche cachorro quente",
        "amount": 4950 // R$49,50
        // R$0,99 para o Organizador do Evento (âncora) pois no sistema está cadastrado como 2,00% de comissão.
        // O restante, R$48,51 para a Lancheria.
        }
      ]
    }
  ]
}

Observação: Os valores mostrados acimas não contemplam taxas e serviços adicionais, como por exemplo MDR (Merchant Discount Rate).