O que é o Split de Pagamentos ?

O Split de Pagamentos permite a divisão de uma transação entre diferentes participantes de uma venda.

Muito utilizado em Marketplaces, onde o carrinho é composto por produtos de diferentes fornecedores e o valor total da venda deve ser dividido entre os participantes.

Participantes	Descrição
Marketplace	Responsável pelo carrinho. Possui Subordinados que fornecem os produtos presentes no carrinho. Define um MDR* e uma Tarifa Fixa (opcional) a serem descontados sobre a venda do Subordinado.
Subordinado	Fornecedor dos produtos que compõem o carrinho. Recebe parte do valor da venda, descontado o MDR* acordado com o Marketplace.
Braspag (Facilitador)	Responsável pelo fluxo transacional. Define um MDR* e uma Tarifa Fixa a serem descontados sobre o valor total da venda realizada pelo Marketplace. Responsável pela liquidação dos pagamentos para os Subordinados e Marketplace.

*MDR (Merchant Discount Rate): Percentual a ser descontado sobre o valor de uma transação.

Como funciona o Split de Pagamentos?

No Split de Pagamentos o responsável pelo fluxo transacional é o facilitador.

O Marketplace se integra à Braspag para transacionar e informa como será dividida a transação entre cada participante, podendo ser no momento de captura ou em um momento posterior, conhecido como split pós-transacional, desde que seja dentro de um limite de tempo pré-estabelecido.

Com a transação capturada, a Braspag calcula o valor destinado a cada participante e repassa esses valores, no prazo estabelecido de acordo com cada produto (regime de pagamento*), para cada envolvido na transação.

*Regime de Pagamento: Prazo estabelecido para liquidação de acordo com o produto (crédito ou débito) e bandeira.
Crédito: Em até 31 dias.
Crédito Parcelado: 1º parcela em até 31 dias, demais a cada 30.
Débito: Em até 1 dia útil

Para utilizar o Split de Pagamentos, o Marketplace deverá se cadastrar na Braspag juntamente com seus Subordinados. Após este processo, tanto o Marketplace quanto seus Subordinados possuirão um identificador único, conhecido como MerchantId (MID), que deverá ser utlizado ao informar as regras de divisão de uma transação.

A divisão de uma transação deve serguir as seguintes regras:

• Informar os identificadores dos Subordinados.
• Os valores de participação de cada Subordinado. O somatório deverá ser igual ao valor total da transação.
• MDRs + Tarifas Fixas (opcional) a serem aplicados sobre o valor de cada Subordinado que será destinado ao Marketplace. Deverá ser acordado previamente entre o Marketplace e o Subordinado.

O Marketplace também pode ser um participante da divisão. Para isso basta informar seu identificador na divisão, passando o mesmo a ter também o papel de Subordinado e ter seus próprios produtos no carrinho.

Taxas

As taxas acordadas entre os participantes, que são o MDR(%) e uma Taxa Fixa(R$), devem ser definidas no momento do cadastro do Marketplace e dos seus Subordinados junto à Braspag.

As mesmas poderão ser enviadas no momento transacional ou pós-transacional. Caso não sejam enviadas, a Braspag irá considerar as taxas já cadastradas.

Braspag (Facilitador)

A Braspag acordará um MDR(%) e uma Tarifa Fixa(R$) com o Marketplace a serem descontados em cada transação.

O Marketplace, de conhecimento destas taxas, negociará o seu MDR(%) e uma Tarifa Fixa(R$)(opcional) juntamente com seus Subornidandos, já embutindo o MDR(%) acordado junto à Braspag.

O desconto da Tarifa Fixa(R$), acordado entre o Marketplace e a Braspag, não é aplicado no valor total da transação, não entrando no cálculo da divisão e sim sendo debitado do montante que o Marketplace tem para receber junto à Braspag. O MDR(%) entra no cálculo de divisão da transação, já que o mesmo deve estar embutido no MDR(%) acordado entre o Marketplace e seus Subordinados.

Custo para o Marketplace: MDR Braspag(%) + Tarifa Fixa(R$)

O MDR(%) acordado entre um Marketplace e um Subordinado deve ser sempre maior que o MDR(%) acordado entre a Braspag e o Marketplace.

Marketplace

O Marketplace é responsável por acordar as taxas a serem cobradas de seus Subordinados, onde deve ser defindo um MDR(%) maior ou igual ao MDR(%) definido entre a Braspag e o Marketplace e uma Tarifa Fixa(R$), que é opcional.

