šŸ‹ PagLemon | API Documentation
  1. Links de Pagamento
šŸ‹ PagLemon | API Documentation
  • Raiz
    • Admin
      • Aprovar empresa
      • Listar empresas
      • Listar solicitaƧƵes empresas
      • Receitas
      • Listar todos os pagamentos
      • Listar total de transaƧƵes
      • Listar dados de faturamento
      • Aprovar saque
      • Listar todas solicitaƧƵes de saques
      • Dashboard
      • Reprovar saque
      • Listar configuraƧƵes de saques
      • Listar configuraƧƵes de saque por ID
      • Atualizar configuração de saque por ID
      • Listar taxas
      • Listar taxa por ID
      • Listar todas as transaƧƵes
      • Listar administradores 🚧
      • Listar configuraƧƵes
      • Listar configuraƧƵes por ID
      • Atualizar configuraƧƵes
    • Default
      • Criar uma taxa
      • Atualizar uma taxa
      • Criar saque 🚧
      • Listar todos saques
      • Obter saque por ID
      • Listar taxas
      • Listar todas as transaƧƵes
      • Obter transaƧƵes por ID
    • Autenticação
      • Registro de usuĆ”rio
      • Login
      • Refresh token
    • Dashboard
      • Resumo
    • Empresas
      • Criar empresa
      • Atualizar empresa
      • Excluir empresa
      • Enviar documentos
      • Atualizar documentos
      • Listar empresas
    • IntegraƧƵes
      • Login API
      • Obter credenciais
      • Atualizar credenciais
    • Links de Pagamento
      • Criar link de pagamento
        POST
      • Listar links de pagamento
        GET
      • Obter link de pagamento pelo hash
        GET
      • Excluir link de pagamento
        DELETE
    • Pagamentos
      • Criar novo pagamento
      • Listar pagamentos
      • Listar pagamento por ID
    • UsuĆ”rios
      • Criar usuĆ”rio
      • Listar usuĆ”rio por ID
      • Atualizar usuĆ”rio
      • Excluir usuĆ”rio
      • Atualizar senha
    • Saldo
      • Obter saldo
    • Clientes
      • Criar novo cliente vendedor
      • Listar clientes vendedores
      • Obter um cliente vendedor por ID
      • Atualizar cliente vendedor
    • Webhooks
      • Criar webhook
      • Listar webhooks
      • Excluir webhook
    • Status
      • Eventos de saque (exemplos)
      • Status
  • Esquemas
    • Admin__api_v1_admin_enterprises_By_id__POST__Response_200
    • Admin__api_v1_admin_enterprises_By_id__POST__Response_400
    • Admin__api_v1_admin_enterprises__GET__Response_200
    • Admin__api_v1_admin_enterprises__GET__Response_401
    • Admin__api_v1_admin_enterprises_request__GET__Response_200
    • Admin__api_v1_admin_enterprises_revenue__GET__Response_200
    • Admin__api_v1_admin_payments__GET__Response_200
    • Admin__api_v1_admin_payments_total_transactions__GET__Response_200
    • Admin__api_v1_admin_payments_billing__GET__Response_200
    • Admin__api_v1_admin_withdrawals_request__GET__Response_200
    • Admin__api_v1_admin_withdrawals_dashboard__GET__Response_200
    • Admin__api_v1_admin_withdrawal_configs_By_sellerId__GET__Response_200
    • Admin__api_v1_admin_withdrawal_configs_By_sellerId__PUT__Request
    • Default__api_v1_fees__POST__Request
    • Default__api_v1_fees__POST__Response_201
    • Admin__api_v1_admin_fees__GET__Response_200
    • Default__api_v1_fees_By_id__PUT__Response_200
    • Admin__api_v1_admin_members__GET__Response_200
    • Admin__api_v1_admin_reserve_configs__GET__Response_200
    • Admin__api_v1_admin_reserve_configs_By_sellerId__GET__Response_200
    • Admin__api_v1_admin_reserve_configs_By_sellerId__PUT__Request
    • Autenticacao__api_v1_auth_register__POST__Request
    • Autenticacao__api_v1_auth_register__POST__Response_201
    • Autenticacao__api_v1_auth_register__POST__Response_400
    • Autenticacao__api_v1_auth_login__POST__Request
    • Autenticacao__api_v1_auth_login__POST__Response_200
    • Autenticacao__api_v1_auth_refresh__POST__Request
    • Autenticacao__api_v1_auth_refresh__POST__Response_200
    • Dashboard__api_v1_dashboard_overview__GET__Response_200
    • Empresas__api_v1_enterprises__POST__Request
    • Empresas__api_v1_enterprises__POST__Response_201
    • Empresas__api_v1_enterprises__PATCH__Response_200
    • Empresas__api_v1_enterprises__DELETE__Response_204
    • Empresas__api_v1_enterprises_By_id__POST__Request
    • Empresas__api_v1_enterprises_By_id__POST__Response_400
    • Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Request
    • Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Response_200
    • Integracoes__api_v1_api_auth_login__POST__Request
    • Integracoes__api_v1_api_auth_login__POST__Response_200
    • Integracoes__api_v1_integrations_credentials__GET__Response_201
    • Links_de_Pagamento__api_v1_payment_links__POST__Request
    • Links_de_Pagamento__api_v1_payment_links__POST__Response_201
    • Links_de_Pagamento__api_v1_payment_links__GET__Response_200
    • Pagamentos__api_v1_payments__POST__Request
    • Pagamentos__api_v1_payments__POST__Response_200
    • Pagamentos__api_v1_payments_By_id__GET__Response_200
    • Default__api_v1_withdrawals__POST__Request
    • Default__api_v1_withdrawals__POST__Response_201
    • Default__api_v1_withdrawals__GET__Response_200
    • Usuarios__api_v1_users__POST__Request
    • Usuarios__api_v1_users_By_id__GET__Response_200
    • Usuarios__api_v1_users_By_id__PATCH__Request
    • Usuarios__api_v1_users_By_id_password__PATCH__Request
    • Saldo__api_v1_seller_balances_me__GET__Response_200
    • Clientes__api_v1_customers__POST__Request
    • Clientes__api_v1_customers__POST__Response_201
    • Clientes__api_v1_customers__GET__Response_200
    • Webhooks__api_v1_seller_webhooks__POST__Request
    • Webhooks__api_v1_seller_webhooks__POST__Response_201
    • Status__Root__GET__Response_200
    • Status__api_v1_status__GET__Response_200
    • Error_Unauthorized
    • Error_Standard
  1. Links de Pagamento

