1. Old API
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. Old API

CashIn

POST
/v1/gateway/api
Endpoint da V1 replicada pra V2

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Bodyapplication/json

Examples

Respostas

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/gateway/api' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "ip": "127.0.0.1",
  "pix": {
    "expiresInDays": "2024-12-31"
  },
  "items": [
    {
      "title": "Produto Exemplo",
      "quantity": 1,
      "tangible": true,
      "unitPrice": 10.00
    }
  ],
  "amount": 10.00,
  "customer": {
    "cpf": "12345678901",
    "name": "João Silva",
    "email": "joao@example.com",
    "phone": "11987654321",
    "externaRef": "REF123456",
    "address": {
      "city": "São Paulo",
      "state": "SP",
      "street": "Rua das Flores",
      "country": "BR",
      "zipCode": "01234-567",
      "complement": "Apto 101",
      "neighborhood": "Centro",
      "streetNumber": "123"
    }
  },
  "metadata": {
    "provider": "MeuProvider",
    "sell_url": "https://example.com/sell",
    "order_url": "https://example.com/order",
    "user_email": "user@example.com",
    "user_identitication_number": "98765432100"
  },
  "traceable": true,
  "postbackUrl": "https://example.com/postback"
}'
Response Response Example
{
    "status": "success",
    "message": "ok",
    "client_id": "",
    "urlWebHook": "https://webhook.site/7b6e1248-eb5d-40e0-9f8e-6eb28becd2d0",
    "paymentCode": "00020126820014br.gov.bcb...",
    "idTransaction": "680a566b-0f40-497a-ad20-f0e6a6e369e4",
    "paymentCodeBase64": "MDAwMjAxMjY4MgAwMTRici5nb3YuYmNiLnBpeDI1NjBwaXgudHJlZWFsLmNvbS9xcid2My9h2C9mYzhiNDUxZS1lZjgwLTRhNzYtYWE5Ny1jZjU3OWI3ZTAaMmU1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTA4U1lOQ19QQVk2MDA5Tk9WT19HQU1BNjIwNzA1MDMqKio1MzA0OTBFQw==",
    "status_transaction": "WAITING_FOR_APPROVAL"
}
Modificado em 2025-09-03 13:51:45
Página anterior
Solicitação de depósito via Pix
Próxima página
Consulta os dados do Parceiro
Built with