Pular para o conteúdo principal

Listar Pagamentos

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 todos os pagamentos de um link, um para cada data do agendamento, com o status de cada um.

GETv3/scheduled_pix/links/:link_id/payments

Request Variable Path​

AtributoTipoDescrição
link_idstringID Marlim do link de pagamento.

Response Object​

PropriedadeTipoDescrição
link_idstringID Marlim do link de pagamento.
paymentsarrayArray com os pagamentos do agendamento, em ordem de data.
payments[][payment_id]stringID Marlim do pagamento. É com ele que você cancela uma data.
payments[][link_id]stringID Marlim do link de pagamento.
payments[][item_id]stringID do link na sua plataforma.
payments[][current_status]stringStatus atual do pagamento.

Valores possíveis: pending, awaiting_authorization, authorized, scheduled, processing, paid, rejected, canceled e expired. Veja Status do Pagamento.
payments[][date]dateData de liquidação no formato YYYY-MM-DD.
payments[][amount]int32Valor do pagamento em centavos.
payments[][description]stringDescrição enviada na criação do link.
payments[][customer]objectObjeto Pagador.
payments[][customer][name]stringNome do pagador.
payments[][customer][document_number]stringCPF ou CNPJ do pagador.
payments[][participant]objectBanco escolhido pelo cliente. Retorna null enquanto o cliente não escolher.
payments[][participant][participant_id]stringID do banco do cliente.
payments[][participant][name]stringNome do banco do cliente.
payments[][end_to_end_id]stringIdentificador da transação Pix no Banco Central. Preenchido quando o pagamento é liquidado.
payments[][error]objectPreenchido quando o current_status é rejected. Retorna null nos demais casos.
payments[][error][code]stringCódigo do erro. Veja Rejeições de Pagamento.
payments[][error][title]stringTítulo do erro.
payments[][error][detail]stringDetalhe do erro, em texto livre.
payments[][metadata]objectObjeto livre enviado na criação do link.
payments[][date_created]dateTimeData de criação do pagamento no formato ISODateTime.
payments[][date_updated]dateTimeData de atualização do pagamento no formato ISODateTime.

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/payments" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
Response200
{
"link_id": "sKd4Wp7RtY2nQm9XbC3v",
"payments": [
{
"payment_id": "pAy1Mn6BvC3xZq8WeR4t",
"link_id": "sKd4Wp7RtY2nQm9XbC3v",
"item_id": "CURSO_PILOTAGEM_00321",
"current_status": "paid",
"date": "2026-12-10",
"amount": 25000,
"description": "Curso de Pilotagem 3x",
"customer": {
"name": "Luke Skywalker",
"document_number": "00099988877"
},
"participant": {
"participant_id": "c8f0bf49-4744-4933-8960-7add6e590841",
"name": "Banco da Aliança"
},
"end_to_end_id": "E12345678202612100612abcdef12345",
"error": null,
"metadata": {
"turma": "2027A"
},
"date_created": "2026-11-16T14:23:02.410Z",
"date_updated": "2026-12-10T06:12:44.000Z"
},
{
"payment_id": "pAy2Kj9HgF5dSa1QwE7u",
"link_id": "sKd4Wp7RtY2nQm9XbC3v",
"item_id": "CURSO_PILOTAGEM_00321",
"current_status": "scheduled",
"date": "2027-01-10",
"amount": 25000,
"description": "Curso de Pilotagem 3x",
"customer": {
"name": "Luke Skywalker",
"document_number": "00099988877"
},
"participant": {
"participant_id": "c8f0bf49-4744-4933-8960-7add6e590841",
"name": "Banco da Aliança"
},
"end_to_end_id": null,
"error": null,
"metadata": {
"turma": "2027A"
},
"date_created": "2026-11-16T14:23:02.410Z",
"date_updated": "2026-11-16T14:23:02.410Z"
},
{
"payment_id": "pAy3Pl4OkI7uJy2HtG9r",
"link_id": "sKd4Wp7RtY2nQm9XbC3v",
"item_id": "CURSO_PILOTAGEM_00321",
"current_status": "scheduled",
"date": "2027-02-10",
"amount": 25000,
"description": "Curso de Pilotagem 3x",
"customer": {
"name": "Luke Skywalker",
"document_number": "00099988877"
},
"participant": {
"participant_id": "c8f0bf49-4744-4933-8960-7add6e590841",
"name": "Banco da Aliança"
},
"end_to_end_id": null,
"error": null,
"metadata": {
"turma": "2027A"
},
"date_created": "2026-11-16T14:23:02.410Z",
"date_updated": "2026-11-16T14:23:02.410Z"
}
]
}