Adiciona um split (empresa recebedora)

POST/v1/subscriptions/{subscriptionId}/splits

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros do caminho

subscriptionIdstringobrigatório
Identificador público (subs_/sub_…)

Corpo da requisição

typestringobrigatório
percentage ou flat.
Valores:percentageflat
valuenumberobrigatório
O percentual (0–100) ou o valor fixo, conforme type.
recipientstringobrigatório
A conta que recebe a fatia (bus_…).

Respostas

201Criado

_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
splitsobject[]obrigatório
Todos os splits da assinatura depois da mudança.
+10 campos de splits
- idstringobrigatório
  Identificador público (ssp_/split_…)
- typestringobrigatório
  percentage ou flat.
- valuenumberobrigatório
  O percentual (0–100) ou o valor fixo, conforme type.
- _linksobject
  Links para operações relacionadas, por ação (self, create, update, delete, list…).
- liablebooleanobrigatório
  Se o recebedor arca com os chargebacks da fatia.
- merchantobject
  A conta dona do recurso (o vendedor de registro).
  +3 campos de merchant
  - namestringobrigatóriopode ser nulo
    Nome fantasia da conta dona do recurso.
  - merchantIdstringobrigatóriopode ser nulo
    Id público da conta dona do recurso (bus_…).
  - isSubAccountbooleanobrigatório
    true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- recipientstringobrigatóriopode ser nulo
  A conta que recebe a fatia.
- updatedAtstringobrigatório
  Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
- chargeProcessingFeebooleanobrigatório
  Se o recebedor paga a taxa de processamento da fatia.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
subscriptionstringobrigatório
A assinatura.
remainingAmountstringobrigatório
O que sobra do valor recorrente depois das fatias fixas, em centavos (como texto).
totalPercentagenumberobrigatório
Soma das fatias percentuais.
remainingPercentagenumberobrigatório
O que sobra de 100% depois das fatias percentuais.

400Requisição inválida (validação)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

422Regra de negócio impede o processamento

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorLista os splits de uma assinatura PróximaLista os limiares de cobrança

curl -X POST "https://api.selectwin.io/v1/subscriptions/{subscriptionId}/splits" \ -H "SelectKey: $SELECTWIN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "type": "percentage", "value": 5000, "recipient": "id_0a1b2c3d4e5f60718293" }'

{ "_links": {}, "splits": [ { "id": "ssp_0a1b2c3d4e5f60718293", "type": "string", "value": 5000, "_links": {}, "liable": true, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true }, "createdAt": "string", "recipient": "string", "updatedAt": "string", "chargeProcessingFee": true } ], "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true }, "subscription": "subs_0a1b2c3d4e5f60718293", "remainingAmount": "string", "totalPercentage": 5000, "remainingPercentage": 0 }