Descrição

Esta rota permite consultar pagamentos específico, realizado pela conta Paytime, atualmente limitados a pagamentos de boletos bancários.

🔽
GET urlServidor/v1/marketplace/payments/id

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
x-token	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Path Params

Nome	Tipo	Obrigatório	Descrição
`id`	string	✅ Sim.	Identificador único do pagamento.

📤 Exemplo de Requisição

curl --location 'https://api.sandbox.paytime.com.br/v1/marketplace/payments/68fa6717335fe7e377c83322' \
--header 'integration-key: your-integration-key' \
--header 'x-token: your-x-token' \
--header 'Authorization: ••••••

✅ Exemplo de Resposta (200 - OK)

{
    "_id": "68fa6717335fe7e377c83322",
    "type": "BALANCE",
    "status": "PROCESSING",
    "barcode": "23793381286008301352856000063307789840000150000",
    "digitable_line": "23793381286008301352856000063307789840000150000",
    "expected_on": "2025-10-23T12:00:00.000Z",
    "amount": 150000,
    "nominal_amount": 150000,
    "discount": 0,
    "fine": 0,
    "interest": 0,
    "gateway_key": "20908ccd-dc73-4ac7-a949-189403887519",
    "document_number": "69844780144",
    "gateway_authorization": "CELCOIN",
    "payment_details": {
        "balance": 150000,
        "card": 0,
        "total": 150000,
        "fees": 0
    },
    "recipient": {
        "name": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
        "document": "87754347000108",
        "_id": "68fa6717335fe7e377c83323"
    },
    "billet_details": {
        "installments_paid": 0,
        "total_amount_paid": 0,
        "document_final_recipient": null,
        "final_recipient": null,
        "billet_type": "Boleto de Depósito e Aporte",
        "_id": "68fa6717335fe7e377c83324"
    },
    "establishment_id": "11299221000129",
    "user": {
        "id": 187,
        "first_name": "EC - API Integrações",
        "last_name": null,
        "profile_id": 1
    },
    "establishment": {
        "id": 155100,
        "type": "BUSINESS",
        "access_type": "ACQUIRER",
        "active": 1,
        "first_name": "Teste Sandbox",
        "last_name": "Solucoes",
        "document": "11299221000129"
    },
    "marketplace": {
        "id": 26,
        "type": "LICENSED",
        "nickname": "Parceiro Integrações",
        "active": 1,
        "first_name": "Webhooks Integrações",
        "last_name": "API Integrações",
        "document": "60274849000185"
    },
    "history": [
        {
            "status": "CREATED",
            "created_at": "2025-10-23T17:34:15.551Z",
            "_id": "68fa6717335fe7e377c83325"
        },
        {
            "status": "PROCESSING",
            "created_at": "2025-10-23T17:34:15.551Z",
            "_id": "68fa6717335fe7e377c83326"
        }
    ],
    "created_at": "2025-10-23T17:34:15.554Z",
    "updated_at": "2025-10-23T17:34:15.554Z"
}

Detalhes do Response

Consulte o detalhes do response na documentação Lista de Pagamentos

🔔 Observação Importante

Os pagamentos de boletos são processados via Banking Paytime.

Para acompanhar a evolução de status, é essencial consumir os webhooks relacionados, como updated-billet-status.

A resposta desta rota serve para consultas e conciliação dos pagamentos já registrados no sistema.