Split

Utilizando a funcionalidade de Split você pode criar um pedido com mais de um recebedor e N regras de Split
Saiba mais sobre Split.

❗️

Regras de uso do Split

Esta funcionalidade está disponível apenas para clientes PSP

O objeto split tem as seguintes propriedades:

Atributos

Tipo

Descrição

amount

integer

Valor destinado ao recebedor.

type

string

Tipo de divisão. Os valores possíveis são flat ou percentage.

recipient_id

string

Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX.

options

object

Informações da responsabilidade do recebedor na transação.

options.liable

bool

Indica se o recebedor é responsável pela transação em caso de chargeback.

options.charge_processing_fee

bool

Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação

options.charge_remainder_fee

bool

Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão

Com a funcionalidade split é possível criar vários cenários que consigam atender a suas necessidades de negócios, pode criar N recebedores com uma única regra de split ou pode criar N quantidade de recebedores com mais de uma regra de split para cada recebedor.

"split": [
    {
        "amount": 50,
        "recipient_id": "{{recipient_id_1}}",
        "type": "percentage",
        "options": {
            "charge_processing_fee": true,
            "charge_remainder_fee": true,
            "liable": true
        }
    },
    {
        "amount": 50,
        "type": "percentage",
        "recipient_id": "{{recipient_id_2}}",
        "options": {
            "charge_processing_fee": false,
            "charge_remainder_fee": false,
            "liable": false
        }
    }
]
"split": [
    {
        "id": "sr_rqNglzXwF5fMQ2Rd",
        "type": "percentage",
        "amount": 50,
        "recipient": {
            "id": "rp_7YZXapnCAWcGrnaV",
            "name": "Recipient 1",
            "email": "[email protected]",
            "document": "26224451990",
            "description": "Recipient 1",
            "type": "individual",
            "payment_mode": "bank_transfer",
            "status": "active",
            "created_at": "2022-03-07T20:43:25Z",
            "updated_at": "2022-03-07T20:43:25Z"
        },
        "options": {
            "liable": true,
            "charge_processing_fee": true,
            "charge_remainder_fee": true
        }
    },
    {
        "id": "sr_Eb40Z63CxhekXlgr",
        "type": "percentage",
        "amount": 50,
        "recipient": {
            "id": "rp_jwvVZZrSzxubVr5X",
            "name": "Recipient 2",
            "email": "[email protected]",
            "document": "26224451990",
            "description": "Recipient 2",
            "type": "individual",
            "payment_mode": "bank_transfer",
            "status": "active",
            "created_at": "2022-03-07T20:43:33Z",
            "updated_at": "2022-03-07T20:43:33Z"
        },
        "options": {
            "liable": false,
            "charge_processing_fee": false,
            "charge_remainder_fee": false
        }
    }
]
"split": [
    {
        "amount": 500,
        "recipient_id": "{{recipient_1}}",
        "type": "flat",
        "options": {
            "liable": true,
            "charge_processing_fee": true,
            "charge_remainder_fee": true
        }
    },
    {
        "amount": 4500,
        "recipient_id": "{{recipient_2}}",
        "type": "percentage",
        "options": {
            "liable": false,
            "charge_processing_fee": false,
            "charge_remainder_fee": false
        }
    },
    {
        "amount": 500,
        "recipient_id": "{{recipient_1}}",
        "type": "flat",
        "options": {
            "liable": false,
            "charge_processing_fee": false,
            "charge_remainder_fee": false
        }
    },
    {
        "amount": 4500,
        "recipient_id": "{{recipient_3}}",
        "type": "flat",
        "options": {
            "liable": false,
            "charge_processing_fee": false,
            "charge_remainder_fee": false
        }
    }
]
"split": [
    {
        "id": "sr_vDMrKxHMzUZgWKyb",
        "type": "flat",
        "gateway_id": "sr_cl0h5h1he02f20i9t1x342lq1",
        "amount": 500,
        "recipient": {
            "id": "rp_Yjzd0rlso5HG1KLP",
            "name": "TVA (Autoridade de Variância do Tempo)",
            "email": "[email protected]",
            "document": "63495937072",
            "description": "Agente Mobius",
            "type": "individual",
            "payment_mode": "bank_transfer",
            "status": "active",
            "created_at": "2022-03-07T20:19:55Z",
            "updated_at": "2022-03-07T20:19:55Z"
        },
        "options": {
            "liable": true,
            "charge_processing_fee": true,
            "charge_remainder_fee": true
        }
    },
    {
        "id": "sr_1knXBEmtmIKVewMO",
        "type": "flat",
        "gateway_id": "sr_cl0h5h1hf02f30i9txhn78z5v",
        "amount": 4500,
        "recipient": {
            "id": "rp_lkMPKDFN2FrNRyw6",
            "name": "TVA (Autoridade de Variância do Tempo)",
            "email": "[email protected]",
            "document": "63495937072",
            "description": "Agente Mobius",
            "type": "individual",
            "payment_mode": "bank_transfer",
            "status": "active",
            "created_at": "2022-03-07T20:19:59Z",
            "updated_at": "2022-03-07T20:19:59Z"
        },
        "options": {
            "liable": false,
            "charge_processing_fee": false,
            "charge_remainder_fee": false
        }
    },
    {
        "id": "sr_Ae0Ygw0uWtvROBaL",
        "type": "flat",
        "gateway_id": "sr_cl0h5h1hf02f40i9t2tdxyt2h",
        "amount": 500,
        "recipient": {
            "id": "rp_Yjzd0rlso5HG1KLP",
            "name": "TVA (Autoridade de Variância do Tempo)",
            "email": "[email protected]",
            "document": "63495937072",
            "description": "Agente Mobius",
            "type": "individual",
            "payment_mode": "bank_transfer",
            "status": "active",
            "created_at": "2022-03-07T20:19:55Z",
            "updated_at": "2022-03-07T20:19:55Z"
        },
        "options": {
            "liable": false,
            "charge_processing_fee": false,
            "charge_remainder_fee": false
        }
    },
    {
        "id": "sr_9bzgAwaHXGcX5RM5",
        "type": "flat",
        "gateway_id": "sr_cl0h5h1hf02f50i9t09msen0k",
        "amount": 4500,
        "recipient": {
            "id": "rp_jRYNBWac97HaPMoq",
            "name": "TVA (Autoridade de Variância do Tempo)",
            "email": "[email protected]",
            "document": "63495937072",
            "description": "Agente Mobius",
            "type": "individual",
            "payment_mode": "bank_transfer",
            "status": "active",
            "created_at": "2022-03-07T20:20:03Z",
            "updated_at": "2022-03-07T20:20:03Z"
        },
        "options": {
            "liable": false,
            "charge_processing_fee": false,
            "charge_remainder_fee": false
        }
    }
]

❗️

Regras de Split - responsabilidade

Ao menos um recebedor deve ser responsável pelos seguintes pontos:
Responsável pela transação em caso de chargeback;
Responsável pelas taxas da transação;
Responsável pelo restante dos recebíveis após uma divisão.