Atualizar instrução

curl --location --request PATCH 'https://apisandbox.delbank.com.br/baas/api/v1/split-payments/configurations/15/beneficiaries/18' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "type": "PERCENTAGE",
    "amount": 3
}'

{
  "id": 15,
  "bankAccountNumber": "CONTA_PAGADORA",
  "createdAt": "2025-09-19T20:04:38.112Z",
  "updatedAt": "2025-09-19T20:15:00.000Z",
  "instructions": [
    {
      "id": 18,
      "splitPaymentConfigurationId": 15,
      "amount": 3,
      "type": "PERCENTAGE",
      "transferType": "INTERNAL",
      "beneficiary": {
        "number": "654321",
        "branch": "0001",
        "participantIspb": "12345678",
        "type": "PAYMENT",
        "holder": {
          "document": "12345678901",
          "name": "Nome do Beneficiário",
          "email": null,
          "phoneNumber": null,
          "type": "NATURAL"
        }
      }
    }
  ]
}

PATCH

baas

api

split-payments

configurations

{splitPaymentId}

beneficiaries

{splitPaymentBeneficiaryId}

curl --location --request PATCH 'https://apisandbox.delbank.com.br/baas/api/v1/split-payments/configurations/15/beneficiaries/18' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "type": "PERCENTAGE",
    "amount": 3
}'

{
  "id": 15,
  "bankAccountNumber": "CONTA_PAGADORA",
  "createdAt": "2025-09-19T20:04:38.112Z",
  "updatedAt": "2025-09-19T20:15:00.000Z",
  "instructions": [
    {
      "id": 18,
      "splitPaymentConfigurationId": 15,
      "amount": 3,
      "type": "PERCENTAGE",
      "transferType": "INTERNAL",
      "beneficiary": {
        "number": "654321",
        "branch": "0001",
        "participantIspb": "12345678",
        "type": "PAYMENT",
        "holder": {
          "document": "12345678901",
          "name": "Nome do Beneficiário",
          "email": null,
          "phoneNumber": null,
          "type": "NATURAL"
        }
      }
    }
  ]
}

Para o passo a passo completo, veja o guia Configurar Split de Pagamentos.

Atualiza a regra de uma instrução já cadastrada em uma configuração de Split de Pagamento. Os dados do beneficiário (transferType e beneficiary) não são alterados por este endpoint.

Headers

string

required

Sua API key.

string

required

Número da conta Delfinance.

Path

string

required

ID da configuração de Split de Pagamento.

string

required

ID da instrução que terá a regra atualizada.

Body

string

required

Como o amount é calculado. Valores aceitos:

PERCENTAGE: o valor é calculado como uma porcentagem do valor total da transação. O percentual máximo permitido é 5%.
FIXED: o valor é absoluto e fixo. Se o valor definido exceder 50% do valor da transação, o split não é realizado.

number

required

Valor a ser aplicado, conforme o type selecionado.

Response

number

Identificador único da configuração de split.

string

Data/hora de criação em ISO 8601.

string

Data/hora da última atualização em ISO 8601.

array

Lista atualizada de instruções da configuração, com a regra alterada.

curl --location --request PATCH 'https://apisandbox.delbank.com.br/baas/api/v1/split-payments/configurations/15/beneficiaries/18' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "type": "PERCENTAGE",
    "amount": 3
}'

{
  "id": 15,
  "bankAccountNumber": "CONTA_PAGADORA",
  "createdAt": "2025-09-19T20:04:38.112Z",
  "updatedAt": "2025-09-19T20:15:00.000Z",
  "instructions": [
    {
      "id": 18,
      "splitPaymentConfigurationId": 15,
      "amount": 3,
      "type": "PERCENTAGE",
      "transferType": "INTERNAL",
      "beneficiary": {
        "number": "654321",
        "branch": "0001",
        "participantIspb": "12345678",
        "type": "PAYMENT",
        "holder": {
          "document": "12345678901",
          "name": "Nome do Beneficiário",
          "email": null,
          "phoneNumber": null,
          "type": "NATURAL"
        }
      }
    }
  ]
}

Adicionar instrução Remover configuração de Split

Introdução

Pix

Boleto

Split de Pagamentos

Webhooks

Atualizar instrução

Headers

Path

Body

Response

​Headers

​Path

​Body

​Response

Headers

Path

Body

Response