Pular para o conteúdo principal

Cobranças com Split

O split foi criado com o objetivo de fazer o repasse automático dos valores de uma transação entre diversos parceiros recebedores com as regras estabelecidas pelo nosso cliente.

Criando uma cobrança com Split​

Uma configuração de Split contém uma ou mais regras que definem taxas de comissão e condições quando a taxa se aplica.

Para criar uma transação com split, basta adicionar o campo splitRules que representará as regras daquela cobrança, dentro do corpo da requisição da criação de uma transação.

Regras de split​

Cada regra (splitRules) em uma configuração dividida deve ter:

  • Identificador do destinatário (sellerId): O valor de ID dentro de splitRules deve ser correspondente ao ID gerado na criação de seller.

  • Porcentagem (percentage): porcentagem do valor da transação original que será enviada ao destinatário

  • Valor (amount): valor que será enviado ao destinatário

  • Sinalizador de taxa de processamento (processingFee): o destinatário será cobrado pelas taxas de processamento, que serão descontadas de seu saldo, definido como falso para desconto do marketplace

  • Responsabilidade por reembolso (liable) : o destinatário será responsável pelo reembolso (charge_back), que será descontado de seu saldo, definido como falso para desconto do marketplace.

  • Tarifas (fares) : o destinatário será responsável pelas tarifas, que serão descontadas de seu saldo, definido como falso para desconto do marketplace.

    • mdr(Merchant Discount Rate): percentual a ser descontado do valor de uma transação, definido por produto (crédito/débito/boleto), bandeira e faixa de parcelamento.
    • Tarifa fixa(fee): também chamada de fee transacional. Valor em centavos a ser cobrado por transação capturada. É descontado no momento da “montagem” da agenda financeira
caution
  • Não é possível realizar uma transação com split misto, isto é, utilizando as duas regras de divisão: porcentagem e valor.
  • A informação de tarifas no momento é apenas para split que transaciona utilizando provider Braspag

Exemplo de cobrança com Split aprovado​

curl -X POST 'https://api.malga.io/v1/charges' \
    --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
    --header 'X-Api-Key: <YOUR_SECRET_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
      "merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
      "amount": 150,
      "currency": "BRL",
      "statementDescriptor": "Pedido #231 loja joão",
      "capture": false,
      "paymentMethod": {
        "paymentType": "credit",
        "installments": 1
      },
      "paymentSource": {
        "sourceType": "card",
        "card": {
          "cardNumber": "4929564637987814",
          "cardCvv": "320",
          "cardExpirationDate": "06/2028",
          "cardHolderName": "JOAO DA SILVA"
        }
      },
      "splitRules": [{
        "sellerId": "5323ece6-816d-11ed-a1eb-0242ac120002",
        "percentage": 90,
        "processingFee": true,
        "liable": true,
        }, 
        {
         "sellerId": "616605b2-816f-11ed-a1eb-0242ac120002",
         "percentage": 10,
         "processingFee": false,
         "liable": false,
      }]
  }'
< HTTP/2 201
{
    "merchantId": "46b433bf-79aa-4cb1-9eaa-cdaea42cb955",
    "amount": 100,
    "currency": "BRL",
    "statementDescriptor": "Pedido #231 loja joão",
    "capture": false,
    "paymentMethod": {
        "paymentType": "credit",
        "installments": 1
    },
    "paymentSource": {
        "sourceType": "card",
        "card": {
            "cardHolderName": "JOSE DAS NEVES",
            "cardNumber": "4929564637987814",
            "cardCvv": "120",
            "cardExpirationDate": "12/2026"
        }
    },
    "fraudAnalysis": {
        "customer": {
            "name": "Jose Bonifacio Da Silveira",
            "phone": "21 98889999099",
            "email": "jose@gmail.com",
            "identity": "02960069048",
            "identityType": "CPF",
            "billingAddress": {
                "street": "Rua 129",
                "number": "30",
                "zipCode": "61936320",
                "country": "BR",
                "state": "CE",
                "district": "Timbó",
                "city": "Maracanaú",
                "complement": "teste"
            }
        },
        "cart": {
            "items": [
                {
                    "name": "Teste",
                    "sku": "Teste",
                    "risk": "Low",
                    "unitPrice": 1,
                    "quantity": 1
                }
            ]
        }
    },
    "splitRules": [{
        "sellerId": "5323ece6-816d-11ed-a1eb-0242ac120002",
        "percentage": 90,
        "processingFee": true,
        "liable": true,
      }]
}

Exemplo utilizando o campo amount 

