Transação com Split

Descrição

O atributo splits dentro da estrutura de uma transação com split desempenha um papel crucial na definição de como o valor total da compra será distribuído entre diferentes destinatários.

Estrutura e propósito:

O atributo splits é um array, o que significa que ele pode conter múltiplos objetos, cada um representando uma divisão do valor total.

Objetos: Cada objeto dentro do array contém duas propriedades principais:

• sellerId: Um identificador único que associa o valor à um determinado vendedor ou destinatário. Esse identificador permite que o sistema de pagamento saiba para qual conta creditar o valor.
• amount: Indica o valor monetário em centavos a ser recebido pelo destinatário correspondente. Esse valor deve ser uma parte do valor total da transação.

JavaScript

{
  // ... other properties
  "splitMode": "ACQUIRER",
  "payments": [
    // ... other payments
    {
      "splits": [
        {
          "amount": 100000,
          "sellerId": 1
        },
        {
          "amount": 50000,
          "sellerId": 2
        }
      ]
    }
  ]
}

📘

Importância do splitMode

O atributo splitMode deve ser definido como ACQUIRER. Essa configuração indica que a divisão do valor da transação será realizada de forma automática e online pela adquirente, distribuindo os valores entre os participantes conforme as regras informadas no array de splits.

Exemplo - Cartão de crédito

POST /api/v2/sellers/{sellerId}/orders/credit-card/authorize

JavaScript

{
   "orderReference":"ORDER-0001",
   "customer":{
      "birthdate":"1992-02-29",
      "document":"63624133004",
      "name":"Tony Stark"
   },
   "notificationUrl":"https://ecommerce.bempaggo.io/events/order001",
   "amount":150000,
   "splitMode": "ACQUIRER",
   "payments":[
      {
         "paymentMethod":"CREDIT_CARD",
         "cardToken":{
            "cvv":"123",
            "token":"9fab5bfd09b148eda411b07c5535afd10b98023abcd645dba7c3a0cc2209da88"
         },
         "amount":150000,
         "installments":10,
         "splits":[
            {
               "amount":100000,
               "sellerId":1
            },
            {
               "amount":50000,
               "sellerId":2
            }
         ]
      }
   ]
}

Exemplo - Pix

Exemplo - Boleto