Confirmar Split Ancorado

Esta API permite que o Ancorado confirme a solicitação de Split Pós-fixado, utilizando o response da requisição Aguardando Split e o código enviado por e-mail através da requisição Código de Confirmação para finalizar o processo de Split Pós-fixado.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Confirmar Split (Visão Ancorada)

Esta rota é utilizada por estabelecimentos Ancorados para realizar a divisão de valores de suas vendas pós-fixadas. O estabelecimento detém a autonomia para informar o split, desde que respeite as regras definidas pela Âncora.

Headers

HeaderValorDescrição
AuthorizationBearer {{JWT_TOKEN}}Token de acesso do estabelecimento Ancorado.
Content-Typeapplication/jsonFormato dos dados enviados.

Estrutura do JSON (Request Body)

O corpo da requisição deve seguir o objeto confirm_split. Você pode optar por informar a divisão por porcentagem ou por valor bruto.

Exemplo de venda com cartão e split por porcentagem

{
  "confirm_split": {
    "nsu": "987654",            // NSU da transação (obrigatório para Cartão)
    "txid": "",      
    "valor_total": 250.00,      // Deve ser o valor exato da venda original
    "is_percent": true,         // true usa porcentagem | false: usa valor_bruto
    "splits": [
      {
        "documento": "22.222.222/0001-22", // Documento da Ancorada
        "porcentagem": 85.00,
        "valor_bruto": 0
      },
      {
        "documento": "00.000.000/0001-91", // Documento da Âncora
        "porcentagem": 15.00,
        "valor_bruto": 0
      }
    ]
  }
}

Exemplo de venda com pix e split por valor

{
  "confirm_split": {
    "nsu": "",           
    "txid": "3ab123c8d64045e3fg513254fcbf73ed",      						// TxID da transação (obrigatório para PIX)
    "valor_total": 250.00,      // Deve ser o valor exato da venda original
    "is_percent": false,         // true: usa porcentagem | false: usa valor_bruto
    "splits": [
      {
        "documento": "22.222.222/0001-22", // Documento da Ancorada
        "porcentagem": 0,
        "valor_bruto": 100
      },
      {
        "documento": "00.000.000/0001-91", // Documento da Âncora
        "porcentagem": 0,
        "valor_bruto": 150.00
      }
    ]
  }
}

Retorno de Sucesso (200 OK)

{
  "data": "Split aplicado com sucesso!"
}

Regras de Funcionamento

  • Identidade do Estabelecimento: O estabelecimento dono do Token (Ancorado) deve ser o mesmo que realizou a venda.
  • Participação do Vendedor: Por regra, o estabelecimento que realizou a venda deve reter, no mínimo, 10% do valor total.
  • Presença da Âncora: É obrigatório que o estabelecimento Âncora do estabelecimento receba uma parte do split.
  • Prioridade de Cálculo: Se is_percent for true, o sistema calculará os valores com base nas porcentagens informadas. Se for false, o sistema utilizará os valores brutos.
  • Estabelecimentos no Split: Obrigatoriamente a Âncora e a Ancorada (estabelecimento no qual a venda foi gerada), devem estar presentes no split, porém, é possível inserir outro estabelecimento desde que ele esteja vinculado à mesma Âncora que o estabelecimento que realizou a venda.
  • Tipo de Transação:
    • Para PIX, o preenchimento do campo txid é obrigatório.
    • Para Cartão, o preenchimento do campo nsu é obrigatório.

Body Params
confirm_split
object
required
Headers
string
required

Token gerado no momento em que o usuário realiza o login. Formato: eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0

string
required

Header que recebe o tipo do conteúdo a ser enviado.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json