TryploPay
  1. Autenticação
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
  1. Autenticação

Auth

GET
https://api.tryplopay.com/auth
Para gerar um AccessToken, será necessário informar o Token e a Chave Secreta gerados no menu "API > Credenciais".
Você pode cadastrar até 50 Credenciais distintas para gerar novos AccessToken's.
❗️ A validade de cada AccessToken é de 12 meses, sem precisar ficar gerando um novo AccessToken a cada requisição. Para gerar um novo access token, basta fazer uma nova solicitação.
Antes de começar, os AccessToken's possuem escopos de permissão, e eles são separados por virgula.
Abaixo, você confere a lista de escopos permitidos.
EscopoDescrição
invoice.writeEmite Faturas
invoice.readLista e Consulta as Faturas
invoice.refundRealiza Reembolsos
invoice.updateAtualizar Faturas: Vencimento e Cancelar
disputes.readLista e Consulta as Mediações/Chargebacks
disputes.updateAtualiza as Mediações/Chargebacks
customer.readLista os Consumidores
baas.balanceConsulta o Saldo da Conta
baas.withdrawRealiza Saques da Conta. Necessário Configuração do Certificado.
baas.statementConsulta o Extrato da Conta
baas.detailsConsulta os Detalhes da Conta
Abaixo, você confere o que cada parâmetro de retorno significa.
Para usar o Cartão de Crédito, lembre-se de salvar o valor do ACCOUNT, pois este será usado para tokenização dos cartões.
PARÂMETRODESCRIÇÃOVALORES
accountID da Conta/AccountID, será usado para a geração do Token do Cartão de Crédito
access_tokenToken de Acesso para uso do fluxo transacional
token_typeTipo do AccessToken gerado, Basic ou Bearer
scopeScopos de permissões configuradasinvoice.write, customer.write
expires_invalidade do token em timestamp
companieID da Empresa na Tryplo
workingAmbiente de Uso.PRODUCTION
SANDBOX
detailsArray com detalhes da conta
details > typeTipo de Conta1 - Pessoa Fisica
2 - Pessoa Juridica
details > documentCPF/CNPJ da Conta
details > nameRazão Social/Nome
details > ownerArray com os dados do Titular da Empresa
details > owner > documentCPF/CNPJ do Titular da Empresa
details > sacArray com os dados de SAC da Empresa
details > sac > phoneTelefone/Celular de SAC
details > sac > emailEmail de SAC

Requisição

Authorization
Envie suas requisições HTTP com um cabeçalho
Authorization
que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password
Exemplo:
Authorization: Basic *****************
Parâmetros Header

Respostas

🟢200200 - Sucesso
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.tryplopay.com/auth' \
--header 'scope: invoice.write, customer.write, webhook.write' \
--header 'Authorization: Basic <encoded-value>'
Response Response Example
{
	"account": "a657c3ea-eed7-11ef-8ed9",
	"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXV....",
	"token_type": "Bearer",
	"scope": "invoice.write, customer.write, webhook.write",
	"expires_in": 1796846761,
	"working": "PRODUCTION",
	"companie": 1,
	"details": {
		"type": 1,
		"document": "0000000000",
		"name": "RAZAO",
		"social_name": "FANTASIA",
		"owner": [
			{
				"name": "NOME DO SÓCIO",
				"document": "***000***00"
			}
		],
		"sac": {
			"phone": "00000000",
			"email": "exemplo@gmail.com"
		},
		"global": null,
		"softDesc": "TTPLY*TEST",
		"methods": {
			"pix": {
				"active": 1,
				"limits": {
					"amount": 25
				}
			},
			"card": {
				"threeds": false,
				"credit": {
					"active": 1,
					"limits": {
						"amount": null,
						"installment": 12
					}
				},
				"debit": {
					"active": false,
					"limits": {
						"amount": 0
					}
				},
				"prepaid": {
					"active": false,
					"limits": {
						"amount": 0
					}
				}
			},
			"billet": {
				"active": 1,
				"limits": {
					"amount": null
				}
			}
		},
		"fees": {
			"warning": "These fees do not include the acquirer's fees and antecipations fees.",
			"percent": 0,
			"cents": 0,
			"billet": {
				"percent": 3.49,
				"cents": 1.8
			},
			"pix": {
				"percent": 3.49,
				"cents": 1.2
			},
			"card": {
				"percent": 4.99,
				"cents": 1.8,
				"installments": {
					"x1": 3,
					"x2": 4,
					"x3": 5,
					"x4": 6,
					"x5": 7.5,
					"x6": 8.5,
					"x7": 9.5,
					"x8": 10,
					"x9": 10,
					"x10": 10,
					"x11": 11,
					"x12": 12
				}
			}
		}
	}
}
Página anterior
Autenticação
Próxima página
Status Credencial
Built with