1. Cartão de Crédito
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. Cartão de Crédito

Cobrar no cartão

POST
/api/partner/v1/credit-card
Cobra usando um token selado emitido em POST /card-tokens.

O que NÃO pode ir no corpo#

Os campos abaixo são proibidos e devolvem 422 se enviados:
CampoPor quê
card.numberPAN só trafega em /card-tokens
card.cvvidem
three_ds_data3DS é exclusivo do checkout próprio

O bloco device é obrigatório#

Descreve o comprador, não o seu servidor. O ip da requisição é o da
sua infraestrutura, e por isso não serve para as regras de antifraude —
device.ip precisa ser o IP real de quem está comprando.

Resposta#

200 confirma que a cobrança foi submetida e devolve o
transaction_id. O resultado final (aprovada, recusada, estornada) chega
pelo webhook de transação; você também pode consultar
GET /transaction/{reference_id}.

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/jsonObrigatório

Examples

Respostas

🟢200
application/json
Cobrança submetida. Não retente esta requisição: a cobrança já
existe do nosso lado.
Bodyapplication/json

🟠403
🟠409
🟠422
🔴500
🟠401Unauthorized
🟠429TooManyRequests
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/api/partner/v1/credit-card' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 149.9,
    "description": "Pedido #1234",
    "installments": 1,
    "webhook_url": "https://loja.exemplo.com.br/webhooks/syncpay",
    "card": {
        "token": "card_token.yV5IhEG7gIUgHyKnUTE2Uozams0JpjCpbc5it3NG-nw…"
    },
    "client": {
        "name": "Maria da Silva",
        "email": "maria@exemplo.com.br",
        "phone": "5511987654321",
        "document": {
            "type": "cpf",
            "number": "12345678901"
        }
    },
    "device": {
        "ip": "187.45.201.10",
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_5 like Mac OS X)…",
        "page_url": "https://loja.exemplo.com.br/checkout",
        "metadata": {
            "session_id": "sess_9f2c"
        }
    }
}'
Response Response Example
200 - ok
{
    "data": {
        "message": "Credit card payment request successfully submitted.",
        "transaction_id": "acfbabc5-bb8a-4459-aa05-7374c2e5e9ef"
    }
}
Modificado em 2026-08-11 13:15:21
Página anterior
Selar um cartão
Próxima página
Solicitação de depósito via Pix
Built with