Custo para o Subordinado: MDR Marketplace(%) + Tarifa Fixa(R$), onde no MDR Marketplace(%) está embutido o MDR Braspag(%).

Exemplo

Uma transação de R$100, realizada por um Marketplace com participação do Subordinado 01.

Neste exemplo, foram assumidos os seguintes acordos:

Taxa Braspag: 2% MDR + R$0,30 Tarifa Fixa.
Taxa Marketplace: 5% MDR, já embutindo os 2% do MDR Braspag + 0,30 Tarifa Fixa.

Após o split, cada participante terá sua agenda sensibilizada com os seguintes eventos:

Subordinado:
Crédito: R$94,70 = (R$100 - 5%) - R$0,30.

Marketplace:
Crédito: R$3,30 = R$100 * (5% - 2%) + R$0,30.
Débito: R$0,30 (Tarifa Fixa Braspag)

Braspag (Facilitador):
Crédito: R$2,00 = R$100 * 2%.
Crédito: R$0,30 (Tarifa Fixa Braspag)

Utilizando o Split de Pagamentos

O Split de Pagamentos é parte da API Cielo E-Commerce, desenvolvida utilizando a arquitetura REST e JSON como mensageria. Para mais informações sobre a API Cielo E-Commerce, consulte o Manual de Integração da Plataforma.

OBS: Neste manual serão apresentados os contratos de integração da API Cielo E-Commerce, porém o foco da análise será nas operações referentes ao Split de Pagamentos.

Ambientes

SANDBOX

API Cielo E-Commerce:
https://apisandbox.cieloecommerce.cielo.com.br/

API Cielo E-Commerce (Consulta):
https://apiquerysandbox.cieloecommerce.cielo.com.br/

API Split:
http://splitsandbox.braspag.com.br/

OAUTH2 Server:
https://authhomolog.braspag.com.br/

Autorização

A autorização de uma transação no Split de Pagamentos deve ser realizada através da API Cielo E-Commerce seguindo os mesmos contratos descritos na documentação da plataforma.

Porém, para indentificar que a transação enviada se trata de uma transação de Split de Pagamentos, deve-se modificar o tipo de pagamento utilizado, conforme abaixo:

	Cartão de Crédito	Cartão de Débito
Transação Comum	CreditCard	DebitCard
Transação Split	SplittedCreditCard	SplittedDebitCard

Atualmente o Split de Pagamentos está disponivel para os seguintes tipos de pagamento:

• Cartão de Crédito

Em breve estarão disponíveis:

• Cartão de Débito
• Boleto

Exemplo:

