1. Auth Token
SYNC-DOCUMENTATION
  • Auth Token
    • Gera o token de utilização da aplicação
      POST
  • Saldo
    • Retorna o Saldo do Usuário
      GET
  • Transações
    • Consulta status da transação
      GET
  • Utmify
    • Salvar Token
      POST
    • Desativa Token
      POST
  • Partner
    • Consulta dados do Parceiro
      GET
  • Cartão de Crédito
    • Selar um cartão
      POST
    • Cobrar no cartão
      POST
  • Pix - CashIn
    • Solicitação de depósito via Pix
      POST
  • Old API
    • CashIn
      POST
    • Consulta os dados do Parceiro
      GET
  • Assinaturas - Recorrência
    • Planos
      • Listar planos
      • Criar plano
      • Detalhe do plano
      • Editar plano
      • Arquivar plano
      • Assinantes do plano
    • Assinantes
      • Cadastrar assinante
      • Listar assinantes
      • Detalhe da assinatura
      • Cancelar assinatura
      • Pausar assinatura
      • Reativar assinatura
      • Reenviar cobrança
      • Trocar plano da assinatura
    • Notificações
      • Listar entregas de um webhook
    • Splits
      • Adicionar recebedor de split a um plano
      • Listar splits enviados (perspectiva do seller)
      • Listar convites recebidos (perspectiva do recebedor)
      • Aceitar convite de split
      • Rejeitar convite de split
      • Cancelar split (perspectiva do seller)
    • Produtos — Planos
      • Listar planos aninhados a um produto
      • Criar plano aninhado a um produto
      • Atualizar plano aninhado
      • Desativar plano aninhado
      • Marcar plano como padrão do produto
  • Reembolsos
    • Solicitar reembolso de uma venda
      POST
    • Consultar uma solicitação de reembolso
      GET
  • Raiz
  • Webhooks
    • Cash-In
      • Cash-in criado (cobrança PIX gerada)
      • Cash-in atualizado (mudança de status)
      • Cash-in legado (notificação mínima)
    • Cash-Out
      • Cash-out criado (saque solicitado)
      • Cash-out atualizado (mudança de status do saque)
    • Cartão de Crédito
      • Cartão de crédito — cobrança criada
      • Cartão de crédito — mudança de status
    • Transações - Completo
      • Cobrança de transação criada
      • Transação teve mudança de status
    • Listar webhooks
    • Criar webhook
    • Atualizar webhook
    • Excluir webhook
    • Rotacionar o segredo de assinatura
  • Esquemas
    • Webhook
      • CashIn
        • onCreate
        • onUpdate
        • CashinCreated
        • CashinUpdated
        • CashinOld
      • CashOut
        • onCreate
        • onUpdate
      • Cash-In
        • CashinCreated
        • CashinUpdated
        • CashinOld
    • TransactionEvent
    • BillingMethod
    • CardTokenRequest
    • WebhookInput
    • CreditCardCreatePayload
    • CashinCreated
    • CreditCardCreated
    • RefundReason
    • CashoutCreated
    • CreditCardUpdated
    • CreditCardStatusPayload
    • CardToken
    • Transaction
    • CashinUpdated
    • CashoutUpdated
    • Webhook
    • PlanStatus
    • RefundStatus
    • SplitStatus
    • CashinOld
    • RefundWebhookPayload
    • Customer
    • CreatedWebhook
    • CreditCardPaymentRequest
    • RefundRejectionCategory
    • PaymentMethod
    • CreditCardPaymentAccepted
    • DebtorAccount
    • SubscriptionSplit
    • WebhookListItem
    • Payment
    • WebhookDelivery
    • RefundRequest
    • SplitRecipientPayload
    • SimpleError
    • RefundTransaction
    • SubscriptionSplitInvite
    • StoreProductPlanRequest
    • RotatedWebhookSecret
    • Card
    • CodedError
    • RefundEvent
    • SubscriptionStatus
    • Checkout
    • UpdateProductPlanRequest
    • RefusedError
    • ChargeStatus
    • PaymentLink
    • AntiFraudError
    • Error
    • Tracking
    • ValidationError
    • PlanResource
    • PaginationMeta
    • ChargeResource
    • SubscriptionResource
    • EnrollPaymentQrCode
    • EnrollPaymentPixAutomatico
    • WebhookResource
    • NotFoundError
    • WebhookEnvelope
    • ChargeBlock
    • MandateBlock
    • WebhookDeliveryResource
  1. Auth Token

Gera o token de utilização da aplicação

POST
/api/partner/v1/auth-token
Endpoint para geração do Bearer Token para efetuar as requests.
O Token tem validade de 1 hora.
ATENÇÃO!!
Gere um novo token, apenas quando o anterior expirar.

Requisição

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK
application/json
Consulta realizada com sucesso
Bodyapplication/json

🟠401Não autorizado
🟠429Pedido inválido
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/partner/v1/auth-token' \
--header 'Content-Type: application/json' \
--data '{
    "client_id": "89210cff-1a37-4cd0-825d-45fecd8e77bb",
    "client_secret": "dadc1b2c-86ee-4256-845a-d1511de315bb"
}'
Response Response Example
200 - Example 1
{
    "access_token": "123003123|XzrqSwIMFS2EMuHBUPa2zhyOlcQ5cGgTgKieiuAp6a3fa3a5",
    "token_type": "Bearer",
    "expires_in": 3600,
    "expires_at": "2025-06-22T02:49:47.440458Z"
}
Modificado em 2025-11-20 19:20:38
Próxima página
Retorna o Saldo do Usuário
Built with