Cancelar Link de 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 invalidar um link de pagamento que ainda não foi pago. Depois do cancelamento, o cliente não consegue mais pagar por esse link.
POSTv3/biometric_pix/links/:link_id/cancel
Importante
Depois que o pagamento é iniciado, o link não pode mais ser cancelado. Para interromper um pagamento ainda não liquidado, use Cancelar Pagamento.
Request Variable Path
| Atributo | Tipo | Descrição |
|---|---|---|
| link_id | string | ID Marlim do link de pagamento. |
Response Object
Retorna o link com os mesmos campos de Consultar Link, 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
- Link cancelado
- Link já pago
- Link não encontrado
curl -X POST "https://sandbox.api.marlim.co/v3/biometric_pix/links/mNb5Vc2XzL8kJh4GfD1s/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"link_id": "mNb5Vc2XzL8kJh4GfD1s",
"item_id": "PEDIDO_1140",
"current_status": "canceled",
"payment_url": "https://checkout.marlim.co/biometric-pix/mNb5Vc2XzL8kJh4GfD1s",
"error": null,
"metadata": {},
"date_created": "2026-11-16T15:02:10.000Z",
"date_updated": "2026-11-16T15:05:12.300Z",
"expires_at": "2026-11-16T16:02:10.000Z"
}
curl -X POST "https://sandbox.api.marlim.co/v3/biometric_pix/links/bIo6Lm3NqZ8tRw1YcV5k/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"errors": [
{
"type": "status",
"message": "Only links with created or processing status can be canceled."
}
]
}
curl -X POST "https://sandbox.api.marlim.co/v3/biometric_pix/links/AABBCCDD/cancel" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"errors": [
{
"type": "not_found",
"message": "Link with id [AABBCCDD] was not found"
}
]
}