Criar link de pagamento

POST
/api/v1/payment-links
Endpoint para criar um novo link de pagamento.

šŸ’¾ Estrutura de Dados#

Headers#

Content-type: application/json
Authorization: Bearer <JWT_TOKEN>

Body (JSON)#

PropriedadeTipoObrigatórioDescriçãoValor (exemplo)
amountNumberSimValor do link de pagamento300.50
descriptionStringSimDescrição breve sobre o link de pagamento-

Requisição

Authorization
JWT Bearer
Adicionar o parâmetro
Authorization
a CabeƧalhos
Exemplo:
Authorization: ********************
or
Parâmetros Bodyapplication/json

Examples

Respostas

🟢201
application/json
Body

🟠400
🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/payment-links' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 200.5,
    "description": "Payment link example."
}'
Response Response Example
201 - Sucesso
{
    "id": "0c2cfea4-6866-456b-bca8-17cb7f2bef6f",
    "sellerId": "cac09ce6-8fa1-4c3d-ae2c-cf3958be7450",
    "description": "Payment link example.",
    "url": "http://localhost:3000/checkout/link-IJE-CalF-k",
    "hash": "link-IJE-CalF-k",
    "status": "ACTIVE",
    "qtdPayments": 0,
    "amount": 200.5,
    "createdAt": "2025-11-14T18:40:01.503Z"
}
Modificado emĀ 2025-12-31 00:48:40
PƔgina anterior
Atualizar credenciais
Próxima pÔgina
Listar links de pagamento
Built with