post
https://sandbox.staging.justa.com.vc/payment-provider/api/split
Cria um split de vendas para um estabelecimento.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Resposta da requisição
| Variável | Tipo | Descrição |
|---|---|---|
| id | String | Id gerado para identificar esta configuração de split. |
| rule | String | Regra da divisão de valores. |
| sellingEstablishmentId | Long | Id do estabelecimento realizador da venda. |
| status | String | Status do split. Ex.: ativo (ACTIVE) ou inativo (INACTIVE). |
| splits | List. | Lista de estabelecimentos envolvidos no split. |
Splits
| Variável | Tipo | Descrição |
|---|---|---|
| type | String | Tipo de estabelecimento no split, se MAIN ou DEFAULT. |
| establishmentId | Long | Id do estabelecimento envolvido no split. |
| plan | String | Identificação de plano usado na venda (ORIGIN) ou não (DESTINATION). |
| taxPayer | String | Define quem paga a taxa deste split. Se o estabelecimento principal (SELLING) ou o estabelecimento do split (PARTICIPANT). |
| description | String | Descrição deste split. |
| value | Double | Valor 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
Detalhes do envio da requisição
Regras de valores (rule)
- GROSS_VALUE: com o valor bruto, a porcentagem de lucro dos splits é captada do valor bruto da venda. Entende-se splits, especificamente aqui neste campo, como os estabelecimentos que não realizaram a venda e que apenas recebem lucro sobre a mesma. Após os splits serem pagos sobre o valor bruto, o estabelecimento realizador da venda recebe o percentual restante subtraído das taxas de venda.
- LIQUID_VALUE: com o valor líquido, as taxas de venda são debitadas do valor total e então as porcentagens são repassadas para os demais estabelecimentos envolvidos, sejam splits ou estabelecimento realizador da venda.