inglês Español

Introdução Última atualização 2019-06-01

Você pode integrar pagamentos através do Paygol facilmente usando nossa Implementação Webcheckout, sem a necessidade de conhecimento técnico. Então Da mesma forma, oferecemos alternativas, como uma implementação Whitelabel Webcheckout e uma API abrangente para desenvolvedores que desejam funcionalidade adicional.

Todas as opções mencionadas acima permitem a notificação automática de pagamentos para sua plataforma, evitando a necessidade de entrega manual de produtos / serviços aos seus clientes.

Base URL: https://www.paygol.com

Webcheckout

Abaixo você encontrará um código de exemplo para o seu botão de pagamento. Basta substituir os valores de amostra conforme necessário e você estará pronto para começar a receber pagamentos.

POST /pay
Parâmetros
pg_serviceid
Requerido
string ID do comerciante Paygol
pg_price
Requerido
string Valor do pagamento: ex. 10.12
pg_currency
Requerido
string Tipo de moeda especificado no código alfabético ISO 4217
pg_country
Opcional
string código do país ISO 3166-2
pg_method
Opcional
string Código do método de pagamento
pg_email
Opcional
string Email do pagador
pg_first_name
Opcional
string Nome do pagador
pg_last_name
Opcional
string Sobrenome do pagador
pg_personalid
Opcional
string Número do documento do pagador
pg_phone
Opcional
string Número de telefone do pagador
pg_sub_merchant_id
Opcional
string Código usado para distinguir entre diferentes comerciantes que usam nosso serviço através de sua plataforma
pg_sub_merchant_url
Opcional
string Site do comerciante de onde o pagamento é originado
pg_return_url
Opcional
string Redirecionar url para pagamentos concluídos
pg_cancel_url
Opcional
string Redirecionar url para quando o pagamento falhar ou for cancelado pelo pagador
pg_language
Opcional
string idioma ISO 639-1
pg_name
Opcional
string Descrição do seu produto / serviço, que será mostrado na tela de pagamento (Max: 255)
pg_custom
Opcional
string Campo flexível, pode ser usado para rastrear usuário, estoque, etc. (Máx. 255)

API

Nossa implementação de API oferece um alto nível de personalização, permitindo que você implemente uma solução de pagamento de marca branca diretamente em sua plataforma de forma rápida e fácil.

Esta implementação é com base em chamadas POST para serviços da web, que fornecerão uma resposta no formato JSON. A resposta conterá o URL para o qual você deve redirecionar seus clientes para iniciar o processo de pagamento.

Assinatura da mensagem

Todos os pedidos à API de pagamento devem ser assinados usando a chave secreta do estabelecimento comercial com o algoritmo HMAC SHA256. A assinatura deve ser calculada usando a carga útil da solicitação, classificada em ordem crescente e adicionando este resultado em um cabeçalho de solicitação denominado X-Pg-Sig.

Obter token
Cabeçalhos
X-Pg-Sig
Requerido
string Solicitar assinatura HMAC-SHA256
Parâmetros
pg_serviceid
Requerido
string ID do comerciante Paygol
POST /api/v2/auth/token
Resposta 200 OK - Content-Type: application/json

{
  "token": "dce5b070ba65626dccd4ad700fdf3c1d219105a1"
}
							
Efetue um pagamento
Efetue um pagamento
X-Pg-Sig
Requerido
string Solicitar assinatura HMAC-SHA256
Parâmetros
pg_serviceid
Requerido
string ID do comerciante Paygol
pg_ip
Requerido
string Endereço IP do pagador.
pg_price
Requerido
string Valor do pagamento: ex. 10.12
pg_currency
Requerido
string Tipo de moeda especificado no código alfabético ISO 4217
pg_country
Requerido
string código do país ISO 3166-2
pg_method
Requerido
string Código do método de pagamento
pg_email
Requerido
string Email do pagador
pg_first_name
Opcional
string Nome do pagador
pg_last_name
Opcional
string Sobrenome do pagador
pg_personalid
Opcional
string Número do documento do pagador
pg_phone
Opcional
string Número de telefone do pagador
pg_sub_merchant_id
Opcional
string Código usado para distinguir entre diferentes comerciantes que usam nosso serviço através de sua plataforma
pg_sub_merchant_url
Opcional
string Site do comerciante de onde o pagamento é originado
pg_return_url
Requerido
string Redirecionar url para pagamentos concluídos
pg_cancel_url
Requerido
string Redirecionar url para quando o pagamento falhar ou for cancelado pelo pagador
pg_custom
Opcional
string Campo flexível, pode ser usado para rastrear usuário, estoque, etc. (Máx. 255)

Nota

Alguns países têm requisitos especiais para certos métodos de pagamento.