{
   "MerchantOrderId":"2014111703",
   "Customer":{
      "Name":"Comprador crédito simples"
   },
   "Payment":{
     "Type":"SplittedCreditCard",
     "Amount":10000,
     "Installments":1,
     "SoftDescriptor":"123456789ABCD",
     "CreditCard":{
         "CardNumber":"1234123412341231",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}

Ao informar um tipo de pagamento referente ao Split, a API Cielo e-Commerce automaticamente identifica que a transação é referente ao Split de Pagamentos e realiza o fluxo transacional pela Braspag (Facilitador).

Caso a transação enviada seja marcada para captura automática, o nó contendo as regras de divisão deverá ser enviado, caso contrário a transação será dividida entre a Braspag e o Marketplace. Posteriormente é permitido que o Marketplace envie novas regras de divisão para a transação através da API de divisão pós-transacional, desde que esteja dentro do período de tempo permitido.

Exemplo 1)

Transação no valor de R$100,00 sem o nó contendo as regras de divisão.

Taxa Braspag: 2% MDR + R$0,30 Tarifa Fixa.

{
   "MerchantOrderId":"2014111703",
   "Customer":{
      "Name":"Comprador crédito simples"
   },
   "Payment":{
     "Type":"SplittedCreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "SoftDescriptor":"123456789ABCD",
     "CreditCard":{
         "CardNumber":"1234123412341231",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}

Neste caso o Marketplace recebe o valor da transação descontado o MDR acordado com a Braspag. Como apresentado anteriormente, a Tarifa Fixa acordada entre o Marketplace e a Braspag é sensibilizada diretamente na agenda.

Exemplo 2)

Transação no valor de R$100,00 com o nó contendo as regras de divisão.

Taxa Braspag: 2% MDR + R$0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 01: 5% MDR, já embutindo os 2% do MDR Braspag + 0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 02: 4% MDR, já embutindo os 2% do MDR Braspag + 0,15 Tarifa Fixa.

{
   "MerchantOrderId":"2014111703",
   "Customer":{
      "Name":"Comprador crédito simples"
   },
   "Payment":{
     "Type":"SplittedCreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "SoftDescriptor":"123456789ABCD",
     "CreditCard":{
         "CardNumber":"1234123412341231",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"123",
         "Brand":"Visa"
     },
     "SplitPayments":[
        {
            "SubordinateMerchantId" :"MID Subordinate 01",
            "Amount":6000,
            "Fares":{
                "Mdr":5,
                "Fee":30
            }
        },
        {
            "SubordinateMerchantId" :"MID Subordinate 02",
            "Amount":4000,
            "Fares":{
                "Mdr":4,
                "Fee":15
            }
        }
     ]
   }
}

Neste caso o cálculos do Split são realizados sobre cada regra de divisão informada. No próximo tópico serão explicados as propriedades que compõem o nó do Split de Pagamentos.

Modelos de Split

O Split de Pagamentos possui dois modelos básicos de integração:

Tipo	Descrição
Split Transacional	O Marketplace envia na autorização (captura automática) ou no momento de captura as regras de divisão.
Split Pós-Transacional	O Marketplace envia as regras de divisão após a captura da transação.

O Split de Pagamentos só é realizado para transações capturadas, ou seja, o mesmo só será considerado para autorizações com captura automática e no momento da captura de uma transação. Caso seja informado no momento de uma autorização sem captura automática, as regras de divisão serão desconsideradas.

Split Transacional

Este modelo exige que o Marketplace envie um “nó” adicional na integração da API Cielo E-Commerce, como apresentado em exemplos anteriores, informando as regras de divisão da transação.

"SplitPayments":[
    {
        "SubordinateMerchantId" :"MID Subordinate 01",
        "Amount":10000,
        "Fares":{
            "Mdr":5,
            "Fee":0
        }
    }
]

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
SplitPayments.SubordinateMerchantId	MerchantId (Identificador) do Subordinado.	Guid	36	Sim
SplitPayments.Amount	Parte do valor total da transação referente a participação do Subordinado, em centavos.	Inteiro	-	Sim
SplitPayments.Fares.Mdr	MDR(%) do Marketplace a ser descontado do valor referente a participação do Subordinado	Decimal	-	Sim
SplitPayments.Fares.Fee	Tarifa Fixa(R$) a ser descontada do valor referente a participação do Subordinado, em centavos.	Inteiro	-	Sim

Como resposta, A API Cielo E-Commerce retornará na resposta um nó contento as regras de divisão enviadas e os valores a serem recebidos pelo Marketplace e seus Subordinados:

"SplitPayments": [
    {
        "SubordinateMerchantId": "MID Subordinate 01",
        "Amount": 10000,
        "Fares": {
            "Mdr": 5,
            "Fee": 0
        },
        "Splits": [                
            {
                "MerchantId": "MID do Marketplace",
                "amount": 500,
            },
            {
                "MerchantId": "MID Subordinate 01",
                "amount": 9500,
            }
        ]
    }
]

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
SplitPayments.Splits.SubordinateMerchantId	MerchantId (Identificador) do Subordinado ou Marketplace.	Guid	36	Sim
SplitPayments.Splits.Amount	Parte do valor calculado da transação a ser recebido pelo Subordinado ou Marketplace, já descontando todas as taxas (MDR e Tarifa Fixa)	Inteiro	-	Sim

Exemplo

Transação no valor de R$100,00 com o nó contendo as regras de divisão.

Taxa Braspag: 2% MDR + R$0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 01: 5% MDR, já embutindo os 2% do MDR Braspag + 0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 02: 4% MDR, já embutindo os 2% do MDR Braspag + 0,15 Tarifa Fixa.

REQUEST

{
   "MerchantOrderId":"2014111703",
   "Customer":{
      "Name":"Comprador crédito simples"
   },
   "Payment":{
     "Type":"SplittedCreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "SoftDescriptor":"123456789ABCD",
     "CreditCard":{
         "CardNumber":"1234123412341231",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"123",
         "Brand":"Visa"
     },
     "SplitPayments":[
        {
            "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
            "Amount":6000,
            "Fares":{
                "Mdr":5,
                "Fee":30
            }
        },
        {
            "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
            "Amount":4000,
            "Fares":{
                "Mdr":4,
                "Fee":15
            }
        }
     ]
   }
}

RESPONSE

{
    "MerchantOrderId": "2014111706",
    "Customer": {
        "Name": "Comprador crédito simples"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "CreditCard": {
            "CardNumber": "455187******0183",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2030",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ProofOfSale": "674532",
        "Tid": "0305023644309",
        "AuthorizationCode": "123456",
        "PaymentId": "24bc8366-fc31-4d6c-8555-17049a836a07",
        "Type": "CreditCard",
        "Amount": 10000,
        "Currency": "BRL",
        "Country": "BRA",
        "ExtraDataCollection": [],
        "Status": 1,
        "ReturnCode": "4",
        "ReturnMessage": "Operation Successful",
        "SplitPayments":[
            {
                "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
                "Amount":6000,
                "Fares":{
                    "Mdr":5,
                    "Fee":30
                },
                "Splits": [
                    {
                        "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                        "amount": 210,    
                    },
                    {
                        "MerchantId": "0f377932-5668-4c72-8b5b-2b43760ebd38", 
                        "amount": 5670,    
                    }
                ]
            },
            {
                "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
                "Amount":4000,
                "Fares":{
                    "Mdr":4,
                    "Fee":15
                },
                "Splits": [
                    {
                        "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                        "amount": 95,    
                    },
                    {
                        "MerchantId": "98430463-7c1e-413b-b13a-0f613af594d8", 
                        "amount": 3825,    
                    }
                ]
            }
        ],
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
            }
        ]
    }
}

Neste exemplo os cálculos do Split foram realizados sobre cada regra de divisão informada e na resposta retornaram os valores a serem recebidos pelo Marketplace e seus Subordinados.

Divisão do valor do Subordinado 0f377932-5668-4c72-8b5b-2b43760ebd38:

Marketplace: R$2,10
Subordinado: R$56,70

Divisão do valor do Subordinado 98430463-7c1e-413b-b13a-0f613af594d8:

Marketplace: R$0,95
Subordinado: R$38,25

Split Pós-Transacional

Neste modelo o Marketplace poderá enviar as regras de divisão da transação após a mesma ser capturada.

A divisão pós-transacional é possível somente para transações com Cartão de Crédito e poderá ser realizada dentro de um intervalo de tempo a partir da data de captura da transação.

Para transações com Cartão de Crédito, este período é de 25 dias se o Marketplace possuir um regime padrão de pagamentos. Caso tenha um regime personalizado, o período deverá ser acordado entre as partes (Marketplace e Braspag).

A API de divisão pós-transacional utiliza como segurança o protocolo OAUTH2, onde é necessário primeiramente obter um token utlizando suas credenciais, que deverá posteriormente ser enviado à API do Split para realização da divisão pós-transacional.

Para obter um token de acesso:

1. Concatene o ClientId e ClientSecret: ClientId:ClientSecret.
2. Codifique o resultado da concatenação em Base64.
3. Realize uma requisição ao servidor de autorização:

REQUEST

POST https://{OAUTH2 Server}/oauth2/token  
--header "Authorization: Basic {base64}"  
--header "Content-Type: application/x-www-form-urlencoded"  
grant_type=client_credentials

RESPONSE

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbG.....WE1igNAQRuHAs",
    "token_type": "bearer",
    "expires_in": 1199
}

