Este endpoint permite cancelar uma transação agendada elegível por meio do payout_id e do transaction_id retornados na criação do payout. Apenas transações que ainda não foram processadas e estejam com status=pending ou status=in_process podem ser canceladas, e o cancelamento é irreversível. A solicitação de cancelamento deve ser enviada com, no mínimo, 12 horas de antecedência em relação à data e hora programadas para execução. Em caso de sucesso, a requisição retorna o status 204.
PUT
OBRIGATÓRIO
OBRIGATÓRIO
OBRIGATÓRIO CONDICIONAL
OBRIGATÓRIO CONDICIONAL
boolean que indica se o integrador enviará ou não a assinatura. Deve ser false para ambiente de teste, true para ambiente produtivo, que é quando é obrigatório o envio da assinatura.OBRIGATÓRIO
id da resposta a POST /v1/payouts.OBRIGATÓRIO
transactions[].id da resposta a POST /v1/payouts.400Requisição inválida. Os parâmetros enviados não são válidos.
invalid_payout_id
Dados inválidos foram enviados no body da requisição. O payout não foi encontrado. Tente enviar a solicitação novamente, validando todos os campos.
invalid_transaction_id
Dados inválidos foram enviados no body da requisição. A transação não foi encontrada. Tente enviar a solicitação novamente, validando todos os campos.
invalid_signature
Dados inválidos foram enviados no body da requisição. Verifique se a secret foi gerada corretamente e está registrada com o Mercado Pago. Verifique também se o body que está enviando é o que foi criptografado.
idempotency_key_required
Dados inválidos foram enviados no body da requisição. A chave de idempotência (idempotency_key) está ausente. Tente enviar a solicitação novamente, validando todos os campos.
invalid_account
O objeto `account` foi enviado sem os dados obrigatórios para identificar a conta de destino. Informe `email` para uma conta Mercado Pago ou os dados bancários obrigatórios de uma conta externa, incluindo `number` e `bank_id`. Para uma transferência via Pix, defina `transactions.type` como `pix` e envie os dados da chave em `transactions.pix` em vez de `account`.
invalid_account_type
O campo account_type foi enviado com um valor não suportado. Os valores aceitos são checking_account ou savings.
401Erro. Access Token não autorizado.
invalid_token
O Access Token enviado está incorreto. Revise o valor e tente enviar a requisição novamente com a informação correta.
403Proibido. Não tem permissões para acessar este recurso.
forbidden
Sem permissão para acessar o recurso.
404Erro. Payout não encontrado.
not_found
Payout não encontrado. Verifique se o ID enviado está correto.
412Pré-condição não atendida. O status da transação não permite cancelamento.
precondition_failed
O status da transação não permite o seu cancelamento. Apenas transações com status=pending ou status=in_process podem ser canceladas.
500Erro interno do servidor.
internal_server_error
Ocorreu um erro inesperado no servidor. Tente enviar a requisição novamente.
502Erro de gateway. Falha na integração com um serviço externo.
bad_gateway
Ocorreu um erro na integração com um serviço externo. Tente enviar a requisição novamente.
curl -X PUT \
'https://api.mercadopago.com/v1/payouts/{payout_id}/transactions/{transaction_id}/cancel'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer APP_USR-8*********88776-122*********fc20dede6*********a497d7225*********64' \
-H 'X-Idempotency-Key: 4beec47a-5d5a-43ec-9598-fdbbc823ae01' \
-H 'X-signature: true' \
-H 'X-enforce-signature: false' \
-H 'X-test-token: false' \
-d '{
"comments": "delete because the payment was canceled",
"deleted_by": "user_123"
}'