A management session is a short‑lived object that allows a beneficiary to manage payout methods in a PaySway-hosted UI.

​
Create a session

You can create a new management session by sending the following request:

POST /beneficiaries/organizations/sessions

{
  "requestId": "3e0f93e2-c2ad-4917-9eb7-f07262a60fc7",
  "externalUserId": "1dda592e-5b1d-47d2-b1de-e772fca15327",
  "returnUrl": "https://tenant.tld/return-url"
}

​
Session options

You can customize the beneficiary management session by providing the options field in your request. This allows you to restrict what a beneficiary can input.

The available options are:

FieldTypeDescription
allowedRecipientTypesstring[]Limit the session to INDIVIDUAL or BUSINESS recipients. If omitted the user may pick either type.
allowedCountriesstring[]List of ISO 3166 alpha‑2 country codes (e.g., GB, US). If omitted the user may add payout methods for any supported country.

Example with options

POST /beneficiaries/organizations/sessions

Request
{
  "requestId": "3e0f93e2-c2ad-4917-9eb7-f07262a60fc7",
  "externalUserId": "1dda592e-5b1d-47d2-b1de-e772fca15327",
  "returnUrl": "https://tenant.tld/return-url",
  "options": {
    "allowedRecipientTypes": ["INDIVIDUAL"],
    "allowedCountries": ["GB", "DE"]
  }
}