Exibir Transação

🔽
GET urlServidor/v1/marketplace/transactions/{id}

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

Headers obrigatórios

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, na guia de integração da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Parâmetros de Path

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

Exemplo de header da requisição

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

Resposta

Em caso de sucesso, a API retornará um status 200 e o seguinte objeto JSON:

Exemplo de Resposta de Transação do tipo Crédito:

{
    "_id": "6839f1aeb5567b9f32ba1a",
    "status": "PAID",
    "amount": 14005,
    "original_amount": 14295,
    "fees": 290,
    "type": "CREDIT",
    "gateway_key": "492001a9-be2d-4687-8e75-722ae6f479d4",
    "gateway_authorization": "PAYTIME",
    "card": {
        "brand_name": "MASTERCARD",
        "first4_digits": "5200",
        "last4_digits": "1005",
        "expiration_month": "12",
        "expiration_year": "2026",
        "holder_name": "JOÃO DA SILVA",
        "bin": "520000",
        "_id": "6839f1aeb5567b9f32ba195a"
    },
    "installments": 10,
    "customer": {
        "first_name": "João",
        "last_name": "da Silva",
        "document": "1006811400",
        "phone": "319000000",
        "email": "[email protected]",
        "address": {
            "street": "Rua Maria dos Desenvolvedores",
            "number": "0101",
            "complement": "Debug",
            "neighborhood": "Bairro Deploy",
            "city": "Vitória",
            "state": "ES",
            "zip_code": "29000000"
        },
        "_id": "6839f1aeb5567b9f32ba195b"
    },
    "point_of_sale": {
        "type": "ONLINE",
        "identification_type": "API"
    },
    "acquirer": {
        "name": "PAGSEGURO",
        "acquirer_nsu": 123456789123,
        "gateway_key": "9381D5E0-0F50-436B-87E6-73D96F0A40EC",
        "mid": "100000000000002",
        "_id": "6839f1aeb5567b9f32ba19c9"
    },
    "expected_on": [
        {
            "date": "2025-06-30T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 1
        },
        {
            "date": "2025-07-29T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 2
        },
        {
            "date": "2025-08-28T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 3
        },
        {
            "date": "2025-09-29T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 4
        },
        {
            "date": "2025-10-27T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 5
        },
        {
            "date": "2025-11-26T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 6
        },
        {
            "date": "2025-12-26T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 7
        },
        {
            "date": "2026-01-26T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 8
        },
        {
            "date": "2026-02-24T12:00:00.198Z",
            "amount": 1400,
            "status": "PENDING",
            "installment": 9
        },
        {
            "date": "2026-03-26T12:00:00.198Z",
            "amount": 1405,
            "status": "PENDING",
            "installment": 10
        }
    ],
    "antifraud": [
        {
            "analyse_status": "APPROVED",
            "analyse_required": "CLEARSALE",
            "_id": "6839f1aeb5567b9f32ba1984"
        }
    ],
    "created_at": "2025-05-30T17:58:06.208Z"
}

🧾 Campos da Transação - `object`

Campo	Tipo	Obrigatório	Descrição
`_id`	string	Sim	Identificador único da transação.
`status`	string (enum)	Sim	Status atual da transação.CREATED, PENDING, APPROVED, PAID, FAILED, REFUNDED, DISPUTED, CANCELED, CHARGEBACK
`amount`	number	Sim	Valor líquido em centavos.
`original_amount`	number	Sim	Valor bruto em centavos.
`interest`	string (enum)	Sim	Define quem arca com as taxas.STORE: taxas cobradas do estabelecimento.CLIENT: taxas repassadas ao cliente.
`fees`	number	Sim	Valor total das taxas cobradas em centavos.
`installments`	number	Sim	Número de parcelas.
`type`	string (enum)	Sim	Tipo de transação.CREDIT, DEBIT, PIX
`gateway_authorization`	string (enum)	Sim	Subadquirente responsável pela transação.PAYTIME, ZOOP, PAGSEGURO
`created_at`	date-time	Sim	Data e hora de criação da transação.
`emv`	string	Não	EMV “copia e cola” utilizado em transações Pix.

📦 Plano - `plan`

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	Identificador do plano.
`allow_anticipation`	boolean	Sim	Indica se o plano permite antecipação.
`days_anticipation`	number (enum)	Sim	Dias da antecipação: 1 (D1), 14 (D14), 30 (D30)
`name`	string	Sim	Nome do plano.
`modality`	string (enum)	Sim	PHYSICAL, ONLINE, TAP_PHONE

🎴 Bandeira da Transação - `flag`

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	Identificador da bandeira.
`name`	string (enum)	Sim	MASTERCARD, VISA, ELO, AMERICAN EXPRESS, HIPERCARD, OTHERS, BACEN

🏪 Estabelecimento-`establishment`

Campo	Tipo	Obrigatório	Descrição
`first_name`	string	Sim	Nome fantasia ou nome do responsável.
`last_name`	string	Sim	Razão social.
`document`	string	Sim	CPF ou CNPJ.
`type`	string (enum)	Sim	INDIVIDUAL, BUSINESS
`access_type`	string (enum)	Sim	ACQUIRER, BANKING
`id`	number	Sim	Identificador do estabelecimento.

