Create management session

curl --request POST \
  --url https://api.paysway.dev/beneficiaries/organizations/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "externalUserId": "<string>",
  "returnUrl": "<string>",
  "options": {
    "allowedRecipientTypes": [
      "INDIVIDUAL"
    ],
    "allowedCountries": [
      "<string>"
    ]
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>"
}

POST

beneficiaries

organizations

sessions

Create management session

curl --request POST \
  --url https://api.paysway.dev/beneficiaries/organizations/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "externalUserId": "<string>",
  "returnUrl": "<string>",
  "options": {
    "allowedRecipientTypes": [
      "INDIVIDUAL"
    ],
    "allowedCountries": [
      "<string>"
    ]
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key

string<uuid>

required

The idempotency key is a unique value sent with a request to prevent duplicate processing caused by retries.

Body

application/json

externalUserId

string

required

returnUrl

string<uri>

required

options

object

Show child attributes

options.allowedRecipientTypes

enum<string>[]

A list of recipient types allowed in this session. - If only one element is provided (e.g. ["INDIVIDUAL"]), the session will be preselected to that type and the user will not see a choice. - If multiple are provided (e.g. ["INDIVIDUAL", "BUSINESS"]), the user can choose from the allowed types. - If field is omitted, the user will be able to choose from all available types.

Minimum array length: 1

Available options:

INDIVIDUAL,

BUSINESS

options.allowedCountries

string[]

A list of countries allowed in this session. - If only one element is provided (e.g. ["GB"]), the session will be preselected to that country and the user will not see a choice. - If multiple are provided (e.g. ["GB", "US"]), the user can choose from the allowed countries. - If field is omitted, the user will be able to choose from all available countries.

Minimum array length: 1

ISO 3166-1 alpha-2 code

Response

201 - application/json

Management session created successfully

string<uuid>

required

url

string<uri>

required

Account verification events List recipients

⌘I

Payment Preparation

Beneficiary Hub

Webhooks

Create management session

Authorizations

Headers

Body

Response