Recursos
Conta
Chame o método account
seu cliente da API para obter o recurso de contas.
Documentação do endpoint para mais detalhes.
Pegar uma conta
Chame o método get
no recurso de contas passando um accountId:
Documentação do endpoint para mais detalhes.
const response = await woovi.account.get({ accountId: 'algum-id' });
Obter uma lista de contas
Obtenha as contas usando o método list
no recurso de contas:
Documentação do endpoint para mais detalhes.
const response = await woovi.account.list({ limit: 10, skip: 0 }); //o objeto de paginação é opcional
Fazer uma retirada(withdraw)
Faça withdraw em uma conta usando do método withdraw
no recurso de contas.
Documentação do endpoint para mais detalhes.
const response = await woovi.account.withdraw({
accountId: 'string',
value: 200,
});
na próxima compra de cashback
Chame o método cashbackFidelity
seu cliente da API para obter o recurso de na próxima compra de cashback.
Documentação do endpoint para mais detalhes.
Pegar a quantidade de cashback que um usuário tem para receber
Chame o método get
no recurso de na próxima compra de cashback passando um taxID:
Documentação do endpoint para mais detalhes.
const response = await woovi.cashbackFidelity.get({ taxID: 'algum-tax-id' });
Criar(ou pegar) uma na próxima compra de cashback pra um cliente
Crie o recurso chamando o método create
no recurso de na próxima compra de cashback.
Documentação do endpoint para mais detalhes.
const response = await woovi.cashbackFidelity.create({
value: 100,
taxID: 11111111111,
});
Cobrança
Chame o método charge
seu cliente da API para obter o recurso de cobrança.
Documentação do endpoint para mais detalhes.
Pegar uma cobrança
Chame o método get
no recurso de cobranças passando um id:
Documentação do endpoint para mais detalhes.
const response = await woovi.charge.get({ id: 'algum-id' });
Obter uma lista de cobranças
Obtenha as cobranças usando o método list
no recurso de cobranças:
Documentação do endpoint para mais detalhes.
const response = await woovi.charge.list({ limit: 10, skip: 0 }); //o objeto de paginação é opcional
Crie uma cobrança
Crie uma cobrança usando o método create
no recurso de cobranças:
Documentação do endpoint para mais detalhes.
const response = await woovi.charge.create({
correlationID: '9134e286-6f71-427a-bf00-241681624587',
value: 100,
comment: 'good',
customer: {
name: 'Dan',
taxID: '31324227036',
email: '[email protected]',
phone: '5511999999999',
},
additionalInfo: [
{
key: 'Product',
value: 'Pencil',
},
{
key: 'Invoice',
value: '18476',
},
{
key: 'Order',
value: '302',
},
],
});
Pegar imagem de um qr code de uma cobrança
Obtenha o qr code de uma cobrança usando o método getQrCode
no recurso de cobranças:
Documentação do endpoint para mais detalhes.
const response = await woovi.charge.getQrCode({ size: '768' });
Deletar uma cobrança
Delete uma cobrança usando o método delete
no recurso de cobranças:
Documentação do endpoint para mais detalhes.
const response = await woovi.charge.delete({ id: 'algum-id' });
Estorno de Cobrança
Chame o método chargeRefund
seu cliente da API para obter o recurso de estorno de uma cobrança.
Documentação do endpoint para mais detalhes.
Obter uma lista de estorno cobranças
Obtenha os estornos de cobrança usando o método list
no recurso de estorno de cobrança:
Documentação do endpoint para mais detalhes.
const response = await woovi.chargeRefund.list({ limit: 10, skip: 0 }); //o objeto de paginação é opcional
Crie uma cobrança
Crie um estorno de cobrança usando o método create
no recurso de estorno cobranças:
Documentação do endpoint para mais detalhes.
const response = await woovi.chargeRefund.create({
id: 'algum-id',
correlationID: 'a273e72c-9547-4c75-a213-3b0a2735b8d5',
value: 100,
comment: 'Comentário do reembolso',
});
Cliente
Chame o método customer
seu cliente da API para obter o recurso de cliente.
Documentação do endpoint para mais detalhes.
Pegar uma cliente
Chame o método get
no recurso de clientes passando um id:
Documentação do endpoint para mais detalhes.
const response = await woovi.customer.get({ id: 'algum-id' });
Obter uma lista de clientes
Obtenha os clientes usando o método list
no recurso de clientes:
Documentação do endpoint para mais detalhes.
const response = await woovi.customer.list({ limit: 10, skip: 0 }); //o objeto de paginação é opcional