Cancelar Pagamento
Disponível apenas em Sandbox
Este endpoint está disponível somente no ambiente Sandbox. Não há suporte para Pix por Biometria em produção no momento.
O Pix por Biometria não está disponível para todas as contas e depende de habilitação prévia pela Marlim. Para verificar a elegibilidade da sua conta, entre em contato com o nosso time comercial.
Use esta rota para cancelar um pagamento que ainda não foi enviado para liquidação, por exemplo quando o pedido foi desfeito antes da confirmação do cliente.
POSTv3/biometric_pix/payments/:payment_id/cancel
Importante
Só é possível cancelar pagamentos em pending, awaiting_authorization ou authorized. Em processing ou paid, o pagamento não pode mais ser cancelado.
Request Variable Path
| Atributo | Tipo | Descrição |
|---|---|---|
| payment_id | string | ID Marlim do pagamento. |
Response Object
Retorna o pagamento com os mesmos campos de Consultar Pagamento, com current_status igual a canceled.
Error Object
| Atributo | Tipo | Descrição |
|---|---|---|
| errors | array | Array com todos os erros encontrados ao processar a requisição. |
| errors[][type] | string | Tipo de erro ocorrido. |
| errors[][message] | string | Mensagem detalhada do erro ocorrido. |
Exemplos
- Pagamento cancelado
- Pagamento já liquidado
- Pagamento não encontrado
curl -X POST "https://sandbox.api.marlim.co/v3/biometric_pix/payments/pMt6Yh3NbV8cXz1LkJ5g/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"payment_id": "pMt6Yh3NbV8cXz1LkJ5g",
"link_id": "wEr4Ty7UiO1pAs5DfG8h",
"item_id": "PEDIDO_1142",
"current_status": "canceled",
"amount": 3200,
"description": "Pedido 1142 Cantina Mos Eisley",
"method": "default_account",
"customer": {
"name": "Han Solo",
"document_number": "00077766655"
},
"participant": {
"participant_id": "c8f0bf49-4744-4933-8960-7add6e590841",
"name": "Banco da Aliança"
},
"end_to_end_id": null,
"error": null,
"metadata": {},
"date_created": "2026-11-16T19:10:04.000Z",
"date_updated": "2026-11-16T19:11:30.000Z"
}
curl -X POST "https://sandbox.api.marlim.co/v3/biometric_pix/payments/pMt9Ws4EdC7rFv2TgB6y/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"errors": [
{
"type": "status",
"message": "Only payments with pending, awaiting_authorization or authorized status can be canceled."
}
]
}
curl -X POST "https://sandbox.api.marlim.co/v3/biometric_pix/payments/AABBCCDD/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"errors": [
{
"type": "not_found",
"message": "Payment with id [AABBCCDD] was not found"
}
]
}