Captura com split

Captura um pagamento repartindo o valor entre sub-lojistas e consulta a divisão gravada.

Em um pedido com itens de mais de um seller, o valor pago precisa ser repartido. A captura com split envia à Braspag quanto cada sub-lojista recebe, com a taxa (mdr) e a tarifa fixa de cada um. A plataforma grava a divisão para auditoria e permite consultá-la depois. O valor capturado é a soma das partes.

Capturar com split

PUT/api/v1/admin/braspag/payments/{paymentId}/split-captureAdmin

Captura com split

Parâmetros de caminho

paymentIduuidobrigatório

GUID do pagamento na Braspag.

Corpo da requisição

splitsarrayobrigatório

Uma regra por sub-lojista. Pelo menos uma; sub-lojistas não podem se repetir.

subordinate_merchant_idstringobrigatório

Id do sub-lojista na Braspag (campo do cadastro do seller).

amountintegerobrigatório

Parte do seller em centavos, maior que zero.

faresobject

Taxas descontadas da parte do seller.

mdrinteger

Taxa de desconto do lojista em pontos-base, de 0 a 10000 (350 = 3,50%).

feeinteger

Tarifa fixa por transação em centavos, não negativa.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/braspag/payments/3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11/split-capture" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "splits": [
      {
        "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
        "amount": 7000,
        "fares": {
          "mdr": 350,
          "fee": 10
        }
      },
      {
        "subordinate_merchant_id": "c7a2d1bb-2222-4333-9444-555566667777",
        "amount": 3000,
        "fares": {
          "mdr": 350,
          "fee": 10
        }
      }
    ]
  }'

Resposta

200Capturado com split

json

{
  "payment_id": "3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11",
  "status": 2,
  "captured_amount": 10000,
  "split_payments": [
    {
      "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
      "amount": 7000,
      "fares": {
        "mdr": 350,
        "fee": 10
      }
    },
    {
      "subordinate_merchant_id": "c7a2d1bb-2222-4333-9444-555566667777",
      "amount": 3000,
      "fares": {
        "mdr": 350,
        "fee": 10
      }
    }
  ],
  "captured_at": "2026-10-11T15:00:00Z"
}

Campos da resposta

payment_idstring

GUID do pagamento.

statusinteger

Código de status do pagamento na Braspag (2 = pago/capturado).

captured_amountinteger

Total capturado em centavos.

split_paymentsarray

Divisão confirmada pela Braspag: subordinate_merchant_id, amount e fares.mdr/fares.fee.

captured_atstring

