TryploPay
    • Começe por Aqui
    • Status
    • Autenticação
      • Auth
        GET
      • Status Credencial
        GET
    • Consumidores
      • Lista Consumidores
        GET
    • Faturas
      • Cartão de Crédito
      • Lista Faturas
        GET
      • Criar Fatura
        POST
      • Atualizar Vencimento
        PATCH
      • Cancelar Fatura
        DELETE
      • Estornar Fatura
        PUT
      • Adicionar Tracking Code
        POST
    • Contestações
      • Listar Mediações
        GET
      • Listar Chargebacks
        GET
    • Webhooks
      • Exemplos de Webhooks
      • Validar Webhook Recebido
        OPTIONS
      • Reenviar Webhook
        COPY
    • BAAS

    Começe por Aqui

    Bem vindo a Documentação da API da TryploPay.

    Estamos na Versão 4.0.2 e estamos em constante evolução.

    PERIGO

    RISCO DE BREAKING CHANGE

    Prezados,

    Estamos atualizando nossos fluxos para uma versão mais robusta e eficiente, priorizando a redução do time response no processamento e tratamento das requisições. Durante este processo, alguns endpoints poderão apresentar versões superiores e respostas ainda não documentadas. Conforme forem validados em produção os exemplos de respostas serão atualizadas conforme necessário.

    Entendemos que isso pode gerar desafios. Por esse motivo, solicitamos que concentrem a validação de sucesso e erro principalmente nos HTTP Codes, pois estes permanecerão inalterados.

    CUIDADO

    RISCO DE BLOCKLIST/CANCELAMENTO DE CONTA

    Não é permitido utilizar o mesmo CPF ou CNPJ em cobranças repetidas. Essa prática caracteriza uso indevido da conta e poderá resultar em bloqueio ou até no cancelamento imediato, com retenção dos fundos por até 180 dias, conforme nossos termos e políticas de uso.

    ENDPOINT

    Atualmente, aceitamos 6 tipos de métodos HTTP.

    Os métodos HTTP aceitáveis para consumo são: GET, POST, PUT, PATCH e DELETE.
    O método HTTP OPTIONS, é aceito apenas para validar eventos disparados para o seu servidor a fins de validação caso necessário.

    URL BASE
    https://api.tryplopay.com

    Os Endpoints são:

    ENDPOINTMÉTODOS HTTP ACEITOSSTATUSVERSÃO API
    /AUTHGETATIVO>= 4.0.0
    /STATUSGETATIVO>= 4.0.0
    /CUSTOMERGETATIVO<= 3.0.5
    /INVOICESGET, POST, PUT, PATCH, DELETEATIVO>= 4.0.0
    /INVOICES/QRCODEGETATIVO>= 4.0.0
    /INVOICES/TRACKINGPOSTATIVO<= 3.0.5
    /INVOICES/MEDIATIONSGETATIVO>= 4.0.0
    /INVOICES/CHARGEBACKSGETATIVO>= 4.0.0
    /WEBHOOKSOPTIONSATIVO>= 4.0.0
    /BAAS/BALANCEGETATIVO>= 4.0.0
    /BAAS/DETAILSGETATIVO>= 4.0.0
    /BAAS/PIX-OUTPOSTATIVO>= 4.0.0
    /BAAS/STATEMENTGETATIVO>= 4.0.0

    Suporte

    Caso precise de suporte, por favor, entre em contato com a nossa equipe pelo Chat ou WhatsApp (41) 3798-6803.

    CHANGELOG

    Abaixo, você confere todas as recentes atualizações da api.

    VERSÃODATADESCRIÇÃOIMPACTO NA INTEGRAÇÃO
    REQUER ATENÇÃO NO CÓDIGO    		DATA DO EFEITO
    4.0.212/12/2025Implementação de Regra de Escopo e Alteração do Formato do AccessToken para JWT.TOTALAPÓS 10/01/2026
    4.0.131/10/2025Lançamento dos Endpoints: Extrato, Detalhes da Conta e Saldo.NÃOIMEDIATO.
    4.0.025/10/2025Lançamento da API BaaSNÃOIMEDIATO.
    ATENÇÃOCOM AS MUDANÇAS EMELHORIAS NO FLUXO DE APIA PARTIR DO DIA 25/10/25, A APIVIRA PARA A VERSÃO 4.0.0
    3.0.521/10/2025Inclusão de novos data para Cartão de CréditoAPENAS SE USAR O MÉTODO.IMEDIATO.
    3.0.515/10/2025Inclusão do endpoint de Mediações, Chargebacks e Saldo da Conta.NÃOIMEDIATO.
    3.0.429/09/2025Inclusão do endpoint Tracking Code.SIM, APENAS SE USAR O RECURSO VIA APIIMEDIATO.
    3.0.316/09/2025Alterações no fluxo de reembolso. Consulte a seção de reembolso para conferir as mudanças.SIM, APENAS SE USAR O RECURSO VIA APIIMEDIATO.
    3.0.206/05/2025Alterado o Fluxo de Geração do Token do Cartão de Crédito.

    Inclusão do array "invoice" no response de criação de fatura.

    Atendendo um prazo minimo necessário para readaptação, o array "fatura" será desativado em 01/09/2025.    		SIM.IMEDIATO.
    3.0.102/04/2025Adicionado Endpoint "/invoices/qrcode/" para obtenção do QRCODE PIX da fatura.NÃO.IMEDIATO.
    3.0.022/01/2025Na busca continua em melhorias, o endpoint INVOICES foi reformulado, trazendo mais velocidade no processamento da transação.

    DEPRECIAÇÃO**
    /customers (POST).**
    Usar apenas GET
    **
    Limite de Uso: até 10/02/25**    		SIM11/02 em diante.
    2.114/10/2024Melhoramos a otimização dos nossos serviços, e abrimos possibilidade de novos recursos.NÃO.IMEDIATO.
    2.007/10/2024Inclusão de novos parâmetros no body da requisição das faturas.

    Consulte a Seção "CRIAR FATURA".    		NÃO.IMEDIATO.
    1.905/10/2024Inclusão de novos parâmetros no retorno das credenciais.

    Consulte a Seção "Auth".
    ------------
    Atualização na obrigatoriedade de envio de parâmetros.

    Consulte as Seções "CADASTRAR CONSUMIDOR" e "CRIAR FATURA".    		NÃOIMEDIATO.
    1.816/07/2024Inclusão de novos parâmetros no retorno das credenciais.

    Consulte a Seção "Auth".
    ------------
    Inclusão de novo array na emissão de fatura.

    Consulte a Seção "Criar Fatura".    		NÃOIMEDIATO.
    1.702/06/2024Inclusão de novos parâmetros no array "address".

    Consulte a Seção "Criar Fatura".    		NÃOIMEDIATO.
    1.614/05/2024Novo Endpoint.
    Possibilita a Reemissão de uma Fatura já emitida.    		NÃOIMEDIATO.
    1.512/04/2024Inclusão de novos parâmetros no array "payment".

    Consulte a Seção "Criar Fatura".

    Inclusão de Novo Endpoint.

    Inclusão de novos parâmetros no array "payment".

    Consulte a Seção "Status Credencial"    		SIMIMEDIATO.
    1.404/04/2024Inclusão de novos parâmetros no array "payment".

    Consulte a Seção "Criar Fatura"    		SIMIMEDIATO. OBRIGATÓRIO APÓS 25/04/2024.
    1.303/04/2024Inclusão de novos parâmetros no array "products".

    Consulte a Seção "Criar Fatura"    		NÃOIMEDIATO
    1.215/03/2024Inclusão de novos parâmetros no array "products".

    Consulte a Seção "Criar Fatura"    		NÃOIMEDIATO
    1.128/12/2023Inclusão de novos parâmetros no array "cartao".

    Consulte a Seção "Criar Fatura"    		SIMIMEDIATO. OBRIGATÓRIO APÓS 15/01/2023.
    1.001/12/2023LANÇAMENTO DA APIIMEDIATO
    Próxima página
    Status
    Built with