API Documentation

Quick Start Guide

Get up and running with GoPayNow API in minutes

1. Authentication

All API requests require authentication using your API key. Include it in the Authorization header:

// Example request with authentication
curl -X GET "https://api.gopay.now/v1/payments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

2. Create Payment Link

Create a hosted payment link for your customers:

// Create payment link
POST /v1/payment-links
{
  "amount": 2500,
  "currency": "EUR",
  "description": "Invoice #1234",
  "customer_email": "customer@gopay.now"
}

API Endpoints

Comprehensive list of available endpoints and their usage

Payment Links

POST /v1/payment-links

Create payment link

GET /v1/payment-links/{id}

Get payment link details

PUT /v1/payment-links/{id}

Update payment link

DELETE /v1/payment-links/{id}

Cancel payment link

Wallet Operations

GET /v1/wallet/balance

Get wallet balance

POST /v1/wallet/transfer

Create P2P transfer

GET /v1/wallet/transactions

List transactions

GET /v1/wallet/transactions/{id}

Get transaction details

Bank Transfers

POST /v1/bank-transfers

Create IBAN transfer

GET /v1/bank-transfers/{id}

Get transfer status

GET /v1/bank-transfers

List all transfers

POST /v1/bank-transfers/{id}/cancel

Cancel transfer

Webhooks

Real-time notifications for payment events

Webhook Events

payment_link.completed

Triggered when a payment link is successfully paid

payment_link.failed

Triggered when a payment fails

wallet.transfer.completed

Triggered when a wallet transfer is completed

bank_transfer.completed

Triggered when a bank transfer is completed

Example Webhook Payload

{
  "id": "evt_1234567890",
  "object": "event",
  "type": "payment_link.completed",
  "created": 1641234567,
  "data": {
    "object": {
      "id": "pl_1234567890",
      "amount": 2500,
      "currency": "EUR",
      "status": "completed",
      "customer_email": "customer@gopay.now"
    }
  }
}

Error Handling

Understanding API error responses and status codes

HTTP Status Codes

200 - OK Success

Request was successful

400 - Bad Request Client Error

Invalid request parameters

401 - Unauthorized Auth Error

Invalid or missing API key

429 - Too Many Requests Rate Limit

Rate limit exceeded

Error Response Format

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_missing",
    "message": "Missing required parameter: amount",
    "param": "amount"
  }
}

Rate Limiting

Rate Limits

API requests are limited to 1000 requests per hour per API key. Check the X-RateLimit-Remaining header in responses.