Momento da confirmação (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
400	Corpo não é um JSON válido.	`{"error":"invalid request body"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
422	Regra inválida ou falha na Braspag. A mensagem vem em inglês.	`{"error":"braspag: invalid split rules: split rule 1: amount must be positive (centavos)"}`

Consultar a divisão gravada

Lista as partes gravadas quando o pagamento foi capturado com split. Pagamento sem split devolve lista vazia.

GET/api/v1/admin/braspag/payments/{paymentId}/splitsAdmin

Consulta o split gravado

Parâmetros de caminho

paymentIduuidobrigatório

GUID do pagamento na Braspag.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/braspag/payments/3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11/splits" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Partes do split

json

[
  {
    "id": "0b1c2d3e-4f50-4a6b-8c7d-9e0f1a2b3c4d",
    "payment_id": "3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11",
    "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
    "vendor_id": "7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f",
    "amount": 7000,
    "mdr_rate": 350,
    "fee": 10,
    "net_amount": 6745,
    "created_at": "2026-10-11T15:00:00Z"
  }
]

Campos da resposta

amountinteger

Parte bruta em centavos.

mdr_rateinteger

Taxa em pontos-base.

feeinteger

Tarifa fixa em centavos.

net_amountinteger

Líquido do seller em centavos, depois de mdr_rate e fee.

vendor_iduuid

Seller na Venddor, quando o vínculo é conhecido.

iduuid

Id do registro.

payment_idstring

GUID do pagamento.

subordinate_merchant_idstring

Sub-lojista na Braspag.

created_atstring

Gravação (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
500	Falha ao ler.	`{"error":"failed to retrieve split payments"}`

Veja também

Braspag

API atual/Referência completa/Braspag

Captura com split

Captura um pagamento repartindo o valor entre sub-lojistas e consulta a divisão gravada.

Capturar com split

PUT/api/v1/admin/braspag/payments/{paymentId}/split-captureAdmin

Captura com split

Parâmetros de caminho

paymentIduuidobrigatório

GUID do pagamento na Braspag.

Corpo da requisição

splitsarrayobrigatório

Uma regra por sub-lojista. Pelo menos uma; sub-lojistas não podem se repetir.

subordinate_merchant_idstringobrigatório

Id do sub-lojista na Braspag (campo do cadastro do seller).

amountintegerobrigatório

Parte do seller em centavos, maior que zero.

faresobject

Taxas descontadas da parte do seller.

mdrinteger

Taxa de desconto do lojista em pontos-base, de 0 a 10000 (350 = 3,50%).

feeinteger

Tarifa fixa por transação em centavos, não negativa.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/braspag/payments/3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11/split-capture" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "splits": [
      {
        "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
        "amount": 7000,
        "fares": {
          "mdr": 350,
          "fee": 10
        }
      },
      {
        "subordinate_merchant_id": "c7a2d1bb-2222-4333-9444-555566667777",
        "amount": 3000,
        "fares": {
          "mdr": 350,
          "fee": 10
        }
      }
    ]
  }'

Resposta

200Capturado com split

json

{
  "payment_id": "3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11",
  "status": 2,
  "captured_amount": 10000,
  "split_payments": [
    {
      "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
      "amount": 7000,
      "fares": {
        "mdr": 350,
        "fee": 10
      }
    },
    {
      "subordinate_merchant_id": "c7a2d1bb-2222-4333-9444-555566667777",
      "amount": 3000,
      "fares": {
        "mdr": 350,
        "fee": 10
      }
    }
  ],
  "captured_at": "2026-10-11T15:00:00Z"
}

Campos da resposta

payment_idstring

GUID do pagamento.

statusinteger

Código de status do pagamento na Braspag (2 = pago/capturado).

captured_amountinteger

Total capturado em centavos.

split_paymentsarray

Divisão confirmada pela Braspag: subordinate_merchant_id, amount e fares.mdr/fares.fee.

captured_atstring

Momento da confirmação (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
400	Corpo não é um JSON válido.	`{"error":"invalid request body"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
422	Regra inválida ou falha na Braspag. A mensagem vem em inglês.	`{"error":"braspag: invalid split rules: split rule 1: amount must be positive (centavos)"}`

Consultar a divisão gravada

Lista as partes gravadas quando o pagamento foi capturado com split. Pagamento sem split devolve lista vazia.

GET/api/v1/admin/braspag/payments/{paymentId}/splitsAdmin

Consulta o split gravado

Parâmetros de caminho

paymentIduuidobrigatório

GUID do pagamento na Braspag.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/braspag/payments/3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11/splits" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Partes do split

json

[
  {
    "id": "0b1c2d3e-4f50-4a6b-8c7d-9e0f1a2b3c4d",
    "payment_id": "3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11",
    "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
    "vendor_id": "7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f",
    "amount": 7000,
    "mdr_rate": 350,
    "fee": 10,
    "net_amount": 6745,
    "created_at": "2026-10-11T15:00:00Z"
  }
]

Campos da resposta

amountinteger

Parte bruta em centavos.

mdr_rateinteger

Taxa em pontos-base.

feeinteger

Tarifa fixa em centavos.

net_amountinteger

Líquido do seller em centavos, depois de mdr_rate e fee.

vendor_iduuid

Seller na Venddor, quando o vínculo é conhecido.

iduuid

Id do registro.

payment_idstring

GUID do pagamento.

subordinate_merchant_idstring

Sub-lojista na Braspag.

created_atstring

Gravação (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
500	Falha ao ler.	`{"error":"failed to retrieve split payments"}`

Veja também

Braspag