Skip to main content
POST
Generate PayFast Checkout Identifier

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Path Parameters

cartId
string<uuid>
required

The unique identifier for the cart

Response

A PayFast checkout was generated. The mode field indicates whether to open the onsite modal or redirect the customer.

mode
enum<string>

Which checkout flow to use.

Available options:
onsite,
redirect
identifier
string

The PayFast onsite payment identifier (present when mode is onsite).

engineUrl
string<uri>

The PayFast onsite engine script URL (present when mode is onsite).

redirectUrl
string<uri>

The PayFast redirect checkout URL (present when mode is redirect).