Quickstart

Vais fazer o teu primeiro pagamento em menos de 5 minutos.

1. Obter as API Keys

Cria uma conta em /auth/register. Após aprovação, vai a API Keys e copia a chave secreta (vps_live_…). Esta chave nunca deve ser usada em código frontend.

2. Iniciar uma transacção

O primeiro passo é sempre criar uma transacção pending. O endpoint devolve um transactionId interno que vais usar nos passos seguintes.

curl https://vorkpay.com/api/v1/payments/init \
  -H "Authorization: Bearer vps_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": "ORDER-123",
    "amount": 49.90,
    "currency": "EUR"
  }'

Resposta:

{
  "transactionId": "txn_abc123",
  "amount": 49.90,
  "currency": "EUR",
  "expiresAt": "2026-05-10T15:32:00Z"
}

3a. Cobrar via MB WAY

Envia uma notificação push para o telemóvel do cliente. Ele tem 4 minutos para confirmar.

curl https://vorkpay.com/api/v1/payments/mbway \
  -H "Authorization: Bearer vps_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "transactionId": "txn_abc123",
    "phoneNumber": "912345678"
  }'

3b. Cobrar via Multibanco

Gera uma referência multibanco (entidade + referência) válida por 3 dias.

curl https://vorkpay.com/api/v1/payments/multibanco \
  -H "Authorization: Bearer vps_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "transactionId": "txn_abc123" }'

Resposta:

{
  "entity": "24000",
  "reference": "123 456 789",
  "amount": 49.90,
  "expiresAt": "2026-05-13T14:32:00Z"
}

4. Receber confirmação

Quando o cliente paga, a rede bancária notifica o VorkPay e nós reencaminhamos um webhook assinado para a URL que configuraste em Webhook. Vê a documentação de webhooks para detalhes.

Próximo passo