O ClientId é o mesmo utilizado na integração com a API Cielo E-Commerce, conhecido como MerchantId. O ClientSecret deve ser obtido junto à Braspag.

O token retornado (access_token) deverá ser utilizado em toda requisição à API do Split como uma chave de autorização. O mesmo possui uma validade de 20 minutos e deverá ser obtido um novo token toda vez que o mesmo expirar.

Com o token de acesso, é possível realizar um requisição à API do Split para enviar as regras de divisão de uma transação.

REQUEST

PUT https://{API Split}/api/transactions/{PaymentId}/split
--header "Authorization: Bearer {token}"

[
    {
        "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
        "Amount":6000,
        "Fares":{
            "Mdr":5,
            "Fee":30
        }
    },
    {
        "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
        "Amount":4000,
        "Fares":{
            "Mdr":4,
            "Fee":15
        }
    }
]

RESPONSE

[
    {
        "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
        "Amount":6000,
        "Fares":{
            "Mdr":5,
            "Fee":30
        },
        "Splits": [
            {
                "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                "amount": 210,    
            },
            {
                "MerchantId": "0f377932-5668-4c72-8b5b-2b43760ebd38", 
                "amount": 5670   
            }
        ]
    },
    {
        "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
        "Amount":4000,
        "Fares":{
            "Mdr":4,
            "Fee":0.15
        },
        "Splits": [
            {
                "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                "amount": 95,    
            },
            {
                "MerchantId": "98430463-7c1e-413b-b13a-0f613af594d8", 
                "amount": 3825    
            }
        ]
    }
]

