---
title: "Realizar pagamento"
method: POST
path: "/v1/marketplace/banking/payments"
tags: ["Pagamentos de boletos"]
---

# Realizar pagamento

`POST /v1/marketplace/banking/payments`

## Request

- Base URL: `https://api.sandbox.paytime.com.br`
- URL: `https://api.sandbox.paytime.com.br/v1/marketplace/banking/payments`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/paytime/apis/api-p-blica/docs/v1/marketplace/banking/payments/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `mTLS` string, required
- `integration-key` string, required
- `x-token` string, required

## Request body

- CreatePaymentDto
  - `barcode` string, required: Código de barras.
  - `description` string: Descrição opcional do pagamento.
  - `amount` number: Valor do pagamento, caso diferente do nominal.

## Response `200`

- PaymentFindOneResponse
  - `_id` string, required: ID do pagamento.
  - `type` string, required: Tipo do pagamento.
  - `status` 'PAID' | 'PENDING' | 'PROCESSING' | 'REFUNDED' | 'CANCELED', required: Status atual do pagamento.
  - `barcode` string, required: Código de barras do boleto pago.
  - `digitable_line` string, required: Linha digitável do boleto pago.
  - `expected_on` string, date-time, required: Data prevista para pagamento.
  - `amount` number, required: Valor líquido.
  - `nominal_amount` number, required: Valor nominal do boleto.
  - `discount` number, required: Valor de desconto aplicado.
  - `fine` number, required: Valor de multa (mora) aplicado ao boleto.
  - `interest` number, required: Valor de juros aplicado ao boleto.
  - `gateway_key` string, required: Chave do gateway que processou o pagamento.
  - `document_number` string, required: Documento informado como referência no boleto.
  - `gateway_authorization` string, required: Nome do gateway responsável pelo processamento do boleto.
  - `payment_details` PaymentDetails, required
    - `balance` number, required: Valor pago com saldo.
    - `card` number, required: Valor pago com cartão.
    - `total` number, required: Valor total pago.
    - `fees` number, required: Valor da taxa aplicada quando pago com cartão.
  - `recipient` RecipientInfo, required
    - `name` string, required: Nome do beneficiário do boleto.
    - `document` string, required: Documento do beneficiário do boleto.
    - `_id` string, required: ID do beneficiário no banco de dados.
  - `billet_details` BilletDetails, required
    - `installments_paid` number, required: Quantidade de parcelas pagas.
    - `total_amount_paid` number, required: Valor total já pago.
    - `document_final_recipient` string, nullable, required: Documento do destinatário final do boleto.
    - `final_recipient` string, nullable, required: Nome do destinatário final do boleto.
    - `billet_type` string, required: Tipo do boleto.
    - `_id` string, required: ID dos detalhes do boleto.
  - `establishment_id` string, required: ID do estabelecimento.
  - `user` PaymentUser, required
    - `id` number, required: ID do usuário que realizou o pagamento.
    - `first_name` string, required: Primeiro nome do usuário.
    - `last_name` string, nullable, required: Último nome do usuário.
    - `profile_id` number, required: ID do perfil do usuário.
  - `establishment` EstablishmentPaymentInfo, required
    - `id` number, required: ID do estabelecimento.
    - `type` 'INDIVIDUAL' | 'BUSINESS', required: Tipo do estabelecimento.
    - `access_type` string, required: Tipo de acesso do estabelecimento.
    - `active` number, required: Indica se o estabelecimento está ativo.
    - `first_name` string, required: Nome / Razão social.
    - `last_name` string, required: Sobrenome / Nome fantasia.
    - `document` string, required: CPF / CNPJ.
  - `marketplace` MarketplacePaymentInfo, required
    - `id` number, required: ID do marketplace.
    - `type` 'WHITELABEL' | 'LICENSED' | 'REPRESENTATIVE', required: Tipo do marketplace.
    - `nickname` string, required: Apelido do marketplace.
    - `active` number, required: Indica se o marketplace está ativo.
    - `first_name` string, required: Nome / Razão social.
    - `last_name` string, required: Sobrenome / Nome fantasia.
    - `document` string, required: CPF / CNPJ.
  - `history` HistoryEntry[], required: Histórico de mudanças de status do pagamento.
    - `status` 'PAID' | 'PENDING' | 'PROCESSING' | 'REFUNDED' | 'CANCELED', required: Status atribuído ao pagamento.
    - `created_at` string, date-time, required: Data e hora em que o status foi registrado.
    - `_id` string, required: ID do histórico.
  - `reprocessed` boolean, required: Indica se o pagamento foi reprocessado.
  - `created_at` string, date-time, required: Data de criação do pagamento.
  - `updated_at` string, date-time, required: Data da última atualização do pagamento.
  - `payment_date` string, date-time, required: Data em que o pagamento foi confirmado.

---

[API](https://skmtc.dev/paytime/apis/api-p-blica.md) - [All operations](https://skmtc.dev/paytime/apis/api-p-blica/llms.txt) - [OpenAPI document](https://skmtc.dev/paytime/apis/api-p-blica/revisions/5c818991d183?raw)