🔼
GET urlServidor/v1/marketplace/payments/id

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

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

Exemplo de header da requisição

curl--request GET\
--location 'urlServidor/v1/marketplace/banking/payments/id' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Path

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do pagamento a ser exibida

Modelo response

{
    "_id": "69e0e4712ac87eab7c82ca0f",
    "type": "BALANCE",
    "status": "PROCESSING",
    "barcode": "23793381286008301352856000063307789840000150000",
    "digitable_line": "23793381286008301352856000063307789840000150000",
    "expected_on": "2026-04-16T12:00:00.000Z",
    "amount": 10,
    "nominal_amount": 150000,
    "discount": 0,
    "fine": 0,
    "interest": 0,
    "gateway_key": "8fdc5edb-c3db-4ad3-9b21-f6b55b0b7138",
    "document_number": "69844780144",
    "gateway_authorization": "CELCOIN",
    "payment_details": {
        "balance": 10,
        "card": 0,
        "total": 10,
        "fees": 0
    },
    "recipient": {
        "name": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
        "document": "87754347000108",
        "_id": "69e0e4712ac87eab7c82ca10"
    },
    "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": "69e0e4712ac87eab7c82ca11"
    },
    "establishment_id": "155100",
    "user": {
        "id": 187,
        "first_name": "EC - API Integrações",
        "last_name": null,
        "profile_id": 1
    },
    "establishment": {
        "id": 155100,
        "type": "BUSINESS",
        "access_type": "ACQUIRER",
        "active": true,
        "first_name": "Teste Sandbox",
        "last_name": "Solucoes",
        "document": "11299221000129"
    },
    "marketplace": {
        "id": 26,
        "type": "LICENSED",
        "nickname": "Parceiro Integrações",
        "active": true,
        "first_name": "Webhooks Integrações",
        "last_name": "API Integrações",
        "document": "60274849000185"
    },
    "history": [
        {
            "status": "CREATED",
            "created_at": "2026-04-16T13:30:25.874Z",
            "_id": "69e0e4712ac87eab7c82ca12"
        },
        {
            "status": "PROCESSING",
            "created_at": "2026-04-16T13:30:25.874Z",
            "_id": "69e0e4712ac87eab7c82ca13"
        }
    ],
    "created_at": "2026-04-16T13:30:25.881Z",
    "updated_at": "2026-04-16T13:30:25.881Z"
}

Detalhe do response

Objeto principal

Campo	Tipo	Obrigatório	Descrição
`_id`	string	Sim	ID do pagamento.
`type`	string	Sim	Tipo do pagamento.
`status`	string	Sim	Status atual do pagamento.
`barcode`	string	Sim	Código de barras do boleto.
`digitable_line`	string	Sim	Linha digitável do boleto.
`expected_on`	date-time	Sim	Data prevista para pagamento.
`amount`	number	Sim	Valor líquido pago.
`nominal_amount`	number	Sim	Valor nominal do boleto.
`discount`	number	Sim	Valor de desconto aplicado.
`fine`	number	Sim	Valor de multa aplicado.
`interest`	number	Sim	Valor de juros aplicado.
`gateway_key`	string	Sim	Identificador do gateway que processou a transação.
`document_number`	string	Sim	Documento de referência do boleto.
`gateway_authorization`	string	Sim	Nome do gateway responsável pelo processamento.
`establishment_id`	string	Sim	ID do estabelecimento.
`reprocessed`	boolean	Sim	Indica se o pagamento foi reprocessado.
`created_at`	date-time	Sim	Data de criação do pagamento.
`updated_at`	date-time	Sim	Data da última atualização.
`payment_date`	date-time	Sim	Data de liquidação do pagamento.

payment_details

Campo	Tipo	Obrigatório	Descrição
`balance`	number	Sim	Valor pago com saldo.
`card`	number	Sim	Valor pago com cartão.
`total`	number	Sim	Valor total pago.
`fees`	number	Sim	Taxa aplicada quando pago com cartão.

recipient

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do beneficiário do boleto.
`document`	string	Sim	Documento do beneficiário.
`_id`	string	Sim	ID interno do beneficiário.

billet_details

Campo	Tipo	Obrigatório	Descrição
`installments_paid`	number	Sim	Quantidade de parcelas pagas.
`total_amount_paid`	number	Sim	Valor total já pago.
`document_final_recipient`	string	Sim	Documento do destinatário final.
`final_recipient`	string	Sim	Nome do destinatário final.
`billet_type`	string	Sim	Tipo do boleto.
`_id`	string	Sim	ID interno dos detalhes do boleto.

user

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	ID do usuário que realizou o pagamento.
`first_name`	string	Sim	Primeiro nome do usuário.
`last_name`	string	Sim	Sobrenome do usuário
`profile_id`	number	Sim	ID do perfil do usuário.

history

Histórico de mudança de status.

Campo	Tipo	Obrigatório	Descrição
`status`	string	Sim	Status atribuído ao pagamento.
`created_at`	date-time	Sim	Data/hora da alteração de status.
`_id`	string	Sim	ID do histórico.

Status possíveis

Status	Descrição
`PENDING`	Pagamento aguardando processamento.
`PROCESSING`	Pagamento em processamento.
`PAID`	Pagamento confirmado.
`REFUNDED`	Pagamento estornado.
`CANCELED`	Pagamento cancelado.

Códigos de resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.