API Documentation

POST /auth/login

Authenticate and receive tokens.

curl -X POST https://go2pay.gd/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com", "password": "your_password"}'

Response:

{
  "success": true,
  "data": {
    "access_token": "eyJ...",
    "refresh_token": "eyJ...",
    "expires_in": 3600,
    "user": { "id": 123, "first_name": "John", "email": "you@example.com" }
  }
}

POST /auth/refresh

Refresh an expired access token using your refresh token (valid for 30 days).

curl -X POST https://go2pay.gd/api/v1/auth/refresh \
  -H "Content-Type: application/json" \
  -d '{"refresh_token": "eyJ..."}'

POST /products

Create a new product and receive a payment link.

curl -X POST https://go2pay.gd/api/v1/products \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Premium Plan",
    "price": 49.99,
    "description": "Monthly subscription",
    "endpoint": "https://mysite.com/webhook"
  }'

Response includes payment_url — share this link with customers:

{
  "success": true,
  "data": {
    "id": 123,
    "title": "Premium Plan",
    "price": 49.99,
    "payment_url": "https://go2pay.gd/123",
    ...
  }
}

GET /products

List your products. Supports ?page=1&q=search&type=product

GET /products/{id}

Get a single product with order stats and payment URL.

PUT /products/{id}

Update a product. Send only the fields you want to change.

DELETE /products/{id}

Archive (soft-delete) a product.

POST /requests

Create a payment request.

curl -X POST https://go2pay.gd/api/v1/requests \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "amount": 150.00,
    "description": "Invoice #1234",
    "send_email": true,
    "send_receipt": false
  }'

{
  "success": true,
  "data": {
    "id": 456,
    "payment_url": "https://go2pay.gd/456",
    "title": "John Doe",
    "price": 150.00,
    "email": "john@example.com",
    "email_sent": true
  }
}

send_email: false skips the payment-link email to the customer (email_sent will be false). send_receipt: false skips the customer's receipt email after they pay — use both when your site sends its own emails. The vendor's receipt copy and your webhook endpoint always fire regardless.

GET /requests

List your payment requests. Supports ?page=1&q=search

GET /requests/{id}

Get a single payment request with order stats.

DELETE /requests/{id}

Archive a payment request.

POST /subscriptions

Create a subscription plan. Returns a subscribe_url to share with customers.

curl -X POST https://go2pay.gd/api/v1/subscriptions \
  -H "Authorization: Bearer eyJ..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Gold Membership",
    "price": 9.99,
    "billing_interval": "monthly",
    "trial_days": 7,
    "setup_fee": 5.00
  }'

Response includes subscribe_url — share this link (or its QR / embed card) with customers:

{
  "success": true,
  "message": "Subscription created successfully",
  "data": {
    "id": 42,
    "name": "Gold Membership",
    "price": 9.99,
    "billing_interval": "monthly",
    "trial_days": 7,
    "cancel_on_dispute": true,
    "subscribe_url": "https://go2pay.gd/subscribe/2b3c…"
  }
}

GET /subscriptions

List your plans (paginated) with subscriber and revenue counts. Supports ?page=1&limit=20&q=search&include_archived=false.

GET /subscriptions/{id}

Get a plan with its list of subscribers.

PUT /subscriptions/{id}

Update a plan. Price/interval changes apply to future cycles only. Accepts the same fields as create.

DELETE /subscriptions/{id}

Archive a plan. It stops accepting new sign-ups; existing subscribers keep billing until cancelled.

GET /subscriptions/{id}/subscribers

List a plan's subscribers (status, card, next charge date, cycles).

POST /subscriptions/subscribers/{signupId}/cancel

Cancel a subscriber — they will not be charged again.

POST /subscriptions/subscribers/{signupId}/pause

Pause a subscriber's billing (excluded from charging while paused).

POST /subscriptions/subscribers/{signupId}/resume

Resume a paused subscriber. The next charge date shifts forward by the paused duration.

GET /orders

List orders. Supports ?page=1&status=PAID&q=search&product_id=123

GET /orders/{id}

Get a single order with full details.

POST /orders/{id}/refund

Refund an order through Stripe. Supports full and partial refunds; partial refunds may be repeated up to the order total.

Send an optional Idempotency-Key header to make retries safe — repeating a request with the same key will not refund twice.

curl -X POST https://go2pay.gd/api/v1/orders/789/refund \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: refund-789-001" \
  -d '{"amount": 25.00, "reason": "requested_by_customer"}'

Response:

{
  "success": true,
  "message": "Refund processed successfully",
  "data": {
    "order_id": 789,
    "refunded_amount": 25.00,
    "total_refunded": 25.00,
    "status": "PARTIAL REFUND",
    "stripe_refund_id": "re_3Ab1Cd..."
  }
}

status is PARTIAL REFUND while a balance remains, or REFUNDED once fully refunded.

GET /customers

List customers with order stats. Supports ?q=search

GET /customers/{id}

Get customer detail with last 10 orders.

Callback Payload

The following JSON is POSTed to your endpoint after a successful payment:

{
  "order_id": 789,
  "api_order_id": "your-external-id",
  "product_id": 123,
  "status": "PAID",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "phone": "473-123-4567",
  "price": 49.99,
  "qty": 1,
  "subtotal": 49.99,
  "customer_total": 52.44,
  "currency": "USD",
  "payment_id": "pi_xxx",
  "created": "2026-04-06T18:00:00+00:00"
}