Documentação da API SyncPay - Saldo

Atenção: Somente IP's autorizados

Consulta saldo

Endpoint: https://api.syncpay.pro/s1/getsaldo/api/

Descrição

Esse endpoint permite realizar a consulta do usuario.

Formato de Requisição: JSON via GET
Autenticação:Pela Header
Cabeçalho:

Authorization: Basic {API_KEY}
content-type: application/json

Substitua {API_KEY} pela chave de API codificada em Base64.

Body:Dispensado

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações da transação e confirmação do processamento.

Erros

Código	Mensagem	Descrição
401	API Key não fornecida	Cabeçalho de autenticação ausente.
403	IP não autorizado	O IP do solicitante não é permitido.
401	API Key incorreta!	Cabeçalho de autenticação inválido.

Exemplo Json Response

 
                    {
    "data": {
        "usuario": "gustavo",
        "nome": "gustavo",
        "saldo_liquido": 0,
        "transacoes": {
            "entrada": {
                "quantidade": 1,
                "bruto": "1151.00",
                "liquido": "1146.00"
            },
            "saida": {
                "quantidade": 4,
                "bruto": "889.00",
                "liquido": "880.00"
            }
        }
    },
    "status": 200,
    "message": "Sucesso ao consultar saldo!",
    "error": ""
}

Documentação da API SyncPay - Consulta transação

Atenção: Transação

Endpoint: https://api.syncpay.pro/s1/getTransaction/api/getTransactionStatus.php?id_transaction={id_transaction}

Descrição

Esse endpoint permite realizar a consulta de informações sobre determinada transação, seja cashIn ou cashOut.

Formato de Requisição: JSON via GET
Autenticação:Pela Header
Cabeçalho:

Authorization: Basic {API_KEY}
content-type: application/json

Substitua {API_KEY} pela chave de API codificada em Base64.

Parâmetros:
Informe o ID_TRANSACTION da transação que deseja consultar.
Body:Dispensado

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações da transação e confirmação do processamento.

Erros

Código	Mensagem	Descrição
401	API Key não fornecida	Cabeçalho de autenticação ausente.
403	API Key incorreta.	API Key incorreta.
404	Transação não encontrada.	ID de transação inválido ou inexistente.

Exemplo Json Response

 
{
    "situacao": "AGUARDANDO_PAGAMENTO",
    "tipo": "CASH IN",
    "data_transacao": "2025-01-25 21:42:01",
    "nome": "Bechara Jalkh",
    "documento": null,
    "valor_bruto": "1.60",
    "valor_liquido": "1",
    "status": 200,
    "error": ""
}

Documentação da API SyncPay - Consulta transação

Atenção: Transação

Endpoint: https://api.syncpay.pro/s1/getCompany/

Descrição

Esse endpoint permite realizar a consulta de informações sobre o seller. A identificação é feita através da API Key.

Formato de Requisição: JSON via GET
Autenticação:Pela Header
Cabeçalho:

Authorization: Basic {API_KEY}
content-type: application/json

Substitua {API_KEY} pela chave de API codificada em Base64.

Body:Dispensado

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações do usuário

Erros

Código	Mensagem	Descrição
401	API Key não fornecida	Cabeçalho de autenticação ausente.
401	API Key incorreta.	API Key incorreta.

Exemplo Json Response

 
{
    "dados_seller": {
        "empresa": {
            "id": 18777723,
            "user_id": "Lucas_dev",
            "nome": "Lucas Rogério",
            "email": "[email protected]",
            "cpf_cnpj": "65214585423",
            "data_nascimento": "1994-10-20",
            "telefone": "61996569422",
            "data_cadastro": "2024-12-06 22:07:20",
            "ip_user": "201.14.83.1,189.49.141.176,2804:d59:aa07:4700",
            "taxa_cash_in": "7.00"
        },
        "endereco": {
            "cep": "73097514",
            "estado": "Distrito Federal",
            "cidade": "Brasilia",
            "bairro": "Sobradinho",
            "numero": "01",
            "complemento": "SH Contagem"
        }
    }
}

Documentação da API SyncPay - CashIn

Atenção: Somente IP's autorizados

Solicitação de Depósito (Pix de Entrada)

Endpoint: https://api.syncpay.pro/v1/gateway/api/

Descrição

Esse endpoint permite realizar requisições de pagamento via PIX, com autenticação por chave de API e validação de IP autorizado. Ele também verifica campos obrigatórios e requisitos de valores mínimos.

Formato de Requisição: JSON via POST
Autenticação:Pela Header
Cabeçalho:

