Create a payment session

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*

The amount information

merchantAccount*string

The merchant account identifier

merchantId?string

The Apple Pay merchant identifier

reference*string

The reference to uniquely identify a payment

returnUrl*string

The URL to return to

additionalData?object

Additional data

allowedPaymentMethods?array<>

List of allowed payment methods

blockedPaymentMethods?array<>

List of blocked payment methods

channel?string

The platform where a payment transaction takes place

Value in"iOS" | "Android" | "Web"

countryCode?string

The shopper country code

expiresAt?string

Date and time when the session expires

lineItems?array<>

Line items for the payment

merchantOrderReference?string

The merchant order reference

mode?string

Session mode

Value in"embedded" | "hosted"

recurringProcessingModel?string

The recurring processing model

Value in"CardOnFile" | "Subscription" | "UnscheduledCardOnFile"

shopperEmail?string

The shopper email address

shopperInteraction?string

Specifies the sales channel

Value in"Ecommerce" | "ContAuth" | "Moto" | "POS"

shopperLocale?string

The shopper locale

shopperReference?string

The shopper reference

storePaymentMethod?boolean

Indicates whether to store the payment method

storePaymentMethodMode?string

Store payment method mode (enabled, disabled, askForConsent)

store?string

The store identifier

telephoneNumber?string

Shopper telephone number

dateOfBirth?string

Shopper date of birth (YYYY-MM-DD)

socialSecurityNumber?string

Shopper social security number

deliveryAddress?

Delivery address

billingAddress?

Billing address

transactionType?string

Transaction type

Default"sale"

Value in"sale" | "validation"

Response Body

`application/json`

curl -X POST "https://api.plexypay.com/v2/sessions" \  -H "Content-Type: application/json" \  -d '{    "amount": {      "currency": "string",      "value": 0    },    "merchantAccount": "string",    "reference": "string",    "returnUrl": "string"  }'

{
  "id": "string",
  "expiresAt": "string",
  "amount": {
    "currency": "string",
    "value": 0
  },
  "merchantAccount": "string",
  "merchantId": "string",
  "reference": "string",
  "returnUrl": "string",
  "mode": "string",
  "sessionData": "string",
  "url": "string",
  "channel": "iOS",
  "countryCode": "string",
  "shopperLocale": "string",
  "shopperReference": "string",
  "shopperInteraction": "string",
  "recurringProcessingModel": "string",
  "storePaymentMethodMode": "string",
  "telephoneNumber": "string",
  "dateOfBirth": "string",
  "socialSecurityNumber": "string",
  "billingAddress": {
    "city": "string",
    "country": "string",
    "houseNumberOrName": "string",
    "postalCode": "string",
    "street": "string"
  },
  "deliveryAddress": {
    "city": "string",
    "country": "string",
    "houseNumberOrName": "string",
    "postalCode": "string",
    "street": "string"
  },
  "lineItems": [
    {
      "quantity": 0,
      "amountExcludingTax": 0,
      "taxPercentage": 0,
      "description": "string",
      "id": "string",
      "taxAmount": 0,
      "amountIncludingTax": 0,
      "taxCategory": "string",
      "productUrl": "string",
      "imageUrl": "string"
    }
  ]
}

Create a payment session

Request Body

Response Body

201application/json

`application/json`