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
| Atributo | Tipo | Descrição |
|---|---|---|
| link_id | string | ID 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
| Propriedade | Tipo | Descrição |
|---|---|---|
| link_id | string | ID Marlim do link de pagamento. |
| item_id | string | ID do link na sua plataforma. |
| current_status | string | Status atual do link. Valores possíveis: created, processing, payment_pending, completed, canceled, expired e error. Veja Status do Link. |
| payment_url | string | URL da jornada de pagamento. |
| error | object | Preenchido quando o current_status é error. Retorna null nos demais casos. |
| error[code] | string | Código do erro. Veja Rejeições da Aprovação. |
| error[title] | string | Título do erro. |
| error[detail] | string | Detalhe do erro, em texto livre. |
| metadata | object | Objeto livre enviado na criação do link. |
| date_created | dateTime | Data de criação do link no formato ISODateTime. |
| date_updated | dateTime | Data de atualização do link no formato ISODateTime. |
| expires_at | dateTime | Data 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
| 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
- Pagamentos agendados
- Aprovação recusada
- Link não encontrado
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 '{}'
{
"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"
}
curl -X GET "https://sandbox.api.marlim.co/v3/scheduled_pix/links/vBn2Qw8ErT5yUi1OpL6k" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"link_id": "vBn2Qw8ErT5yUi1OpL6k",
"item_id": "RESERVA_ENDOR_0042",
"current_status": "error",
"payment_url": "https://checkout.marlim.co/scheduled-pix/vBn2Qw8ErT5yUi1OpL6k",
"error": {
"code": "rejected_by_customer",
"title": "Rejected by customer",
"detail": "The customer rejected the payment at the bank."
},
"metadata": {},
"date_created": "2026-11-16T15:30:00.000Z",
"date_updated": "2026-11-16T15:34:51.000Z",
"expires_at": "2026-11-17T15:30:00.000Z"
}
curl -X GET "https://sandbox.api.marlim.co/v3/scheduled_pix/links/AABBCCDD" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"errors": [
{
"type": "not_found",
"message": "Link with id [AABBCCDD] was not found"
}
]
}