Skip to main content

Prerequisites

1. Sign Up

  • Create a merchant account at PayIslands Dashboard.
  • After registration, retrieve your merchant_secret_key from Developer → Settings in the dashboard.

2. Modes of Operation

The API runs against the same production base URL:

https://ags.payislands.com

The mode depends on which API key you use:

  • Test Mode
    • Transactions are fully simulated.
    • No funds are moved, but responses, error codes, and workflows match real transactions.
    • Ideal for integration, debugging, and QA.
  • Live Mode
    • Transactions are real, irreversible payments.
    • Charges are settled and recorded in your merchant account.

Separate API keys are issued for Test and Live modes. Select the right key from Developer → Settings to switch between them.


3. Authentication & Security

  • All requests require your merchant_secret_key in the Authorization header:

    Authorization: Bearer <merchant_secret_key>
  • Keep this key safe. Do not expose it in client-side code (browser, mobile app, etc.).


4. SDKs & Libraries

Official SDKs are in progress. For now, you can integrate using any HTTP library such as:

  • JavaScript (Node.js): axios, fetch
  • Python: requests
  • cURL: CLI examples are provided in the docs

5. Testing

  • Use your Test API key for staging/QA.
  • In Test Mode, transactions are simulated: no funds are moved, but responses, error codes, and workflows mirror live behavior.
  • Reference routing (Test vs Live):
    • PIST... references are used for simulated test flows.
    • PISL... references are used for live/provider flows.
  • Card test instruments (PIST...): use these PANs to force specific outcomes in the simulator:
    • 4242424242424242 → success (next_action: confirm-transaction)
    • 4084084084084081 → OTP required (next_action: otp)
    • 4000000000001091 → 3DS redirect (next_action: redirect)
    • 4000000000000002 → decline
    • 4000000000000259 → timeout / no network
    • OTP test value (simulated OTP flow): 123456
  • Always confirm final status using the Transaction Verification endpoint (especially after checkout redirects or webhook delivery).

6. Go Live

  • Submit your integration for review.
  • Once approved, switch to production keys for live transactions.

7. Rate Limits

  • Default: 100 requests per minute per IP

  • Exceeding this returns:

    429 Too Many Requests
  • For higher limits, contact support.