Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pagamentos.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Gerenciando clientes

Os provedores de pagamento geralmente exigem informações sobre os clientes para processar os pagamentos. Com a pagamentos.dev, você pode criar, atualizar e consultar os clientes de forma simples.
A disponibilidade das operações pode variar de acordo com o provedor conectado.

​
Criando um cliente

import { pg } from './pagamentos'

const cliente = await pg.clientes.create({
  nome: 'João Silva',
  email: 'joaosilva@email.com',
  documento: '123.456.789-00' // CPF ou CNPJ
  // outros campos específicos do provedor
})

console.log(cliente.id) // ID gerado pelo provedor

​
Consultando um cliente

import { pg } from './pagamentos'

const cliente = await pg.clientes.get('id-do-cliente')

console.log(cliente.nome) // João Silva

​
Atualizando um cliente

import { pg } from './pagamentos'

const cliente = await pg.clientes.update('id-do-cliente', {
  email: 'joaosilva@novoemail.com'
})

console.log(cliente.email) // joaosilva@novoemail.com

​
Listando clientes

import { pg } from './pagamentos'

const clientes = await pg.clientes.list({
  pagina: 1,
  limite: 10
})

console.log(clientes) // Lista de clientes
Filtros disponíveis podem variar dependendo do provedor conectado. Consulte a documentação do provedor para detalhes específicos.

​
Excluindo um cliente

import { pg } from './pagamentos'

await pg.clientes.delete('id-do-cliente')

​
Usando clientes em outras operações

As informações dos clientes podem ser utilizadas em outras operações, como na criação de cobranças ou checkouts, para associar os pagamentos a um cliente específico. Por exemplo: 
import { pg } from './pagamentos'

const pagamento = await pg.cobrancas.create({
  valor: 1000, // valor em centavos
  metodoPagamento: 'pix',
  cliente: {
    id: 'id-do-cliente' // Referência ao cliente criado anteriormente
  }
})