Exemplo considerando transação no valor de R$100,00 e as seguinte taxas:

Taxa Braspag: 2% MDR + R$0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 01: 5% MDR, já embutindo os 2% do MDR Braspag + 0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 02: 4% MDR, já embutindo os 2% do MDR Braspag + 0,15 Tarifa Fixa.

O nó de Split de Pagamentos da API pós-transacional, no contrato de request e response, é o mesmo retornado na divisão no momento transacional, apresentado anteriormente.

O Marketplace poderá informar as regras de divisão da transação mais de uma vez desde que esteja dentro do período de tempo permitido, que é de 25 dias para Cartão de Crédito. Para transações com Cartão de Débito a divisão poderá ser realizada somente no momento transacional.

Consulta

Para consultar uma transação, utilize o próprio serviço de consulta da API Cielo E-Commerce.

REQUEST

GET https://{API Cielo E-Commerce (consulta)}/1/sales/{PaymentId}

RESPONSE

{
    "MerchantOrderId": "2014111706",
    "Customer": {
        "Name": "Comprador Teste"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": false,
        "Authenticate": false,
        "CreditCard": {
            "CardNumber": "455187******0183",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2030",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ProofOfSale": "674532",
        "AuthorizationCode": "123456",
        "PaymentId": "24bc8366-fc31-4d6c-8555-17049a836a07",
        "Type": "CreditCard",
        "Amount": 1000,
        "Currency": "BRL",
        "Country": "BRA",
        "ExtraDataCollection": [],
        "Status": 2,
        "SplitPayments":[
            {
                "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
                "Amount":6000,
                "Fares":{
                    "Mdr":5,
                    "Fee":30
                },
                "Splits": [
                    {
                        "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                        "amount": 210,    
                    },
                    {
                        "MerchantId": "0f377932-5668-4c72-8b5b-2b43760ebd38", 
                        "amount": 5670,    
                    }
                ]
            },
            {
                "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
                "Amount":4000,
                "Fares":{
                    "Mdr":4,
                    "Fee":15
                },
                "Splits": [
                    {
                        "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                        "amount": 95,    
                    },
                    {
                        "MerchantId": "98430463-7c1e-413b-b13a-0f613af594d8", 
                        "amount": 3825,    
                    }
                ]
            }
        ],
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
            }
        ]
    }
}

Captura

Ao capturar uma transação do Split de Pagamentos o Marketplace deve informar as regras de divisão da mesma. Caso não informe, será gerada a divisão da transação entre o Marketplace e a Braspag, tanto para captura do valor total quanto para captura de um valor parcial.

Captura Total

Na captura total de uma transação, o somatório dos valores de participação de cada subordinado deverá ser igual ao valor total da transação enviado no momento da autorização.

REQUEST

PUT https://{API Cielo E-Commerce}/1/sales/{PaymentId}/capture
{
    "SplitPayments":[
        {
            "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
            "Amount":6000,
            "Fares":{
                "Mdr":5,
                "Fee":30
            }
        },
        {
            "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
            "Amount":4000,
            "Fares":{
                "Mdr":4,
                "Fee":15
            }
        }
     ]
}

RESPONSE

{
    "Status": 2,
    "ReturnCode": "6",
    "ReturnMessage": "Operation Successful",
    "SplitPayments":[
        {
            "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
            "Amount":6000,
            "Fares":{
                "Mdr":5,
                "Fee":30
            },
            "Splits": [
                {
                    "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                    "amount": 210,    
                },
                {
                    "MerchantId": "0f377932-5668-4c72-8b5b-2b43760ebd38", 
                    "amount": 5670,    
                }
            ]
        },
        {
            "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
            "Amount":4000,
            "Fares":{
                "Mdr":4,
                "Fee":15
            },
            "Splits": [
                {
                    "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                    "amount": 95,    
                },
                {
                    "MerchantId": "98430463-7c1e-413b-b13a-0f613af594d8", 
                    "amount": 3825,    
                }
            ]
        }
    ]
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
        },
        {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
        }
    ]
}

