curl --request PATCH \
--url 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts/cancel' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--data '{
"splitPayoutId": 98765,
"reason": "Solicitação do cliente",
"canceledBy": "Nome ou identificação do solicitante"
}'
Accepted
{
"title": "Please refer to the errors property for additional details.",
"status": 422,
"errors": [
"SplitPayout não encontrado ou não pode ser cancelado."
]
}
Split de Pagamentos
Cancelar payout
Solicite o cancelamento de um payout agendado ou em erro.
PATCH
/
baas
/
api
/
v1
/
split-payments
/
payouts
/
cancel
curl --request PATCH \
--url 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts/cancel' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--data '{
"splitPayoutId": 98765,
"reason": "Solicitação do cliente",
"canceledBy": "Nome ou identificação do solicitante"
}'
Accepted
{
"title": "Please refer to the errors property for additional details.",
"status": 422,
"errors": [
"SplitPayout não encontrado ou não pode ser cancelado."
]
}
Para o contexto completo, veja o guia Ordens de Split de Pagamentos.
SCHEDULED ou ERROR.
Headers
string
required
Sua API key.
Body
number
required
Identificador do payout a ser cancelado.
string
Motivo do cancelamento registrado pela operação.
string
Nome ou identificação da pessoa que solicitou o cancelamento. Se não informado, a API registra
Não informado.Response
Em caso de sucesso, a API retorna202 Accepted e o payout passa a ser tratado como cancelado. A confirmação final do estado deve ser verificada em GET /api/v1/external/split-payments/payouts.
curl --request PATCH \
--url 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts/cancel' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--data '{
"splitPayoutId": 98765,
"reason": "Solicitação do cliente",
"canceledBy": "Nome ou identificação do solicitante"
}'
Accepted
{
"title": "Please refer to the errors property for additional details.",
"status": 422,
"errors": [
"SplitPayout não encontrado ou não pode ser cancelado."
]
}