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
| Atributo | Tipo | Descrição |
|---|---|---|
| link_id | string | ID Marlim do link de pagamento. |
Response Object
| Propriedade | Tipo | Descrição |
|---|---|---|
| link_id | string | ID Marlim do link de pagamento. |
| payments | array | Array com os pagamentos do agendamento, em ordem de data. |
| payments[][payment_id] | string | ID Marlim do pagamento. É com ele que você cancela uma data. |
| payments[][link_id] | string | ID Marlim do link de pagamento. |
| payments[][item_id] | string | ID do link na sua plataforma. |
| payments[][current_status] | string | Status atual do pagamento. Valores possíveis: pending, awaiting_authorization, authorized, scheduled, processing, paid, rejected, canceled e expired. Veja Status do Pagamento. |
| payments[][date] | date | Data de liquidação no formato YYYY-MM-DD. |
| payments[][amount] | int32 | Valor do pagamento em centavos. |
| payments[][description] | string | Descrição enviada na criação do link. |
| payments[][customer] | object | Objeto Pagador. |
| payments[][customer][name] | string | Nome do pagador. |
| payments[][customer][document_number] | string | CPF ou CNPJ do pagador. |
| payments[][participant] | object | Banco escolhido pelo cliente. Retorna null enquanto o cliente não escolher. |
| payments[][participant][participant_id] | string | ID do banco do cliente. |
| payments[][participant][name] | string | Nome do banco do cliente. |
| payments[][end_to_end_id] | string | Identificador da transação Pix no Banco Central. Preenchido quando o pagamento é liquidado. |
| payments[][error] | object | Preenchido quando o current_status é rejected. Retorna null nos demais casos. |
| payments[][error][code] | string | Código do erro. Veja Rejeições de Pagamento. |
| payments[][error][title] | string | Título do erro. |
| payments[][error][detail] | string | Detalhe do erro, em texto livre. |
| payments[][metadata] | object | Objeto livre enviado na criação do link. |
| payments[][date_created] | dateTime | Data de criação do pagamento no formato ISODateTime. |
| payments[][date_updated] | dateTime | Data de atualização do pagamento no formato ISODateTime. |
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 encontrados
- Pagamento recusado
- Link não encontrado
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 '{}'
{
"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"
}
]
}
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 '{}'
{
"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": "rejected",
"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": {
"code": "insufficient_balance",
"title": "Insufficient balance",
"detail": "The customer's account does not have enough balance."
},
"metadata": {
"turma": "2027A"
},
"date_created": "2026-11-16T14:23:02.410Z",
"date_updated": "2027-01-10T18:00:12.000Z"
},
{
"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"
}
]
}
curl -X GET "https://sandbox.api.marlim.co/v3/scheduled_pix/links/AABBCCDD/payments" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"errors": [
{
"type": "not_found",
"message": "Link with id [AABBCCDD] was not found"
}
]
}