Veja a seguir todos os casos de uso contemplado pela API de Pagamentos e os diferentes fluxos de liquidação e processamento do pagamento.
Criação de Pagamento Autorizado
A criação de pagamento autorizado, também chamado de captura de pagamento consiste no processamento e efetivação do pagamento no momento de envio da requisição. Esse é o fluxo comumente utilizado nos mais diversos tipos de negócios atuais.
Entretanto, para efetivamente você criar um pagamento utilizando esse fluxo, é necessário que o parâmetro capture seja enviado como true (verdadeiro).
A seguir veja um exemplo de requisição para captura de pagamento:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"softdescriptor": "PAG*TESTE",
"card": {
"holder": "TESTE HOLDER",
"number": "5201561050025011",
"expiry_month": "09",
"expiry_year": "2024",
"brand": "mastercard",
"cvv": "123"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
Criação de Pagamento Pré-Autorizado
A criação de pagamento pré-autorizado, também chamado de pré-captura de pagamento, consiste no processamento prévio do pagamento, reserva do dinheiro do cliente e efetivação parcial ou completa do pagamento posterior a pré-captura do pagamento.
Veja a seguir uma esquematização da pré-captura de pagamento:
Esquematização da Pré-Captura de Pagamento
Geralmente, essa modalidade de pagamento são utilizados para operações que exigem garantia do pagamento ou a segurança do pagamento, como hotelaria e aluguel de serviços & produtos.
Vale ressaltar, que a pré-captura será cancelada automaticamente caso você não realize a captura em 5 dias posterior a criação do pagamento pré-autorizado.
A seguir veja um exemplo de requisição para pré-captura de pagamento:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": false,
"softdescriptor": "PAG*TESTE",
"card": {
"vault": "2beaeb98-391d-41d9-8685-61464f3c0789"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
Além disso, esteja atento ao valor capturado, ele não pode superar o valor pré-capturado original da criação do pagamento.
Criar Pagamento com Cofre de Cartão
A criação de pagamento com cofre de cartão consiste na utilização de um cofre de um cartão para a realização da pré-autorização ou autorização de pagamentos sem o envio dos dados do cartão, apenas utilizando seu cofre.
Esse método de criação de pagamentos é interessante para estabelecimentos que necessitem da possibilidade de negócio de compra com um clique em sua plataforma.
Entretanto, para a criação do pagamento utilizando essa modalidade é necessário realizar a tokenização prévia dos dados cartão através do endpoint de Criação de Cofre de Cartão.
A seguir veja um exemplo de requisição para captura de pagamento com cofre de cartão:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"softdescriptor": "PAG*TESTE",
"card": {
"vault": "2beaeb98-391d-41d9-8685-61464f3c0789"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
Vale-se dizer, que é possível fazer pagamentos de pré-captura e captura com a utilização do cofre.
Criar Pagamento com Split
A criação de pagamento com o split consiste no processo de alteração e modificação da liquidação, ou seja, não está atrelado efetivamente na alteração do fluxo de efetivação e autorização do arranjo pagamento criado. Dessa forma, você pode utilizar um pagamento com split tanto em uma pré-autorização quanto em uma autorização.
Essa modalidade de criação de pagamento é interessante para operações de negócios que exigem a divisão do pagamento entre dois ou mais recebedores. Por exemplo, ao fazer a venda de um produto online, você pode dividir uma parte do pagamento para a transportadora do pedido e uma parte para a fornecedora do pedido, conseguindo assim, alterar o fluxo de liquidação no momento da criação do pagamento.
A seguir, esquematização do fluxo de processo realizado:
Esquematização do Split de Pagamento
Vale dizer, que essa operação não é possível ser feita para empresas não cadastradas na plataforma, ou seja, você não consegue definir para qual conta bancária será feita o split.
Considerações do Split de Pagamento
Por outro lado, é necessário levantar algumas considerações quanto a criação do pagamento com split:
- Considere como
PRIMARY, o participante primário ou de origem do pagamento; - Considere como
SECONDARY, participantes secundários do split do pagamento; - Tenha ciência que só é possível criar um split com apenas um participante primário;
- O participante primário não pode receber menos que 1% do pagamento;
- A soma dos valores divididos no split não pode ser diferente do valor líquido da transação;
A seguir veja um exemplo de requisição para criação de pagamentos com split de pagamento:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"card": {
"holder": "TESTE HOLDER",
"number": "5201561050025011",
"expiryMonth": "09",
"expiryYear": "2024",
"brand": "mastercard",
"cvv": "123"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billingAddress": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
},
"splits": [
{
"recipientToken": "9b7ba208a0e54094b9c06ef479acf4b29ddc1d3a",
"merchantType": "PRIMARY",
"chargeFee": true,
"type": "PERCENTAGE",
"amountSplit": 6000
},
{
"recipientToken": "4a723333747e4aa3ac10f12fa65af89e5057d651",
"merchantType": "SECONDARY",
"type": "PERCENTAGE",
"chargeFee": false,
"discountGrossAmount": false,
"amountSplit": 4000
},
{
"recipientToken": "4a723333747e4aa3ac10f12fa65af89e5057d633",
"merchantType": "SECONDARY",
"type": "AMOUNT",
"chargeFee": false,
"discountGrossAmount": false,
"amountSplit": 200
}
]
}
Criação de Pagamento com Split Tardio
A criação de pagamento com split tardio, assim como, no split padrão consiste no processo de alteração e modificação da liquidação, ou seja, não está atrelado efetivamente na alteração do fluxo de efetivação e autorização do arranjo pagamento criado. Dessa maneira, você pode realizar tanto uma pré-autorização quanto uma autorização com split tardio.
Entretanto, a sua diferença ao split padrão está no momento tardio de modificação dos participantes da liquidação do pagamento, assim, ao contrário de definir os participantes do split no momento de criação de pagamento, você realiza essa definição em um momento posterior a captura.
Veja a seguir uma esquematização do fluxo de processo:
Esquematização do Split Tardio do Pagamento
Sendo assim, observando o esquema, percebe-se a necessidade de realizar a requisição de criação do pagamento e a requisição de ativação do split tardio (chamada anteriormente como "Definição dos Participantes").
Caso o estabelecimento crie o pagamento informando o split tardio e por acaso a definição dos participantes através do endpoint de Ativação do Split Tardio não seja realizada, o pagamento não será liquidado até o estabelecimento que criou os pagamentos realizar a definição dos participantes ou cancelar o pagamento.
A seguir veja um exemplo de requisição para criação de pagamentos com split de pagamento tardio:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"delayed_split": true,
"softdescriptor": "PAG*TESTE",
"card": {
"holder": "TESTE HOLDER",
"number": "5201561050025011",
"expiry_month": "09",
"expiry_year": "2024",
"brand": "mastercard",
"cvv": "123"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
Após a criação do pagamento é necessário a ativação do split de pagamento, veja a seguir um exemplo de requisição:
{
"orderId": "6183f4ac7ad8d",
"splits": [
{
"recipientToken": "9b7ba208a0e54094b9c06ef479acf4b29ddc1d3a",
"merchantType": "PRIMARY",
"chargeFee": true,
"type": "PERCENTAGE",
"amountSplit": 6000
},
{
"recipientToken": "4a723333747e4aa3ac10f12fa65af89e5057d651",
"merchantType": "SECONDARY",
"type": "PERCENTAGE",
"chargeFee": false,
"discountGrossAmount": false,
"amountSplit": 4000
},
{
"recipientToken": "4a723333747e4aa3ac10f12fa65af89e5057d633",
"merchantType": "SECONDARY",
"type": "AMOUNT",
"chargeFee": false,
"discountGrossAmount": false,
"amountSplit": 200
}
]
}
Vale ressaltar que devem ser consideradas algumas observações:
- Caso a soma dos percentuais dos participantes do split tardio for maior que 100%, a ativação do split tardio não será realizada e continuará pendente de ativação.
- Caso a soma dos percentuais dos participantes do split tardio for menor que 100%, a ativação do split tardio será realizada e o participante primário receberá o resto percentual que sobrou do split criado.
- Caso a taxa cobrada da plataforma pela autorização do pagamento for em cima do líquido do participante e o desconto dela sobre o participante resultar em um valor líquido a receber negativo, a ativação do split tardio não será realizada e continuará pendente de ativação.
- Caso a taxa cobrada da plataforma não for informada para ser paga por nenhum dos participantes através do parâmetro
chargeFee, ela será cobrada pelo participante primário da ativação do split.
Além de considerar os casos acima, reveja as Considerações do Split do Pagamento para se integrar ao endpoint de ativação do split.