Flowchart

This diagram illustrates the complete interaction flow between a merchant and the PayIslands API for processing payments. The system follows a RESTful architecture with four main operations:

1. Fetch Payment Items The merchant initiates the flow by retrieving all available payment items through a GET request. This returns a comprehensive list including item details such as names, amounts, categories (Government/Federal), transaction split codes, and status information. Authentication is handled via Bearer token in the Authorization header.

2. Get Specific Payment Item Details Once payment items are identified, merchants can fetch detailed information about a specific item using its unique ID. This endpoint provides focused data including the item's amount, form data requirements, and associated transaction split code, enabling the merchant to prepare for transaction initialization.

3. Initialize Transaction This is the core operation where merchants create a new payment transaction. The request includes:

• Callback URL for webhook notifications
• Selected payment item ID
• Payment channel (e.g., bank)
• Transaction amount
• Complete customer information (email, phone, name)

The API validates the request, particularly ensuring the amount matches the payment item's requirements. On success, it returns a transaction reference number for tracking. Failures (such as amount mismatches) return detailed error messages.

4. Retrieve Transaction History Merchants can query all historical transactions, receiving a list with transaction IDs, amounts, payment statuses (pending, completed, etc.), and reference numbers. This enables transaction monitoring, reconciliation, and reporting.

The diagram emphasizes the stateless nature of the API, with each request requiring authentication, and shows clear success/failure paths for robust error handling.