Pagamento recorrente com divisão de recebíveis
A funcionalidade de split de pagamentos recorrentes permite dividir os valores de uma transação recorrente entre até 15 recebedores diferentes. A divisão pode ser configurada em valores fixos ou percentuais, de acordo com a necessidade do negócio. Essa funcionalidade oferece flexibilidade para empresas que operam em modelos de receita compartilhada, marketplaces ou negócios com múltiplos parceiros.
O split de pagamento recorrente é um recurso integrado ao sistema de assinaturas que permite dividir automaticamente o valor entre diferentes recebedores em cada ciclo de cobrança. Esse processo de automação garante eficiência, proporciona transparência aos recebedores e facilita a gestão financeira ao evitar ajustes manuais em transações recorrentes.
Para utilizar o split de pagamento recorrente, você tem duas opções:
- Configuração ao Criar a Assinatura: Defina o split no momento da criação da assinatura. Para obter mais detalhes, consulte o guia de introdução ao pagamento recorrente.
- Configuração ao Alterar uma Assinatura Existente: Adicione o split a uma assinatura já criada utilizando o endpoint Alterar assinatura.
Em ambos os casos, siga as etapas detalhadas abaixo para configurar o split de pagamento recorrente.
Como funciona
Para habilitar o split de pagamento recorrente para uma transação com pagamento recorrente, você deve enviar o parâmetro split_enabled e as configurações para a divisão do pagamento ao realizar a requisição.
| Parâmetro | Tipo | Formato | Descrição |
|---|---|---|---|
split_enabled | boolean | TRUE ou FALSE | Define se o split de pagamento recorrente está habilitado. Requer envio de configurações da divisão do pagamento. |
A tabela a seguir apresenta os cenários de configuração possíveis:
Status do split_enabled | Configuração | Comportamento | Descrição | HTTPS Code |
|---|---|---|---|---|
false | Enviado | Uma assinatura será criada mas a funcionalidade de split estará desativada. | ||
true | Não enviado | Não criado. | Split enabled and splits fields are mandatory. | 400 |
| Não enviado | Enviado | Não criado. | Split enabled and splits fields are mandatory. | 400 |
true | Enivado | O split do pagamento será realizado. |
Para mais informações sobre os códigos de erro possíveis, acesse a página de erro em assinaturas ou a página de erros em split the pagamento .
Ao definir as configurações da divisão do pagamento, os valores no campo amount devem ser especificados em centavos. Por exemplo, para representar R$ 1,00, informe 100 centavos. A soma dos valores de todos os recebedores deve totalizar 100% do valor da transação.
Para mais detalhes sobre os parâmetros da configuração da divisão do pagamento, acesse Crie e Pague Pedido com Divisão de Pagamento.
Exemplos de Requisições
No bloco de código abaixo você encontra exemplos de requisição para criação de uma assinatura com split de pagamento recorrente e para realizar o pagamento.
curl --location 'https://sandbox.api.assinaturas.pagseguro.com/subscriptions' \
--header 'x-idempotency-key: YOUR_IDEMPOTENCY_KEY' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data-raw '{
"plan": {
"id": "YOUR_PLAN_ID"
},
"customer": {
"reference_id": "CUSTOMER_REFERENCE_ID",
"name": "John Doe",
"email": "john.doe@example.com",
"tax_id": "12345678900",
"phones": [
{
"area": "11",
"number": "999999999",
"country": "55"
}
],
"address": {
"street": "123 Test Street",
"number": "456",
"complement": "Apt 789",
"city": "São Paulo",
"region_code": "SP",
"country": "BRA",
"postal_code": "01000-000",
"locality": "Test Neighborhood"
},
"billing_info": [
{
"type": "CREDIT_CARD",
"card": {
"number": "4111111111111111",
"exp_year": "30",
"exp_month": "12",
"holder": {
"name": "John Doe"
}
}
}
]
},
"payment_method": [
{
"type": "CREDIT_CARD",
"card": {
"security_code": "123"
}
}
],
"pro_rata": false,
"reference_id": "TEST_REFERENCE_ID"
}'
curl --location 'https://sandbox.api.assinaturas.pagseguro.com/subscriptions' \
--header 'x-idempotency-key: YOUR_IDEMPOTENCY_KEY' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data-raw '{
"plan": {
"id": "YOUR_PLAN_ID"
},
"customer": {
"reference_id": "CUSTOMER_REFERENCE_ID",
"name": "John Doe",
"email": "john.doe@example.com",
"tax_id": "12345678900",
"phones": [
{
"area": "11",
"number": "999999999",
"country": "55"
}
],
"address": {
"street": "123 Test Street",
"number": "456",
"complement": "Apt 789",
"city": "São Paulo",
"region_code": "SP",
"country": "BRA",
"postal_code": "01000-000",
"locality": "Test Neighborhood"
},
"billing_info": [
{
"type": "CREDIT_CARD",
"card": {
"number": "4111111111111111",
"exp_year": "30",
"exp_month": "12",
"holder": {
"name": "John Doe"
}
}
}
]
},
"payment_method": [
{
"type": "CREDIT_CARD",
"card": {
"security_code": "123"
}
}
],
"pro_rata": false,
"reference_id": "TEST_REFERENCE_ID",
"split_enabled": true,
"splits": {
"method": "PERCENTAGE",
"receivers": [
{
"account": {
"id": "ACCOUNT_ID_1"
},
"amount": {
"value": 15
}
},
{
"account": {
"id": "ACCOUNT_ID_2"
},
"amount": {
"value": 85
}
}
]
}
}'
Funcionalidades Adicionais
As funcionalidades disponíveis para o split de pagamento estão disponíveis para o split de pagamentos com recorrência:
-
Cancelamento Proporcional: Quando solicitado, o cancelamento será realizado sobre o valor total da transação, mantendo a proporção estabelecida no momento da venda. Para mais informações, acesse o guia de Cancelamento Proporcional.
-
Repasse de Chargeback: Em casos de chargeback, o valor é descontado do recebedor primário. Para recuperar esse valor, o recebedor primário deve definir, ao criar a assinatura com divisão de pagamento, um recebedor secundário responsável pelo repasse. Para mais informações, acesse as regras de repasse de chargeback.
-
Criação de um Pedido com Custódia: A utilização da funcionalidade de custódia proporciona maior segurança nas transações ao bloquear temporariamente os lançamentos de um pedido. Esse bloqueio somente é liberado após a confirmação da entrega pelo vendedor e/ou comprador. Para mais detalhes, acesse a página de liberação de pagamento com custória .
Visualização no painel de assinaturas
Atualmente, a funcionalidade de split de pagamentos com recorrência encontra-se no estágio de MVP. Por esse motivo, os detalhes do split não são refletidos diretamente no painel de assinaturas. Para gerenciar ou visualizar os splits dos pagamentos com recorrência, você deve utilizar o endpoint Listar Assinaturas .
Updated 3 months ago