SyncPay - Integração Simples com a API SyncPay

O SyncPay é uma biblioteca desenvolvida para facilitar a integração com a API da SyncPay, permitindo que desenvolvedores realizem operações financeiras de forma rápida e segura. Com ele, você pode consultar saldo, verificar o status de transações e gerar cobranças via Pix sem precisar lidar diretamente com requisições HTTP.

Instalação

$ npm install syncpay

Importar e Autenticar

import { SyncPay } from "syncpay"

const syncpay = new SyncPay({ client_id: "", client_secret: "" }) // Você pode obter suas credenciais em: https://app.syncpayments.com.br/seller/developer-api

Criar Pagamento PIX

syncpay.pix.cashIn({
    amount: 10,
    description: "Descrição do pagamento",
	client: {
		name: "Paulo Queiroz",
		email: "[email protected]",
		cpf: "02965847521",
        phone: "11987654321",
	},
    split: [
          {
            user_id: "9f3c5b3a-41bc-4322-90e6-a87a98eefeca",
            percentage: 25
          }
    ],
	webhook_url: "https://exemple/webhook/"
})

Realizar Saque

syncpay.pix.cashOut({
    amount: 5.57,
    description: "Saque para beneficiário",
    pix_key_type: "CPF",
    pix_key: "56265478451",
    document: {
        type: "cpf",
        number: "56265478451"
    }
})

Obter Status de um Pagamento

syncpay.pix.status({
    identifier: "d22413c2-c768-4066-af70-c3b4e0f418ac"
})

Obter Saldo Atual da Conta

syncpay.account.balance()

Obter dados da conta

syncpay.account.profile()