Pular para o conteúdo principal

Consultar 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 retornar os dados e o status atual do pagamento gerado por um link. Confirme o status paid antes de liberar o pedido.

GETv3/biometric_pix/links/:link_id/payment

Request Variable Path​

AtributoTipoDescrição
link_idstringID Marlim do link de pagamento.

Response Object​

PropriedadeTipoDescrição
payment_idstringID Marlim do pagamento. É com ele que você cancela o pagamento.
link_idstringID Marlim do link de pagamento.
item_idstringID do link na sua plataforma.
current_statusstringStatus atual do pagamento.

Valores possíveis: pending, awaiting_authorization, authorized, processing, paid, rejected, canceled, expired e error. Veja Status do Pagamento.
amountint32Valor do pagamento em centavos.
descriptionstringDescrição enviada na criação do link.
methodstringForma de recebimento enviada na criação do link.
customerobjectObjeto Pagador.
customer[name]stringNome do pagador.
customer[document_number]stringCPF ou CNPJ do pagador.
participantobjectBanco escolhido pelo cliente. Retorna null enquanto o cliente não escolher.
participant[participant_id]stringID do banco do cliente.
participant[name]stringNome do banco do cliente.
end_to_end_idstringIdentificador da transação Pix no Banco Central. Preenchido quando o pagamento é liquidado.
errorobjectPreenchido quando o current_status é rejected ou error. Retorna null nos demais casos.
error[code]stringCódigo do erro. Veja Rejeições de Pagamento.
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 pagamento no formato ISODateTime.
date_updateddateTimeData 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/biometric_pix/links/bIo6Lm3NqZ8tRw1YcV5k/payment" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
Response200
{
"payment_id": "pMt9Ws4EdC7rFv2TgB6y",
"link_id": "bIo6Lm3NqZ8tRw1YcV5k",
"item_id": "PEDIDO_1138",
"current_status": "paid",
"amount": 8990,
"description": "Pedido 1138 Cantina Mos Eisley",
"method": "default_account",
"customer": {
"name": "Han Solo",
"document_number": "00077766655"
},
"participant": {
"participant_id": "c8f0bf49-4744-4933-8960-7add6e590841",
"name": "Banco da Aliança"
},
"end_to_end_id": "E12345678202611161420abcdef67890",
"error": null,
"metadata": {
"canal": "app"
},
"date_created": "2026-11-16T14:19:52.000Z",
"date_updated": "2026-11-16T14:20:31.207Z"
}