curl -X POST 'https://api.plugpagamentos.com/v1/charges' \
    --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
    --header 'X-Api-Key: <YOUR_SECRET_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
      "merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
      "amount": 150,
      "currency": "BRL",
      "statementDescriptor": "Pedido #231 loja joão",
      "capture": false,
      "paymentMethod": {
        "paymentType": "credit",
        "installments": 1
      },
      "paymentSource": {
        "sourceType": "card",
        "card": {
          "cardNumber": "4929564637987814",
          "cardCvv": "320",
          "cardExpirationDate": "06/2028",
          "cardHolderName": "JOAO DA SILVA"
        }
      },
        "splitRules": [
        {
          "sellerId": "5323ece6-816d-11ed-a1eb-0242ac120002",
          "percentage": 10,
          "processingFee": true,
          "liable": true,
        },         
      ]
  }'

< HTTP/2 201
{
    "merchantId": "46b433bf-79aa-4cb1-9eaa-cdaea42cb955",
    "amount": 150,
    "currency": "BRL",
    "statementDescriptor": "Pedido #231 loja joão",
    "capture": false,
    "paymentMethod": {
        "paymentType": "credit",
        "installments": 1
    },
    "paymentSource": {
        "sourceType": "card",
        "card": {
            "cardHolderName": "JOSE DAS NEVES",
            "cardNumber": "4929564637987814",
            "cardCvv": "120",
            "cardExpirationDate": "12/2026"
        }
    },
    "fraudAnalysis": {
        "customer": {
            "name": "Jose Bonifacio Da Silveira",
            "phone": "21 98889999099",
            "email": "jose@gmail.com",
            "identity": "02960069048",
            "identityType": "CPF",
            "billingAddress": {
                "street": "Rua 129",
                "number": "30",
                "zipCode": "61936320",
                "country": "BR",
                "state": "CE",
                "district": "Timbó",
                "city": "Maracanaú",
                "complement": "teste"
            }
        },
        "cart": {
            "items": [
                {
                    "name": "Teste",
                    "sku": "Teste",
                    "risk": "Low",
                    "unitPrice": 1,
                    "quantity": 1
                }
            ]
        }
    },
    "splitRules": [{
        "sellerId": "5323ece6-816d-11ed-a1eb-0242ac120002",
        "amount": 10,
        "processingFee": true,
        "liable": true,
      }]
}

Exemplo utilizando o campo de tarifa

curl -X POST 'https://api.plugpagamentos.com/v1/charges' \
    --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
    --header 'X-Api-Key: <YOUR_SECRET_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
      "merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
      "amount": 150,
      "currency": "BRL",
      "statementDescriptor": "Pedido #231 loja joão",
      "capture": false,
      "paymentMethod": {
        "paymentType": "credit",
        "installments": 1
      },
      "paymentSource": {
        "sourceType": "card",
        "card": {
          "cardNumber": "4929564637987814",
          "cardCvv": "320",
          "cardExpirationDate": "06/2028",
          "cardHolderName": "JOAO DA SILVA"
        }
      },
        "splitRules": [
        {
          "sellerId": "5323ece6-816d-11ed-a1eb-0242ac120002",
          "percentage": 10,
          "processingFee": true,
          "liable": true,
          "fares": {
            "mdr": 2,
            "fee": 100
          }
        },         
      ]
  }'

< HTTP/2 201
{
    "merchantId": "46b433bf-79aa-4cb1-9eaa-cdaea42cb955",
    "amount": 150,
    "currency": "BRL",
    "statementDescriptor": "Pedido #231 loja joão",
    "capture": false,
    "paymentMethod": {
        "paymentType": "credit",
        "installments": 1
    },
    "paymentSource": {
        "sourceType": "card",
        "card": {
            "cardHolderName": "JOSE DAS NEVES",
            "cardNumber": "4929564637987814",
            "cardCvv": "120",
            "cardExpirationDate": "12/2026"
        }
    },
    "fraudAnalysis": {
        "customer": {
            "name": "Jose Bonifacio Da Silveira",
            "phone": "21 98889999099",
            "email": "jose@gmail.com",
            "identity": "02960069048",
            "identityType": "CPF",
            "billingAddress": {
                "street": "Rua 129",
                "number": "30",
                "zipCode": "61936320",
                "country": "BR",
                "state": "CE",
                "district": "Timbó",
                "city": "Maracanaú",
                "complement": "teste"
            }
        },
        "cart": {
            "items": [
                {
                    "name": "Teste",
                    "sku": "Teste",
                    "risk": "Low",
                    "unitPrice": 1,
                    "quantity": 1
                }
            ]
        }
    },
    "splitRules": [{
        "sellerId": "5323ece6-816d-11ed-a1eb-0242ac120002",
        "amount": 10,
        "processingFee": true,
        "liable": true,
        "fares": {
            "mdr": 2,
            "fee": 100
          }
      }]
}