POST /api/v2/payment/create
Resposta 200 OK - Content-Type: application/json
{
  "data": {
    "service_id": "477980",
    "transaction_id": "OO3Q-73HT-ALEB-Y0G2",
    "status": "created",
    "payment_method": "webpay",
    "amount": "3500.00",
    "currency": "CLP",
    "payment_method_url": "https://www.paygol.com/api/pay-direct/OO3Q-73HT-ALEB-Y0G2",
    "custom": "Pago cuenta VIP",
    "customer": {
      "first_name": "Roberto",
      "last_name": "Fernandez",
      "email": "[email protected]",
      "phone": "",
      "personal_id": "",
      "country": "CL"
    },
    "redirect_urls": {
      "success_url": "http://www.mi-sitio.com/pago-ok",
      "cancel_url": "http://www.mi-sitio.com/pago-cancelado"
    }
  }
}
Verifique um pagamento
Cabeçalhos
X-Pg-Sig
Requerido
string Solicitar assinatura HMAC-SHA256
Parâmetros
pg_serviceid
Requerido
string ID do comerciante Paygol
pg_token
Requerido
string Token de autenticação
transaction_id
Requerido
string ID da transação Paygol
POST /api/v2/payment/status
Resposta 200 OK - Content-Type: application/json
{
  "payment": {
    "service_id": "477980",
    "transaction_id": "OO3Q-73HT-ALEB-Y0G2",
    "status": "completed",
    "payment_method": "webpay",
    "amount": "3500.00",
    "currency": "CLP",
    "created_at": "2021-01-02 23:11:00",
    "completed": "2021-01-02 23:13:00",
    "custom": "Pago cuenta VIP",
    "customer": {
      "first_name": "Roberto",
      "last_name": "Fernandez",
      "email": "[email protected]",
      "phone": "",
      "personal_id": "",
      "country": "CL"
    }
  }
}

Notificações

IPN (Notificação Instantânea de Pagamento) é uma notificação enviada de um servidor para outro através de uma chamada HTTP POST em relação às suas transações.

Para receber notificações de eventos em seu sistema, você deve ter configurado previamente um url de notificação ao qual Paygol tenha acesso.

Para garantir a segurança das trocas, os dados serão assinados usando o comerciante secret_key .

Nota

O URL de notificação e a secret_key podem ser encontrados no painel do comerciante, seção Notificações.

Confirmação

Se o seu script de notificação executa uma lógica muito complexa ou faz chamadas para a rede, é possível que o tempo de espera expire antes que Paygol receba a confirmação de recepção. Idealmente, o seu código que lida com o recebimento de notificações (reconhecimento com código de status 2xx) é independente de qualquer outra lógica.

Tratamento de notificações duplicadas

Os endpoints de notificação às vezes podem receber a mesma notificação mais de uma vez. É por isso que recomendamos que você evite recibos de notificação duplicados, tornando o processamento de seu evento idempotente.

Notificação de pagamento concluído
{
    "country": "CL",
    "completed_at": "2020-11-26T16:22:32-03:00",
    "currency": "CLP",
    "created_at": "2020-11-26T16:19:27-03:00",
    "custom": "Pago cuenta VIP",
    "method": "webpay",
    "price": "7500.00",
    "service_id": "477980",
    "status": "completed",
    "transaction_id": "ZISS-A7Q8-RE2Z-S73W",
}
	
Recuperar informações de notificação

Métodos de pagamento

Internacional
Cartão de crédito creditcard pg_phone é necessário para este método de pagamento
Bitcoin bitcoin
Argentina
Pago Fácil pagofacil pg_personalid é necessário para este método de pagamento
Rapipago rapipago pg_personalid é necessário para este método de pagamento
Brasil
Boleto Bancario boleto pg_personalid é necessário para este método de pagamento
Banco do Brazil bancodobrasil pg_personalid y pg_phone son Requerido para este método de pago
Bradesco bradesco pg_personalid y pg_phone é necessário para este método de pagamento
Itaú itau pg_personalid y pg_phone é necessário para este método de pagamento
Santander santander pg_personalid y pg_phone é necessário para este método de pagamento
Mercadopago mercadopago_br pg_personalid é necessário para este método de pagamento
Chile
Webpay webpay
Servipag servipag
Multicaja multicaja
MACH mach
Khipu khipu
Colombia
Efecty efecty
PSE pse
Via Baloto viabaloto
Bancolombia bancolombia
Apostar apostar
RedServi redservi
Puntored puntored
Susuerte susuerte
Su Red sured
Gana gana
Costa Rica
Banco de Costa Rica bcr
Banco Nacional bncr
Ecuador
Banco Pichincha pichincha
Banco Internacional internacional
Produbanco produbanco
México
Banamex banamex
Bancomer bancomer
Mastercard Débito debmaster
Visa Débito debvisa
OXXO oxxo
Santander santander
Perú
BBVA Continental bbva
BCP bcp
Caja Arequipa arequipa
Caja Cusco cusco
Caja Huancayo huancayo
Caja ICA ica
Caja Piura piura
Caja Tacna tacna
Caja Trujillo trujillo
Interbank interbank
Pago Efectivo pagoefectivo pg_phone é necessário para este método de pagamento
Scotiabank scotiabank
Western Union wu