Environments

PaySway Docs

Introduction

Authentication

Versioning

Errors

Overview

Validate payment

Enrich payment

Management sessions

Payout methods

Data models

Data packaging

Distribution method

Implement handler

Register endpoint

Verify requests

Event object

Accepts the full or partial payment instruction and validates it against local and global payment regulations, scheme requirements, bank reference data, and heuristics.  If the payment details in the instruction are likely to be valid, the response will indicate success.  If there are issues, the response will include a list of validation errors with specific reasons.


Validate payment details

Transforms and completes the fields of the payment instruction to ensure payment success and enhance user experience.  It converts account numbers and bank details into formats acceptable for the selected payment method, provides routing inputs such as intermediary banks and supported payment schemes, and returns details such as bank name, address, and logo.


Enrich payment details

Creates a Beneficiary Hub management session for an organization end-user to manage their beneficiary details.


Create management session

Retrieves a list of recipients for an organization end-user by their external user ID.


List recipients

Retrieves a recipient of an organization end-user by the recipient ID


Get recipient

Retrieves a list of webhook subscriptions for an organization


List webhook subscriptions

Creates a webhook subscription for an organization to receive notifications about events.


Create webhook subscription

Retrieves a webhook subscription by the subscription ID


Get webhook subscription

Deletes a webhook subscription by the subscription ID


Delete webhook subscription

Updates a webhook subscription by the subscription ID


Environment	Base URL	Use For
Production	`https://api.paysway.io`	Live and fully tested integrations
Development	`https://api.paysway.dev`	All development and testing. Experiment, debug, and run end-to-end tests here. Data is fully isolated.

Get Started

Payment Preparation

Beneficiary Hub

Gamgem

Webhooks

Environments