Create account session with permissions for the specified embedded components.

Production Environment

POST

/api/1/partner/merchant/{id}/account-session

Merchants

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

string <uuid>

required

Merchant ID (UUID)

Body Params application/json

components

object

required

See available component parameters here: https://docs.stripe.com/api/account_sessions/create

Example

{
  "components": {
    "account_onboarding": {
      "enabled": true
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.lopay.com/api/1/partner/merchant//account-session' \
--header 'Content-Type: application/json' \
--data-raw '{
    "components": {
        "account_onboarding": {
            "enabled": true
        }
    }
}'

Responses

🟢200OK

application/json

OK response

Body

stripeAccountId

string

required

Stripe account ID.

Example:

acct_1LmZQr2fwpTOCBRL

clientSecret

string

required

Account session ID client secret to pass to the Stripe embedded components.

expiresAt

string

required

ISO8601 date of when client secret expires.

returnUrl

string <uri>

required

Deeplink back into Lopay app

Example

{
  "stripeAccountId": "acct_1NkDjjJyhOZfPCWt",
  "clientSecret": "_OXIKXxEihJokDBnDoe2sgG5OGSO2Q12shKvbeboxpALZGng",
  "expiresAt": "2025-01-01T00:00:00.000Z",
  "returnUrl": "https://merchant.lopay.app/xxx"
}

🟠401Unauthorized

🟠404Record Not Found

Modified at 2025-03-03 16:34:00

Get merchant onboarding link

Get list of available hardware for given merchant to purchase