API Reference
Log In
API Reference

Busca split

Busca um split associado ao estabelecimento pelo id.

Resposta da requisição

VariávelTipoDescrição
idStringId gerado para identificar esta configuração de split.
ruleStringRegra da divisão de valores.
sellingEstablishmentIdLongId do estabelecimento realizador da venda.
statusStringStatus do split. Ex.: ativo (ACTIVE) ou inativo (INACTIVE).
splitsList.Lista de estabelecimentos envolvidos no split.

Splits

VariávelTipoDescrição
typeStringTipo de estabelecimento no split, se MAIN ou DEFAULT.
establishmentIdLongId do estabelecimento envolvido no split.
planStringIdentificação de plano usado na venda (ORIGIN) ou não (DESTINATION).
taxPayerStringDefine quem paga a taxa deste split. Se o estabelecimento principal (SELLING) ou o estabelecimento do split (PARTICIPANT).
descriptionStringDescrição deste split.
valueDoubleValor percentual do valor recebido no split.

🚧

Para utilizar este endpoint, é necessário seguir o modelo de autenticação descrito na seção Access Token V2 e que o usuário possua uma das seguintes funções:

  • INTEGRADOR_SPLIT_MANAGE
  • INTEGRADOR_SPLIT_READ_ONLY
Language
Click Try It! to start a request and see the response here!