POST
/
subscriptions
/
add_split
cURL
curl --request POST \
  --url https://sandbox-api.superpagamentos.com/subscriptions/add_split \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "splitType": "amount",
  "splitAmount": 123,
  "splitPercentage": 123,
  "chargebackLiable": true
}'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "splitType": "AMOUNT",
    "splitPercentage": 123,
    "splitAmount": 123,
    "liquidAmount": 123,
    "chargebackLiable": true
  },
  "message": "Split adicionado com sucesso"
}

Authorizations

​
Authorization
string
header
required

Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer <token>

Body

application/json

Dados necessários para adicionar um split à assinatura

​
subscriptionId
string<uuid>
required

Identificador único da assinatura que receberá o split

​
subaccountId
string<uuid>
required

Identificador único da subconta que receberá o split

​
splitType
enum<string>
required

Tipo do split. 'amount' para valor fixo ou 'percentage' para porcentagem do valor da assinatura

Available options:
amount,
percentage
​
splitAmount
integer

Valor fixo do split em centavos. Obrigatório quando splitType é 'amount'

​
splitPercentage
number

Porcentagem do valor da assinatura que será destinada ao split. Obrigatório quando splitType é 'percentage'. Aceita valores decimais com até 2 casas (ex: 80 ou 80.50)

​
chargebackLiable
boolean

Define se a subconta será responsável pelos chargebacks da assinatura. Se não informado, o valor padrão é false

Response

Split adicionado com sucesso

​
data
object
​
message
string

Mensagem de sucesso da operação

Example:

"Split adicionado com sucesso"