Fornecemos a possibilidade de criação de uma assinatura com split, onde a assinatura terá um ou mais recebedores.
Tais recebedores terão acesso a uma parte do valor da compra recorrentemente, podendo informar uma porcentagem do valor.
Ao ativar a regra na recorrência toda cobrança gerada a partir da assinatura possuirá split.
Quem pode usar Split
Esta funcionalidade está disponível apenas para clientes PSP
Para criar uma recorrência com split basta adicionar o objeto split dentro de uma assinatura, conforme os exemplos abaixo.
Para conhecer todas as propriedades do Split confira a nossa documentação.
"split": {
"enabled": true,
"rules": [
{
"amount": 50,
"recipient_id": "rp_n9voQ2QT0SQrMwOL",
"type": "percentage",
"options": {
"charge_processing_fee": true,
"charge_remainder_fee": true,
"liable": true
}
},
{
"amount": 50,
"type": "percentage",
"recipient_id": "rp_6gyn5oIvAcwjrNej",
"options": {
"charge_processing_fee": false,
"charge_remainder_fee": false,
"liable": false
}
}
]
}
{
"billing_type": "prepaid",
"items": [
{
"name": "Premium",
"description": "Sem anuncios",
"quantity": 1,
"pricing_scheme": {
"price": 1490
}
},
{
"name": "Silver",
"description": "Com anuncios",
"quantity": 1,
"pricing_scheme": {
"price": 1490
}
}
],
"customer": {
"name": "Tony Stark",
"email": "[email protected]",
"Document": "11111111111",
"type": "individual",
"phones": {
"home_phone": {
"country_code": "55",
"area_code": "21",
"number": "000000000"
},
"mobile_phone": {
"country_code": "55",
"area_code": "21",
"number": "000000000"
}
}
},
"card": {
"number": "4000000000000010",
"holder_name": "Tony Stark",
"exp_month": 1,
"exp_year": 22,
"cvv": "3531",
"billing_address": {
"street": "Malibu Point",
"number": "10880",
"zip_code": "90265",
"neighborhood": "Central Malibu",
"city": "Malibu",
"state": "CA",
"country": "US"
}
},
"split": {
"enabled": true,
"rules": [
{
"amount": 50,
"recipient_id": "rp_n9voQ2QT0SQrMwOL",
"type": "percentage",
"options": {
"charge_processing_fee": true,
"charge_remainder_fee": true,
"liable": true
}
},
{
"amount": 50,
"type": "percentage",
"recipient_id": "rp_6gyn5oIvAcwjrNej",
"options": {
"charge_processing_fee": false,
"charge_remainder_fee": false,
"liable": false
}
}
]
},
"metadata": {
"id": "teste"
}
}
{
"payment_method": "boleto",
"billing_type": "prepaid",
"items": [
{
"name": "Premium",
"description": "Sem anuncios",
"quantity": 1,
"pricing_scheme": {
"price": 1490
}
},
{
"name": "Silver",
"description": "Com anuncios",
"quantity": 1,
"pricing_scheme": {
"price": 1490
}
}
],
"customer": {
"name": "Tony Stark",
"email": "[email protected]"
},
"boleto": {
"bank": "033",
"instructions": "Pagar até o vencimento",
"due_at": "2021-12-09T00:00:00Z",
"document_number": "{{boleto_document_number}}"
},
"split": {
"enabled": true,
"rules": [
{
"amount": 50,
"recipient_id": "rp_n9voQ2QT0SQrMwOL",
"type": "percentage",
"options": {
"charge_processing_fee": true,
"charge_remainder_fee": true,
"liable": true
}
},
{
"amount": 50,
"type": "percentage",
"recipient_id": "rp_6gyn5oIvAcwjrNej",
"options": {
"charge_processing_fee": false,
"charge_remainder_fee": false,
"liable": false
}
}
]
},
"metadata": {
"id": "teste"
}
}
O objeto split na recorrência tem os seguintes atributos.
| Atributos | Tipo | Descrição |
|---|---|---|
| Enabled | Boolean | Indica se o split está habilitado ou não na assinatura. |
| Rules | Array of Objects | Configurações para pagamentos com Split. Saiba mais sobre Split. |
Importante
É preciso criar no mínimo dois recebedores para ativar a regra Split para saber como criar recebedores confira a nossa documentação.
Só é possível fazer split na recorrência através de porcentagens (´type´: ´percentage´). Valores monetários de (´type´: ´flat´) não são permitidos.
Os valores em porcentagens não podem conter decimais.