Skip to main content
API docs by Redocly

Payment Embedded Session API (1.0.0)

Download OpenAPI specification:Download

Initiate Payment Session

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
PaymentDescriptor
string
Channel
string
Default: "QuickPay"

Available options are QuickPay and POS

ClientReference
string
PaymentSourceIdentifier
string
Array of objects (EmbeddedCharges)
object
object (ClientUserDto)

Responses

Request samples

Content type
application/json
{
  • "PaymentDescriptor": "string",
  • "Channel": "QuickPay",
  • "ClientReference": "string",
  • "PaymentSourceIdentifier": "string",
  • "Charges": [
    ],
  • "PaymentFields": {
    },
  • "ClientUser": {
    }
}

Response samples

Content type
application/json
{
  • "hasErrors": true,
  • "errors": [
    ],
  • "data": {
    }
}

Initiate Manage Autopay Session

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object (ClientAccountDto)
object (ClientUserDto)

Responses

Request samples

Content type
application/json
{
  • "ClientAccount": {
    },
  • "ClientUser": {
    }
}

Response samples

Content type
application/json
{
  • "hasErrors": true,
  • "errors": [
    ],
  • "data": {
    }
}

Initiate Manage Paperless Session

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object (ClientAccountDto)
object (ClientUserDto)

Responses

Request samples

Content type
application/json
{
  • "ClientAccount": {
    },
  • "ClientUser": {
    }
}

Response samples

Content type
application/json
{
  • "hasErrors": true,
  • "errors": [
    ],
  • "data": {
    }
}

Initiate Manage Wallet Session

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object (ClientUserDto)
EmailAddress
string
FirstName
string
LastName
string

Responses

Request samples

Content type
application/json
{
  • "ClientUser": {
    }
}

Response samples

Content type
application/json
{
  • "hasErrors": true,
  • "errors": [
    ],
  • "data": {
    }
}