Exemplo considerando transação no valor de R$100,00 e as seguinte taxas:

Taxa Braspag: 2% MDR + R$0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 01: 5% MDR, já embutindo os 2% do MDR Braspag + 0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 02: 4% MDR, já embutindo os 2% do MDR Braspag + 0,15 Tarifa Fixa.

Captura Parcial

Na captura parcial de uma transação, o somatório dos valores de participação de cada subordinado deverá ser igual ao valor total a ser capturado.

REQUEST

PUT https://{API Cielo E-Commerce}/1/sales/{PaymentId}/capture?amount=8000
{
    "SplitPayments":[
        {
            "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
            "Amount":4000,
            "Fares":{
                "Mdr":5,
                "Fee":30
            }
        },
        {
            "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
            "Amount":4000,
            "Fares":{
                "Mdr":4,
                "Fee":15
            }
        }
     ]
}

RESPONSE

{
    "Status": 2,
    "ReturnCode": "6",
    "ReturnMessage": "Operation Successful",
    "SplitPayments":[
        {
            "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
            "Amount":4000,
            "Fares":{
                "Mdr":5,
                "Fee":30
            },
            "Splits": [
                {
                    "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                    "amount": 150,    
                },
                {
                    "MerchantId": "0f377932-5668-4c72-8b5b-2b43760ebd38", 
                    "amount": 3770,    
                }
            ]
        },
        {
            "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
            "Amount":4000,
            "Fares":{
                "Mdr":4,
                "Fee":0.15
            },
            "Splits": [
                {
                    "MerchantId": "cd16ab8e-2173-4a16-b037-36cd04c07950", 
                    "amount": 95,    
                },
                {
                    "MerchantId": "98430463-7c1e-413b-b13a-0f613af594d8", 
                    "amount": 3825,    
                }
            ]
        }
    ]
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
        },
        {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
        }
    ]
}

Exemplo considerando transação no valor de R$100,00, captura parcial de R$80,00 e as seguintes taxas:

Taxa Braspag: 2% MDR + R$0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 01: 5% MDR, já embutindo os 2% do MDR Braspag + 0,30 Tarifa Fixa.
Taxa Marketplace com o Subordinado 02: 4% MDR, já embutindo os 2% do MDR Braspag + 0,15 Tarifa Fixa.

Cancelamento

Ao cancelar uma transação do Split de Pagamentos o Marketplace deve informar, para um cancelamento parcial, qual o valor deve ser cancelado de cada Subpordinado que participa da transação. Para um cancelamento total esta informação não é necessária, já que será cancelado o valor total e consequentemente o valor total de cada Subpordinado.

Cancelamento Total

No cancelamento total de uma transação, será cancelado o valor total da transação e consequentemente o valor total de cada Subordinado.

REQUEST

PUT https://{API Cielo E-Commerce}/1/sales/{PaymentId}/void

RESPONSE

{
    "Status": 10,
    "ReturnCode": "9",
    "ReturnMessage": "Operation Successful",
    "VoidSplitPayments":[
        {
            "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
            "VoidAmount":1500,
        },
        {
            "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
            "VoidAmount":500,
        }
    ]
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
        }
    ]
}

Cancelamento Parcial

No cancelamento parcial, o somatório dos valores cancelados definidos para cada Subordinado não poderão ultrapassar o valor total do cancelamento parcial.

Os valores cancelados serão sensibilizados nas respectivas agendas dos Subordinados.

REQUEST

PUT https://{API Cielo E-Commerce}/1/sales/{PaymentId}/void?amount=2000
{
    "VoidSplitPayments":[
        {
            "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
            "VoidAmount":1500,
        },
        {
            "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
            "VoidAmount":500,
        }
     ]
}

RESPONSE

{
    "Status": 2,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReturnCode": "0",
    "ProviderReturnMessage": "Operation Successful",
    "ReturnCode": "0",
    "ReturnMessage": "Operation Successful",
    "VoidSplitPayments":[
        {
            "SubordinateMerchantId" :"0f377932-5668-4c72-8b5b-2b43760ebd38",
            "VoidAmount":1500,
        },
        {
            "SubordinateMerchantId" :"98430463-7c1e-413b-b13a-0f613af594d8",
            "VoidAmount":500,
        }
    ],
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
        }
    ]
}

Agenda

Em breve disponibilizaremos a API de Agenda onde será possível consultar a agenda do Markectplace e seus Subordinados.