Pular para o conteúdo principal

Consultar Link de Pagamento

Disponível apenas em Sandbox

Este endpoint está disponível somente no ambiente Sandbox. Não há suporte para Pix Agendado em produção no momento.

O Pix Agendado 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 retornar os dados e o status atual de um link de pagamento, como contingência aos webhooks ou para acompanhar a jornada do cliente.

GETv3/scheduled_pix/links/:link_id

Request Variable Path​

AtributoTipoDescrição
link_idstringID Marlim do link de pagamento.
Dica

Se precisar acompanhar a jornada sem webhook, consulte esta rota a cada 2 segundos enquanto o status for created ou processing, e pare assim que ele mudar.

Response Object​

PropriedadeTipoDescrição
link_idstringID Marlim do link de pagamento.
item_idstringID do link na sua plataforma.
current_statusstringStatus atual do link.

Valores possíveis: created, processing, payment_pending, completed, canceled, expired e error. Veja Status do Link.
payment_urlstringURL da jornada de pagamento.
errorobjectPreenchido quando o current_status é error. Retorna null nos demais casos.
error[code]stringCódigo do erro. Veja Rejeições da Aprovação.
error[title]stringTítulo do erro.
error[detail]stringDetalhe do erro, em texto livre.
metadataobjectObjeto livre enviado na criação do link.
date_createddateTimeData de criação do link no formato ISODateTime.
date_updateddateTimeData de atualização do link no formato ISODateTime.
expires_atdateTimeData de expiração do link no formato ISODateTime.
Importante

O status do link resume a jornada. Para saber a situação de cada data, use o Listar Pagamentos.

Error Object​

AtributoTipoDescrição
errorsarrayArray com todos os erros encontrados ao processar a requisição.
errors[][type]stringTipo de erro ocorrido.
errors[][message]stringMensagem detalhada do erro ocorrido.

Exemplos​

Request
curl -X GET "https://sandbox.api.marlim.co/v3/scheduled_pix/links/sKd4Wp7RtY2nQm9XbC3v" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
Response200
{
"link_id": "sKd4Wp7RtY2nQm9XbC3v",
"item_id": "CURSO_PILOTAGEM_00321",
"current_status": "payment_pending",
"payment_url": "https://checkout.marlim.co/scheduled-pix/sKd4Wp7RtY2nQm9XbC3v",
"error": null,
"metadata": {
"turma": "2027A"
},
"date_created": "2026-11-16T14:19:18.051Z",
"date_updated": "2026-11-16T14:23:02.410Z",
"expires_at": "2026-12-05T23:59:59.000Z"
}