curl --request POST \
--url https://api.uvvipay.com.br/v1/payments \
--header 'Content-Type: application/json' \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>' \
--data '
{
"externalId": "35d29135-f14e-4695-b9ae-ccde91676a60",
"amount": 9900,
"paymentMethod": "credit_card",
"card": {
"number": "4111111111111111",
"holderName": "JOAO DA SILVA",
"cvv": "123",
"expirationMonth": 12,
"expirationYear": 2030,
"installments": 1
},
"customer": {
"name": "João da Silva",
"email": "joao@example.com",
"document": {
"number": "12345678901",
"type": "cpf"
}
},
"items": [
{
"title": "Curso completo",
"quantity": 1,
"unitPrice": 9900
}
]
}
'{
"id": "547c8482-47d8-4692-a48d-54ea35384c6e",
"status": "paid",
"amount": 9900,
"paymentMethod": "credit_card",
"card": {
"brand": "visa",
"last4": "1111"
},
"externalReference": "35d29135-f14e-4695-b9ae-ccde91676a60",
"customer": {
"name": "João da Silva",
"email": "joao@example.com",
"phone": null,
"documentNumber": "12345678901",
"documentType": "cpf",
"address": {
"zipCode": null,
"street": null,
"streetNumber": null,
"neighborhood": null,
"city": null,
"state": null,
"country": null
}
},
"items": [
{
"title": "Curso completo",
"quantity": 1,
"unitPrice": 9900
}
],
"createdAt": "2026-09-14T18:51:12.947Z"
}Criar pagamento
Cria um novo pagamento (Pix, Cartão de crédito ou Boleto).
curl --request POST \
--url https://api.uvvipay.com.br/v1/payments \
--header 'Content-Type: application/json' \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>' \
--data '
{
"externalId": "35d29135-f14e-4695-b9ae-ccde91676a60",
"amount": 9900,
"paymentMethod": "credit_card",
"card": {
"number": "4111111111111111",
"holderName": "JOAO DA SILVA",
"cvv": "123",
"expirationMonth": 12,
"expirationYear": 2030,
"installments": 1
},
"customer": {
"name": "João da Silva",
"email": "joao@example.com",
"document": {
"number": "12345678901",
"type": "cpf"
}
},
"items": [
{
"title": "Curso completo",
"quantity": 1,
"unitPrice": 9900
}
]
}
'{
"id": "547c8482-47d8-4692-a48d-54ea35384c6e",
"status": "paid",
"amount": 9900,
"paymentMethod": "credit_card",
"card": {
"brand": "visa",
"last4": "1111"
},
"externalReference": "35d29135-f14e-4695-b9ae-ccde91676a60",
"customer": {
"name": "João da Silva",
"email": "joao@example.com",
"phone": null,
"documentNumber": "12345678901",
"documentType": "cpf",
"address": {
"zipCode": null,
"street": null,
"streetNumber": null,
"neighborhood": null,
"city": null,
"state": null,
"country": null
}
},
"items": [
{
"title": "Curso completo",
"quantity": 1,
"unitPrice": 9900
}
],
"createdAt": "2026-09-14T18:51:12.947Z"
}Headers
Secret da credencial do merchant
ID público da credencial do merchant
Chave de idempotência opcional (até 255 caracteres, ex.: UUID v4) gerada pelo cliente. Reenviar a mesma chave com o mesmo payload retorna a transação já criada, sem nova cobrança. Use para retry seguro após timeout.
255Body
- PIX ou cartão com customer
- Cartão do Cofre
- Boleto
pix, credit_card "credit_card"
Identificador único do pedido no sistema do merchant
"35d29135-f14e-4695-b9ae-ccde91676a60"
Valor total em centavos (mínimo 100, máximo 15000000)
100 <= x <= 150000007500
Show child attributes
Show child attributes
1Show child attributes
Show child attributes
Subconta owner da transação (opcional). Quando informada, é identificada pelo documento (CPF/CNPJ) de uma subconta já cadastrada e ativa e passa a ser a owner do split; sem este objeto, o próprio merchant é o owner.
Show child attributes
Show child attributes
Regras de divisão do valor líquido entre subcontas recebedoras. Requer os produtos PaaS e Split habilitados para o merchant; o owner é o próprio merchant, salvo se um subMerchant for informado. Os valores resolvidos retornam no campo split da resposta. Ver guia Pagamentos com Split.
1Show child attributes
Show child attributes
Dados do cartão. Três modos: cartão aberto (number, cvv, holderName, expirationMonth, expirationYear obrigatórios; customer obrigatório no body; quando aprovado, a resposta traz upsell.token), cartão do Cofre (cardTokenId, sem PAN/CVV e sem customer no body) ou token de upsell (upsellToken emitido por um pagamento anterior aprovado, sem PAN/CVV, sem customer e sem threeDSData). Não misture os modos na mesma requisição.
- Cartão aberto
- Cartão do Cofre
- Token de upsell
Show child attributes
Show child attributes
Pagamento via Apple Pay, alternativa ao bloco card (envie um ou outro, nunca ambos). Válido apenas com paymentMethod credit_card; o criptograma do token dispensa CVV e 3DS. Ver guia Apple Pay.
Show child attributes
Show child attributes
Dados do resultado 3DS para cobrança autenticada com cartão de crédito
Show child attributes
Show child attributes
"192.168.1.100"
"LOJA EXEMPLO"
{ "order_id": "123" }
Opções de Pix. Use expiration para definir a validade do QR por cobrança. Se omitido, o padrão é 30 minutos (1800 segundos).
Show child attributes
Show child attributes
Opções de boleto. Use expirationDate para definir o vencimento. Se omitido, o padrão é 30 dias. Válido apenas com paymentMethod boleto. Ver guia Boleto.
Show child attributes
Show child attributes
Response
Pagamento criado (ou recuperado por idempotência quando x-idempotency-key é reenviada). Em cartão aberto aprovado, inclui upsell.token válido por 15 minutos para cobrar uma oferta adicional via card.upsellToken; ver guia Upsell com um clique.
"d398b016-3c29-41b4-afc0-bbf8c81c683c"
waiting_payment, paid, refused, refunded, in_analysis "paid"
15680
"credit_card"
"2026-07-02T19:41:46.738Z"
Presente em pagamentos credit_card quando brand e last4 estão persistidos. Omitido em pix, boleto e wallet. Não inclui PAN, CVV, titular, validade nem BIN. Em Apple Pay inclui wallet.type.
Show child attributes
Show child attributes
{ "brand": "visa", "last4": "1111" }
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Motivo da recusa (presente apenas quando status = refused). Consulte o guia Recusas de cartão para entender as categorias e como orientar o cliente.
Show child attributes
Show child attributes
Dados públicos do submerchant (owner) vinculado à transação.
Show child attributes
Show child attributes
Split resolvido da transação: valor efetivamente destinado a cada recebedor, em centavos (quando a transação possui split)
Show child attributes
Show child attributes
Dados completos do cliente (presente quando disponível).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"35d29135-f14e-4695-b9ae-ccde91676a60"
Presente apenas em pagamentos com cartão aberto (number/cvv) aprovados (status: paid) cuja emissão do token teve sucesso. Não é emitido para cobranças via cardTokenId ou upsellToken. A emissão é best-effort: a ausência do objeto não indica falha do pagamento.
Show child attributes
Show child attributes