Pagamentos

Crie e gira transações de pagamento utilizando a API do PaysGator.

Criar Pagamento

Cria uma nova transação de pagamento e gera um link de checkout para o cliente.

Endpoint: POST /payment/create

Corpo do Pedido

Campo	Tipo	Descrição	Obrigatório
amount	number	O valor a cobrar (ex: 100.00)	Sim
currency	string	Código de Moeda ISO 4217 (ex: USD, MZN)	Sim
externalTransactionId	string	O seu ID de referência interno para o pedido	Não
payment_methods	array	Métodos de pagamento permitidos (ex: ["MPESA", "CARD"])	Não
fields	array	Campos a recolher do cliente (ex: ["name", "email"])	Não
returnUrl	string	URL para redirecionar o cliente após o pagamento	Não
metadata	object	Dados personalizados adicionais anexados à transação	Não

Exemplo de Pedido

{
  "amount": 100.00,
  "currency": "USD",
  "externalTransactionId": "order_12345",
  "payment_methods": ["MPESA", "CARD"],
  "fields": ["name", "email"],
  "returnUrl": "https://example.com/success",
  "metadata": {
    "title": "Subscrição Premium",
    "description": "Plano premium mensal"
  }
}

Resposta de Sucesso

{
  "success": true,
  "data": {
    "paymentlinkId": "uuid-v4-payment-link-id",
    "checkoutUrl": "https://paysgator.com/checkout/uuid-v4",
    "transactionId": "uuid-v4-transaction-id"
  }
}

---

Confirmar Pagamento

Confirma um pagamento diretamente se estiver a recolher os detalhes de pagamento na sua própria página de checkout.

Endpoint: POST /payment/confirm

Corpo do Pedido

Campo	Tipo	Descrição	Obrigatório
paymentLinkId	string	O ID do link de pagamento a confirmar	Sim
paymentMethod	string	O método de pagamento a utilizar (ex: MPESA)	Sim
payment_fields	object	Campos específicos do método (ex: phoneNumber)	Não
customer	object	Detalhes do cliente (name, email, phone, etc.)	Não

Exemplo de Pedido

{
  "paymentLinkId": "uuid-v4-payment-link-id",
  "paymentMethod": "MPESA",
  "payment_fields": {
    "phoneNumber": "841234567"
  },
  "customer": {
    "name": "John Doe",
    "email": "john@example.com"
  }
}

Resposta de Sucesso

{
  "success": true,
  "data": {
    "transactionId": "uuid-v4-transaction-id",
    "fee": 2.50,
    "netAmount": 97.50
  }
}