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
| Atributo | Tipo | Descrição |
|---|---|---|
| link_id | string | ID Marlim do link de pagamento. |
Response Object
| Propriedade | Tipo | Descrição |
|---|---|---|
| payment_id | string | ID Marlim do pagamento. É com ele que você cancela o pagamento. |
| link_id | string | ID Marlim do link de pagamento. |
| item_id | string | ID do link na sua plataforma. |
| current_status | string | Status atual do pagamento. Valores possíveis: pending, awaiting_authorization, authorized, processing, paid, rejected, canceled, expired e error. Veja Status do Pagamento. |
| amount | int32 | Valor do pagamento em centavos. |
| description | string | Descrição enviada na criação do link. |
| method | string | Forma de recebimento enviada na criação do link. |
| customer | object | Objeto Pagador. |
| customer[name] | string | Nome do pagador. |
| customer[document_number] | string | CPF ou CNPJ do pagador. |
| participant | object | Banco escolhido pelo cliente. Retorna null enquanto o cliente não escolher. |
| participant[participant_id] | string | ID do banco do cliente. |
| participant[name] | string | Nome do banco do cliente. |
| end_to_end_id | string | Identificador da transação Pix no Banco Central. Preenchido quando o pagamento é liquidado. |
| error | object | Preenchido quando o current_status é rejected ou error. Retorna null nos demais casos. |
| error[code] | string | Código do erro. Veja Rejeições de Pagamento. |
| 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 pagamento no formato ISODateTime. |
| 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
- Pagamento pago
- Pagamento recusado
- Pagamento não iniciado
- Link não encontrado
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 '{}'
{
"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"
}
curl -X GET "https://sandbox.api.marlim.co/v3/biometric_pix/links/qAz3Ws8XeD1cRf6VtG4b/payment" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"payment_id": "pMt4Hn7UjM2kIo9LpQ3a",
"link_id": "qAz3Ws8XeD1cRf6VtG4b",
"item_id": "PEDIDO_1141",
"current_status": "rejected",
"amount": 15000,
"description": "Pedido 1141 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": null,
"error": {
"code": "refused_by_bank",
"title": "Payment refused",
"detail": "Payment refused by the account holding institution."
},
"metadata": {},
"date_created": "2026-11-16T18:02:11.000Z",
"date_updated": "2026-11-16T18:02:19.540Z"
}
curl -X GET "https://sandbox.api.marlim.co/v3/biometric_pix/links/mNb5Vc2XzL8kJh4GfD1s/payment" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"errors": [
{
"type": "not_found",
"message": "Payment for link with id [mNb5Vc2XzL8kJh4GfD1s] was not found"
}
]
}
curl -X GET "https://sandbox.api.marlim.co/v3/biometric_pix/links/AABBCCDD/payment" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"errors": [
{
"type": "not_found",
"message": "Link with id [AABBCCDD] was not found"
}
]
}