Create a session

Create a session token to initialize a connection

POST /platform/v1/session

cURL

cURL

curl --request POST \
  --url https://api.moonpay.com/platform/v1/session \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalCustomerId": "<string>",
  "deviceIp": "0.0.0.0"
}
'

200

{
  "sessionToken": "<string>"
}

Authorizations

Api-Key · string · header · required

Secret key provided as an Authorization header.

Example: Authorization: Api-Key <secretKey>

Body

application/json

externalCustomerId · string · required

A unique identifier for the customer from your system.

Required string length: 1 - 255

Example:

"user_01AN4Z07BY"

deviceIp · string<ipv4> string<ipv6> · required

The IP address of the user's device to ensure the integrity of the session. Both IPv4 and IPv6 values are supported.

Example:

"0.0.0.0"

Response

200

application/json

The request has succeeded.

sessionToken · string · required

An opaque session token used to set up a connection on your frontend. This token is single-use and must be generated each time the customer visits your app.

Token expires 24 hours after issuance.

Required string length: 1 - 8192

Example:

"c2Vzc2lvbi50b2tlbg"