🛒 Marketplace - `marketplace`

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	Identificador do marketplace.
`type`	string (enum)	Sim	WHITELABEL, LICENSED, REPRESENTATIVE
`nickname`	string	Sim	Nome público.
`active`	boolean	Sim	Status ativo/inativo.
`first_name`	string	Sim	Nome fantasia.
`last_name`	string	Sim	Razão social.
`document`	string	Sim	CPF ou CNPJ.

🧑‍💼 Representante - representative

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	Identificador único do representante.
`marketplace_id`	number	Sim	ID do marketplace ao qual o representante está vinculado.
`active`	boolean	Sim	Indica se o representante está ativo.
`first_name`	string	Sim	Nome fantasia ou nome do responsável.
`last_name`	string	Sim	Razão social ou sobrenome.
`document`	string	Sim	CPF ou CNPJ do representante.

💳 Cartão - `card`

Campo	Tipo	Descrição
`brand_name`	string	Bandeira.
`first4_digits`	string	Primeiros 4 dígitos.
`last4_digits`	string	Últimos 4 dígitos.
`expiration_month`	string	Mês de expiração.
`expiration_year`	string	Ano de expiração.
`holder_name`	string	Nome do portador.
`token`	string	Token do cartão.

👤 Cliente - `customer`

Campo	Tipo	Obrigatório	Descrição
`first_name`	string	Sim	Nome completo ou razão social.
`last_name`	string	Não	Razão social (PJ).
`document`	string	Sim	CPF ou CNPJ.
`phone`	string	Não	Telefone.
`email`	string	Não	E-mail.

🏬 Ponto de Venda - `point_of_sale`

Campo	Tipo	Descrição
`type`	string (enum)	API, ONLINE, CHIP, TAP, SMART
`identification_type`	string (enum)	CHIP, CONTACTLESS, MAGNETIC
`identification_number`	string	Código de identificação.

🧾 Adquirente - `acquirer`

Campo	Tipo	Obrigatório	Descrição
`name`	string	Não	Nome do adquirente.
`acquirer_nsu`	number	Não	Número Sequencial Único (NSU) do adquirente.
`gateway_key`	string	Não	Identificador da transação no gateway/acquirer.
`mid`	string	Não	Merchant ID (identificação do estabelecimento no adquirente).
`_id`	string	Não	Identificador interno na adquirente.

📅 Expected On (Parcelas / Liquidação) - `expected_on`

Campo	Tipo	Descrição
`installment`	number	Número da parcela.
`date`	date-time	Data prevista de liquidação.
`paid_at`	date-time	Data de liquidação (se status = PAID).
`amount`	number	Valor da parcela (centavos).
`status`	string (enum)	PENDING, PAID, CANCELED, REFUNDED, FAILED

🛡️ Antifraude - `antifraud`

Campo	Tipo	Descrição
`analyse_required`	string (enum)	THREEDS, CLEARSALE, IDPAY
`analyse_status`	string (enum)	APPROVED, PROCESSING, WAITING_AUTH, FAILED, NO_ANALYSED
`antifraud_id`	string	ID da transação no antifraude.

💬 Resposta da Adquirente - `payment_response`

Campo	Tipo	Descrição
`code`	string	Código da adquirente.
`message`	string	Mensagem amigável (ABECS).
`reference`	string	NSU da autorização.
`authorization_code`	string	Código de autorização.
`nsu`	string	NSU único da transação.
`reason_code`	string	Código ABECS da recusada.
`info_additional`	array	Informações adicionais.

🔀 Split - `split`

Campo	Tipo	Descrição
`active`	boolean	Indica uso de split.
`is_origin`	boolean	Indica se é a transação original.
`processing`	boolean	Se há split pendente.
`initial_amount`	number	Valor original (se for origem).
`reference_id`	string	ID interno definido pelo cliente.

Observação

Transações aguardando autenticação do antifraude, não irão aparecer na listagem e detalhe da transação.

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.

GET urlServidor/v1/marketplace/transactions/{id}

Headers obrigatórios

Parâmetros de Path

Exemplo de header da requisição

Resposta

🧾 Campos da Transação - object

📦 Plano - plan

🎴 Bandeira da Transação - flag

🏪 Estabelecimento-establishment

🛒 Marketplace - marketplace

🧑‍💼 Representante - representative

💳 Cartão - card

👤 Cliente - customer

🏬 Ponto de Venda - point_of_sale

🧾 Adquirente - acquirer

📅 Expected On (Parcelas / Liquidação) - expected_on

🛡️ Antifraude - antifraud

💬 Resposta da Adquirente - payment_response

🔀 Split - split

Códigos de Resposta

GET `urlServidor/v1/marketplace/transactions/{id}`

🧾 Campos da Transação - `object`

📦 Plano - `plan`

🎴 Bandeira da Transação - `flag`

🏪 Estabelecimento-`establishment`

🛒 Marketplace - `marketplace`

💳 Cartão - `card`

👤 Cliente - `customer`

🏬 Ponto de Venda - `point_of_sale`

🧾 Adquirente - `acquirer`

📅 Expected On (Parcelas / Liquidação) - `expected_on`

🛡️ Antifraude - `antifraud`

💬 Resposta da Adquirente - `payment_response`

🔀 Split - `split`