🔼
POST urlServidor/v1/marketplace/banking/payments

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 POST \
--location 'urlServidor/v1/marketplace/banking/payments' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Modelo da requisição

{
  "barcode": "23793381286008301352856000063307789840000150000",
  "description": "Pagamento de boleto mensal",
  "amount": 150000
}}

Variáveis

Campo	Tipo	Obrigatório	Descrição
barcode	string	Sim	Código de barras do boleto.
description	string	Não	Descrição opcional do pagamento.
amount	number	Não	Valor a ser pago (quando diferente do nominal do boleto).

Modelo do response

{
    "_id": "6a23088afcab3096caaa7359",
    "type": "BALANCE",
    "status": "PROCESSING",
    "barcode": "23793381286008301352856000063307789840000150000",
    "digitable_line": "23793381286008301352856000063307789840000150000",
    "expected_on": "2026-06-05T12:00:00.000Z",
    "amount": 150000,
    "nominal_amount": 150000,
    "discount": 0,
    "fine": 0,
    "interest": 0,
    "gateway_key": "537afc5f-040e-4970-b042-96974d207477",
    "document_number": "69844780144",
    "gateway_authorization": "CELCOIN",
    "payment_details": {
        "balance": 150000,
        "card": 0,
        "total": 150000,
        "fees": 0
    },
    "recipient": {
        "name": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
        "document": "87754347000108",
        "_id": "6a23088afcab3096caaa735a"
    },
    "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": "6a23088afcab3096caaa735b"
    },
    "establishment_id": "155392",
    "user": {
        "id": 393,
        "first_name": "EC Final Update",
        "last_name": null,
        "profile_id": 1
    },
    "establishment": {
        "id": 155392,
        "type": "BUSINESS",
        "access_type": "ACQUIRER",
        "active": true,
        "first_name": "EC Final3",
        "last_name": "Final 3",
        "document": "31820784000128"
    },
    "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-06-05T17:34:02.092Z",
            "_id": "6a23088afcab3096caaa735c"
        },
        {
            "status": "PROCESSING",
            "created_at": "2026-06-05T17:34:02.092Z",
            "_id": "6a23088afcab3096caaa735d"
        }
    ],
    "created_at": "2026-06-05T17:34:02.096Z",
    "updated_at": "2026-06-05T17:34:02.096Z"
}

Detalhe response

🧾 Objeto principal

Campo	Tipo	Obrigatório	Descrição
_id	string	Sim	ID único do pagamento.
type	string	Sim	Tipo do pagamento realizado.
status	string (enum)	Sim	Status atual do pagamento. Valores: `PAID`, `PENDING`, `PROCESSING`, `REFUNDED`, `CANCELED`.
barcode	string	Sim	Código de barras do boleto pago.
digitable_line	string	Sim	Linha digitável do boleto pago.
expected_on	date-time	Sim	Data prevista para processamento/pagamento.
amount	number	Sim	Valor líquido efetivamente pago.
nominal_amount	number	Sim	Valor original (nominal) do boleto.
discount	number	Sim	Valor de desconto aplicado ao boleto.
fine	number	Sim	Valor de multa (mora) aplicada.
interest	number	Sim	Valor de juros aplicado.
gateway_key	string	Sim	Identificador do gateway responsável pelo processamento.
document_number	string	Sim	Documento informado como referência no boleto.
gateway_authorization	string	Sim	Nome do gateway que autorizou/processou o pagamento.
establishment_id	string	Sim	ID do estabelecimento vinculado ao pagamento.
reprocessed	boolean	Sim	Indica se o pagamento foi reprocessado.
created_at	date-time	Sim	Data de criação do registro de pagamento.
updated_at	date-time	Sim	Última atualização do pagamento.
payment_date	date-time	Sim	Data de confirmação efetiva do pagamento.

💳 payment_details (Meios de pagamento)

Campo	Tipo	Obrigatório	Descrição
balance	number	Sim	Valor pago utilizando saldo disponível.
card	number	Sim	Valor pago via cartão.
total	number	Sim	Soma total paga.
fees	number	Sim	Taxas aplicadas ao pagamento via cartão.

👤 recipient (Beneficiário do boleto)

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do beneficiário do boleto.
document	string	Sim	Documento do beneficiário (CPF/CNPJ).
_id	string	Sim	Identificador interno do beneficiário.

📄 billet_details (Detalhes do boleto)

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

👨‍💻 user (Usuário responsável pelo pagamento)

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	Condicional	Sobrenome do usuário (pode ser nulo).
profile_id	number	Sim	ID do perfil do usuário.

🏢 establishment (Estabelecimento)

Campo	Tipo	Obrigatório	Descrição
id	number	Sim	ID do estabelecimento.
type	string (enum)	Sim	Tipo do estabelecimento: `INDIVIDUAL` ou `BUSINESS`.
access_type	string	Sim	Tipo de acesso do estabelecimento.
active	number	Sim	Status de ativação (1 = ativo, 0 = inativo).
first_name	string	Sim	Nome ou razão social.
last_name	string	Sim	Nome fantasia ou complemento.
document	string	Sim	CPF ou CNPJ do estabelecimento.

🏬 marketplace

Campo	Tipo	Obrigatório	Descrição
id	number	Sim	ID do marketplace.
type	string (enum)	Sim	Tipo do marketplace: `WHITELABEL`, `LICENSED`, `REPRESENTATIVE`.
nickname	string	Sim	Apelido do marketplace.
active	number	Sim	Status de ativação do marketplace.
first_name	string	Sim	Nome ou razão social.
last_name	string	Sim	Nome fantasia ou complemento.
document	string	Sim	CPF ou CNPJ do marketplace.

📊 history (Histórico de status)

Campo	Tipo	Obrigatório	Descrição
status	string (enum)	Sim	Status registrado: `PAID`, `PENDING`, `PROCESSING`, `REFUNDED`, `CANCELED`.
created_at	date-time	Sim	Data e hora da mudança de status.
_id	string	Sim	ID do registro histórico.

Status possíveis

Status	Descrição
PENDING	Pagamento aguardando processamento.
PROCESSING	Em processamento pelo gateway.
PAID	Pagamento confirmado com sucesso.
REFUNDED	Pagamento estornado.
CANCELED	Pagamento cancelado.

⚠️
Registro de logs
É obrigatório manter registros em logs de todas as validações de OTP realizadas. A Paytime pode solicitar, a qualquer momento, relatórios e evidências desses logs para fins de auditoria e comprovação de segurança em movimentações financeiras.

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.