Authorization: Basic {API_KEY}
content-type: application/json

Substitua {API_KEY} pela chave de API codificada em Base64.

Parâmetros da Requisição (JSON)

Campos do Cliente

Campo	Tipo	Obrigatório	Descrição
customer.id	string	Não	ID único do cliente. Se não fornecido, será gerado um UUID.
customer.name	string	Sim	Nome completo do cliente.
customer.email	string	Sim	E-mail do cliente.
customer.phone	string	Não	Telefone do cliente. (Padrão: "9999999999)".
customer.cpf	string	Sim	CPF do cliente (Apenas CPF válido).
customer.externaRef	string	Não	Referência externa do cliente. (Padrão: "Sem referência)".

Endereço do Cliente

Campo	Tipo	Obrigatório	Descrição
customer.address.street	string	Não	Rua do endereço. (Padrão: "Rua Genérica").
customer.address.streetNumber	string	Não	Número da Rua. (Padrão: "123")
customer.address.complement	string	Não	Complemento do endereço. (Padrão: "Complemento")
customer.address.zipCode	string	Não	CEP do endereço. (Padrão: "00000000")
customer.address.neighborhood	string	Não	Bairro do endereço. (Padrão: "Bairro")
customer.address.city	string	Não	Cidade do endereço. (Padrão: "Cidade")
customer.address.state	string	Não	Estado do endereço. (Padrão: "SP")
customer.address.country	string	Não	País do endereço. (Padrão: "br")

Detalhes do Pagamento

Campo	Tipo	Obrigatório	Descrição
amount	float	Sim	Valor do pagamento em reais.
pix.expiresInDays	int	Não	Dias de validade para o pagamento PIX. (Padrão: 2)

Outros Parâmetros

Campo	Tipo	Obrigatório	Descrição
postbackUrl	string	Sim	URL de retorno para notificações de atualização
metadata	string	Não	Metadados adicionais para o pagamento. (Padrão: "metadata)"
traceable	bool	Não	Indica se o pagamento é rastreável. (Padrão: false)
ip	string	Sim	IP do cliente que está fazendo a requisição.

Exemplo Json de Envio

 
{
	"amount": 10,
	"customer": {
		"name": "Paulo Queiroz",
		"email": "[email protected]",
		"cpf": "02965847521",
		"phone": "(99) 98765-4321",
		"externaRef": "",
		"address": {
			"street": "Rua Exemplo",    
			"streetNumber": "123",
			"complement": "Complemento",
			"zipCode": "73070713",
			"neighborhood": "Bairro",
			"city": "Cidade",
			"state": "SP",
			"country": "br"
		}
	},
	"pix": {
		"expiresInDays": 2
	},
	"items": [
		{
			"title": "Produto Exemplo",
			"quantity": 1,
			"unitPrice": 10,
			"tangible": true
		}
	],
	"postbackUrl": "https://exemple/webhook/",
	"metadata": "metadata",
	"traceable": true
}

Exemplo Json simplificado

 
{
	"amount": 10,
	"customer": {
		"name": "Paulo Queiroz",
		"email": "[email protected]",
		"cpf": "02965847521"
	},
	"postbackUrl": "https://exemple/webhook/"
}

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações da transação e confirmação do processamento.

Erros

Código	Mensagem	Descrição
401	API Key não fornecida	Cabeçalho de autenticação ausente ou inválido.
403	IP não autorizado	O IP do solicitante não é permitido.
422	Dados inválidos	Faltam dados obrigatórios ou valor fora do permitido.

Exemplo Json Response

 
{
  "status": "success",
  "status_transaction": "WAITING_FOR_APPROVAL",
  "message": "ok",
  "client_id": "e3f8ad47-3cb7-4129-9fad-bh891c42c493",
  "paymentCode": "00020126860014br.gov.bcb.pix2563pix.bankn.com.br/qr/v3/at/fa68393e-d775-415a-9336-244c02019460520
  4000053039865802BR5925PAGPIX_SOLUCAO_EM_PAGAMEN6014SAO_BERNARDO_D62070503***630426F7",
  "idTransaction": "28564976-75v5-427c-a693-5e89e8849b76",
  "paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRicdafd34afq3mNvbS5ici9xci92My9hdC9mYTY4MzkzZS1kMjc1LTQxNWEtOTIyNi0yNDRjM
  DIwMTk0NjA1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI1UEFHUElYX1NPTFVDQU9fRU1fUEFHQU1FTjYwMTRTQU9fQkVSTkFSRE9fRDYyMDcwNTAzKi
  oqNjMwNDI2Rjc=",
  "urlWebHook": "https://exemple/webhook/"
}

Documentação da API SyncPay - Cashout

Solicitação de Saques (Pix de Saída)

Endpoint: https://api.syncpay.pro/c1/cashout/api/

Descrição

Esse endpoint permite realizar requisições de saque via PIX, com autenticação por chave de API, validação de IP autorizado e cálculo de taxas e saldo líquido para cashout.

Formato de Requisição: JSON via POST
Autenticação:Pela Header
Cabeçalho:

Authorization: Basic {API_KEY}
content-type: application/json

Substitua {API_KEY} pela chave de API codificada em Base64.

Parâmetros da Requisição (JSON)

Campo	Tipo	Obrigatório	Descrição
api_key	string	Sim	Chave de API do usuário para autenticação.
amount	Number	Sim	Valor do saque solicitado em reais.
pixKey	string	Sim	Chave pix para recebimento.(Somente números) Caso "pixType": "PHONE" => incluir 55 antes do DDD
pixType	string	Sim	Tipo da chave.(CPF, CNPJ, EMAIL, PHONE, RANDOM)
beneficiaryName	string	Sim	Nome do beneficiário.
beneficiaryDocument	string	Sim	CPF do beneficiário
beneficiaryDocument	string	Não	Descrição
postbackUrl	string	Sim	URL de retorno para notificações de atualização.

Exemplo Json de Envio

 
        {
          "amount": 5.57,
          "pixKey": "56265478451",
          "pixType": "CPF",
          "beneficiaryName": "Claudio Barbosa Rios",
          "beneficiaryDocument": "56265478451",
          "description": "Pagamento generico",
          "postbackUrl": "https://suaplataforma/webhook"
        }

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações sobre a transação e o saldo atualizado.

Erros

Código	Mensagem	Descrição
401	API Key não fornecida	Cabeçalho de autenticação ausente ou inválido.
401	IP não autorizado	O IP do solicitante não está autorizado.
422	Dados inválidos	Faltam dados obrigatórios ou o valor é inválido.

Exemplo Json Response

 
{
	"data": {
		"amount": 1,
		"pixKey": "ebadc40c-87g5-4efb-7150-8b677b5bed3c",
		"pixType": "RANDOM",
		"beneficiaryName": "Lucas",
		"beneficiaryDocument": "65465432189",
		"description": "Saque bee-economy",
		"postbackUrl": "https://suaplataforma/webhook",
		"externalreference": "viNnGiXIcgMgXWm8750DRnS1LwOZKaKY",
		"status": "PENDING",
		"valor_liquido": "1.00",
		"idTransaction": "456daid6-15l1-4372-72b9-52r321gs8b07"
		},
	"status": 200,
	"message": "Cashout criado com sucesso.",
	"error": ""
}

Documentação da API SyncPay - Refund

Solicitação de Saques (Pix de Saída)

Endpoint: https://api.syncpay.pro/v1/gateway/api/refund/

Descrição

Esse endpoint permite realizar requisições de devolução de PIX por parte do recebedor. O valor pode ser devolvido parcialmente. Em nenhuma hipótese a soma das devoluções podem ultrapassar o valor da transação origem.

Formato de Requisição: JSON via POST
Autenticação:Pela Header
Cabeçalho:

Authorization: Basic {API_KEY}
content-type: application/json

Substitua {API_KEY} pela chave de API codificada em Base64.

Parâmetros da Requisição (JSON)

Campo	Tipo	Obrigatório	Descrição
api_key	string	Sim	Chave de API do usuário para autenticação.
id	Number	Sim	ID informado pelo seller para localizações futuras.
external_reference	Number	Sim	Referência externa da transação original que será reembolsada.

Exemplo Json de Envio

 
{
  "id": 3125413,
  "external_reference": "e65JzaGhjhyVQDK7TFHENKdasrn5BWO7O"
}

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações sobre a transação e o saldo atualizado.

Erros

Código	Mensagem	Descrição
401	API Key não fornecida	Cabeçalho de autenticação ausente ou inválido.
401	API Key não fornecida ou inválida.	Cabeçalho de autenticação ausente ou inválido.
403	Campos obrigatórios	Faltam dados obrigatórios ou o valor é inválido.
404	Transação não encontrada	Transação não localizada pelo External Reference informado.
401	Transação já foi reembolsada.	Transação já foi devolvida.

Exemplo Json Response

 
{
  "status": "success",
  "message": "Solicitação de devolução enviada com sucesso!",
  "rtrId": "D3038525920250303230647424c88eb2",
  "valor": "0.10",
  "idTransaction": "E00360305202502071525e88da9d19e1"
}

Documentação da API SyncPay - Webhook para Transações

Este webhook permite que o sistema receba notificações de transações de depósito e saque via JSON.

Endpoint

https://seuservidor.com/webhook.php

Descrição

Este webhook recebe notificações automáticas para depósitos e saques, fornecendo dados detalhados das transações. No caso de um depósito, o campo paymentCode pode ser usado para gerar um QR Code para pagamento.

Formato de Requisição: JSON via POST
Cabeçalho: Content-Type: application/json

Estrutura JSON da Requisição

1. Depósito

Campo	Tipo	Descrição
id	integer	ID da transação
user_id	integer	ID do usuário
externalreference	string	Referência externa da transação
amount	float	Valor do depósito
client_name	string	Nome do cliente
client_document	string	Documento do cliente
client_email	string	Email do cliente
data_registro	string	Data de registro da transação
adquirente_ref	string	Referência do adquirente
status	string	Status da transação
idtransaction	string	ID da transação de pagamento
paymentcode	string	Código para gerar QR Code de pagamento
paymentCodeBase64	string	QRCode em Base64
taxa_deposito	float	Taxa aplicada ao depósito
taxa_adquirente	float	Taxa do adquirente
deposito_liquido	float	Valor líquido do depósito

2. Saque

Campo	Tipo	Descrição
id	integer	ID da transação
user_id	integer	ID do usuário
externalreference	string	Referência externa da transação
amount	float	Valor do saque
beneficiaryname	string	Nome do beneficiário
beneficiarydocument	string	Documento do beneficiário
pix	string	Chave Pix
type	string	Tipo de saque
pixkey	string	Chave Pix
date	string	Data da transação
status	string	Status da transação
idtransaction	string	ID da transação de pagamento
taxa_cash_out	float	Taxa aplicada ao saque
cash_out_liquido	float	Valor líquido do saque

Exemplo de Código para Implementação do Webhook

O exemplo a seguir ilustra como configurar o webhook para receber e processar as notificações de transações.

 
                // webhook.php
                $data = file_get_contents("php://input");
                $jsonData = json_decode($data, true);
                
                if ($jsonData) {
                    if (isset($jsonData['client_name']) && isset($jsonData['paymentcode'])) {
                        $transactionType = 'Depósito';
                        $paymentCode = $jsonData['paymentcode']; // QR Code pode ser gerado com este código
                    } elseif (isset($jsonData['beneficiaryname']) && isset($jsonData['pixkey'])) {
                        $transactionType = 'Saque';
                    } else {
                        $transactionType = 'Desconhecido';
                    }
                
                    echo json_encode(['status' => 'success', 'message' => "$transactionType recebido com sucesso."]);
                } else {
                    http_response_code(400);
                    echo json_encode(['status' => 'error', 'message' => 'Dados inválidos.']);
                }

Envio WebHook CashIn

 
{
	"id": "54321",
	"user_id": "98765",
	"externalreference": "XYZ987LMN",
	"amount": 500.75,
	"client_name": "Jane Doe",
	"client_document": "98765432100",
	"client_email": "[email protected]",
	"data_registro": "2024-12-05T15:30:00Z",
	"adquirente_ref": "REF12345",
	"status": "paid_out",
	"idtransaction": "26755976-72f5-427c-a673-5e89e8849a36",
	"paymentcode": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/fa68393e-d275-415a-9226-244c0201946052
  04000053039865802BR5925PAGPIX_SOLUCAO_EM_PAGAMEN6014SAO_BERNARDO_D62070503***630426F7",
	"paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRici5nb3YuYmNiLnBpeDI1NjNwaXgudm9sdXRpLmNvbS5ici9xci92My9hdC9mYTY4MzkzZS1
  kMjc1LTQxNWEtOTIyNi0yNDRjMDIwMTk0NjA1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI1UEFHUElYX1NPTFVDQU9fRU1fUEFHQU1FTjYwMTRTQU9f
  QkVSTkFSRE9fRDYyMDcwNTAzKioqNjMwNDI2Rjc=",
	"taxa_deposito": 10.00,
	"taxa_adquirente": 5.00,
	"deposito_liquido": 485.75
}

Envio WebHook CashOut

 
{
	"id": "12345",
	"user_id": "67890",
	"externalreference": "ABC123DEF",
	"amount": 1000.50,
	"beneficiaryname": "John Doe",
	"beneficiarydocument": "12345678900",
	"pix": "[email protected]",
	"type": "email",
	"pixkey": "[email protected]",
	"date": "2024-12-05T12:34:56Z",
	"status": "completed",
	"idtransaction": "456daid6-15l1-4372-72b9-52r321gs8b07",
	"taxa_cash_out": 0.70,
	"cash_out_liquido": 999.80
}

Documentação da API SyncPay - Consulta postBacks

Atenção: Transação

Endpoint: https://api.syncpay.pro/s1/getPostBackExamples/

Descrição

Esse endpoint permite realizar a consulta de exemplos de webhooks enviados pela SyncPay.

Formato de Requisição: JSON via GET
Autenticação:Pela Header
Cabeçalho:

Authorization: Basic {API_KEY}
content-type: application/json

Substitua {API_KEY} pela chave de API codificada em Base64.

Body:Dispensado

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações do usuário

Erros

Código	Mensagem	Descrição
401	API Key não fornecida	Cabeçalho de autenticação ausente.
401	API Key incorreta.	API Key incorreta.

Exemplo Json Response

 
{
    "CashIn": {
        "description": "Webhook enviado quando um depósito via Pix é realizado.",
        "example": {
            "id": 12345,
            "user_id": "Lucas_dev",
            "externalreference": "GWuXrEH6oIaEg094WUDVz235xPAJ49Zf",
            "amount": 50,
            "client_name": "João Silva",
            "client_document": "12345678900",
            "client_email": "[email protected]",
            "data_registro": "2024-03-01 14:30:00",
            "adquirente_ref": "voluti",
            "status": "PAID_OUT",
            "idtransaction": "029d53e0454d0d9804babbf2f01195",
            "paymentcode": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/abfef891-41b2-45d6-b9ba-66d442b290b65204000053039865802BR5924SYNC_PAY_PAGAMENTOS_LTDA6009NOVO_GAMA62070503***6304DC16",
            "paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRici5nb3YuYmNiLnBpeDI1NjNwaXgudm9sdXRpLmNvbS5ici9xci92My9hdC9hYmZlZjg5MS00MWIyLTQ1ZDYtYjliYS02NmQ0NDJiMjkwYjY1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI0U1lOQ19QQVlfUEFHQU1FTlRPU19MVERBNjAwOU5PVk9fR0FNQTYyMDcwNTAzKioqNjMwNERDMTY=",
            "taxa_deposito": 7,
            "taxa_adquirente": 0.49,
            "deposito_liquido": 46.5
        }
    },
    "CashOut": {
        "description": "Webhook enviado quando uma retirada via Pix é realizada.",
        "example": {
            "id": 54321,
            "user_id": "Lucas_dev",
            "externalreference": "SJW1SoDDNnwvTOPzwGzIctXvK6hnX5vt",
            "amount": 200.75,
            "beneficiaryname": "Maria Oliveira",
            "beneficiarydocument": "98765432100",
            "pix": "[email protected]",
            "type": "",
            "pixkey": "[email protected]",
            "date": "2024-03-02 10:15:00",
            "status": "COMPLETED",
            "idtransaction": "E3038525920250122232856607a71d96",
            "taxa_cash_out": 2,
            "cash_out_liquido": 196.73,
            "dt_atualizacao": "2024-03-02 10:16:00"
        }
    },
    "Refund": {
        "description": "Webhook enviado quando um reembolso via Pix é processado.",
        "example": {
            "id": 12345,
            "user_id": "Lucas_dev",
            "externalreference": "GWuXrEH6oIaEg094WUDVz235xPAJ49Zf",
            "amount": 50,
            "client_name": "João Silva",
            "client_document": "12345678900",
            "client_email": "[email protected]",
            "data_registro": "2024-03-01 14:30:00",
            "adquirente_ref": "voluti",
            "status": "MED",
            "idtransaction": "029d53e0454d0d9804babbf2f01195",
            "paymentcode": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/abfef891-41b2-45d6-b9ba-66d442b290b65204000053039865802BR5924SYNC_PAY_PAGAMENTOS_LTDA6009NOVO_GAMA62070503***6304DC16",
            "paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRici5nb3YuYmNiLnBpeDI1NjNwaXgudm9sdXRpLmNvbS5ici9xci92My9hdC9hYmZlZjg5MS00MWIyLTQ1ZDYtYjliYS02NmQ0NDJiMjkwYjY1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI0U1lOQ19QQVlfUEFHQU1FTlRPU19MVERBNjAwOU5PVk9fR0FNQTYyMDcwNTAzKioqNjMwNERDMTY=",
            "taxa_deposito": 7,
            "taxa_adquirente": 0.49,
            "deposito_liquido": 46.5
        }
    }
}