Skip to main content
Documentation Powered by Redocly

24SevenPay Checkout API (v1)

Download OpenAPI specification:Download

Checkout

/checkout

Request Body schema:
merchantReference
required
string [ 1 .. 36 ] characters
required
object (Customer)
object (InvoiceInformation)
totalAmount
integer <int64>
totalTaxAmount
integer <int64>
currency
required
string non-empty
required
Array of objects (OrderLine) non-empty
required
object (MerchantUrls)

Responses

Request samples

Content type
{
  • "merchantReference": "string",
  • "customer": {
    },
  • "invoiceInformation": {
    },
  • "totalAmount": 0,
  • "totalTaxAmount": 0,
  • "currency": "string",
  • "orderLines": [
    ],
  • "merchantUrls": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "products": [
    ]
}

/checkout/{id}

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "merchantId": 0,
  • "merchantReference": "string",
  • "customer": {
    },
  • "invoiceInformation": {
    },
  • "totalAmount": 0,
  • "totalTaxAmount": 0,
  • "currency": "string",
  • "orderLines": [
    ],
  • "products": [
    ],
  • "payments": [
    ],
  • "status": "string"
}

Payment

/checkout/{sessionId}/payment

path Parameters
sessionId
required
string <uuid>
Request Body schema:
productId
required
string <uuid> non-empty

Responses

Request samples

Content type
{
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "amount": 0,
  • "status": "string",
  • "redirects": [],
  • "authorizedOn": "2019-08-24T14:15:22Z"
}