Confirmar Split Âncora

Esta API permite que a Âncora confirme a solicitação de Split Pós-fixado. Para a confirmação é necessário passar os dados da venda, os dados dos estabelecimentos beneficiados e as porcentagens para divisão dos valores.

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

Confirmar Split (Visão Âncora)

Esta rota permite que um Estabelecimento Âncora realize a divisão de valores (split) de uma venda pós-fixada. A âncora é a entidade responsável por ditar as regras de divisão dos splits das vendas das Ancoradas.

Headers

HeaderValorDescrição
AuthorizationBearer {{JWT_TOKEN}}Token de acesso do estabelecimento Âncora.
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": "123456",            // NSU da transação (obrigatório para Cartão)
    "txid": "",      
    "valor_total": 100.00,      // Valor bruto original da venda
    "is_percent": true,         // true: usa porcentagem | false: usa valor_bruto
    "splits": [
      {
        "documento": "00.000.000/0001-91", // Documento da Âncora
        "porcentagem": 90.00,
        "valor_bruto": 0
      },
      {
        "documento": "11.111.111/1111-11", // Documento da Ancorada
        "porcentagem": 10.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": 100.00,      // Valor bruto original da venda
    "is_percent": false,         // true: usa porcentagem | false: usa valor_bruto
    "splits": [
      {
        "documento": "00.000.000/0001-91", // Documento da Âncora
        "porcentagem": 0,
        "valor_bruto": 90.00
      },
      {
        "documento": "11.111.111/1111-11", // Documento da Ancorada
        "porcentagem": 0,
        "valor_bruto": 10.00
      }
    ]
  }
}

Retorno de Sucesso (200 OK)

Quando todos os dados estão consistentes e as regras de negócio são atendidas, o sistema retorna:

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

Regras de Funcionamento

  • 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.
  • Identificação da Venda: Para vendas via PIX, o campo txid é obrigatório. Para vendas via CARTÃO, o campo nsu é obrigatório.
  • Participação Obrigatória: O estabelecimento Âncora (dono do token) deve estar incluído na lista de splits.
Body Params
confim_split
object
required
Headers
string
required

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

string
required
Defaults to application/json

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