Initiate redirect-based Checkout

POST {{baseUrl}}/checkout/initiate

Provides a redirect URL to the caller to redirect the user into the Checkout experience. The POST request contains the entityId, signature, purchase parameters, and any custom parameters that a merchant optionally sends. This allows the Checkout instance to be created from a backend without requiring a form post, or other similar method, from the frontend.

Request Body

[{"name"=>"authentication.entityId", "value"=>"{{entityId}}", "datatype"=>"string"}, {"name"=>"signature", "value"=>"{{signature}}", "datatype"=>"string"}, {"name"=>"merchantTransactionId", "value"=>"{{merchantTransactionId}}", "datatype"=>"string"}, {"name"=>"amount", "value"=>"100.00", "datatype"=>"string"}, {"name"=>"paymentType", "value"=>"DB", "datatype"=>"string"}, {"name"=>"currency", "value"=>"ZAR", "datatype"=>"string"}, {"name"=>"nonce", "value"=>"{{autoNonce}}", "datatype"=>"string"}, {"name"=>"shopperResultUrl", "value"=>"{{merchantWebsite}}", "datatype"=>"string"}, {"name"=>"defaultPaymentMethod", "value"=>"CARD", "datatype"=>"string"}, {"name"=>"forceDefaultMethod", "value"=>"false", "datatype"=>"boolean"}, {"name"=>"merchantInvoiceId", "value"=>"{{merchantInvoiceId}}", "datatype"=>"string"}, {"name"=>"customParameters[example]", "value"=>"example", "datatype"=>"string"}, {"name"=>"customer.merchantCustomerId", "value"=>"0001", "datatype"=>"string"}, {"name"=>"customer.givenName", "value"=>"John", "datatype"=>"string"}, {"name"=>"customer.surname", "value"=>"Smith", "datatype"=>"string"}, {"name"=>"customer.mobile", "value"=>"0712345678", "datatype"=>"string"}, {"name"=>"customer.email", "value"=>"johnsmith@mail.com", "datatype"=>"string"}, {"name"=>"customer.status", "value"=>"NEW", "datatype"=>"string"}, {"name"=>"customer.birthDate", "value"=>"1999-01-01", "datatype"=>"string"}, {"name"=>"customer.ip", "value"=>"192.168.1.1", "datatype"=>"string"}, {"name"=>"customer.phone", "value"=>"0212345678", "datatype"=>"string"}, {"name"=>"customer.idNumber", "value"=>"1234567891234", "datatype"=>"number"}, {"name"=>"billing.street1", "value"=>"1 Example Road", "datatype"=>"string"}, {"name"=>"billing.street2", "value"=>"LocalityA", "datatype"=>"string"}, {"name"=>"billing.city", "value"=>"Cape Town", "datatype"=>"string"}, {"name"=>"billing.company", "value"=>"CompanyA", "datatype"=>"string"}, {"name"=>"billing.country", "value"=>"ZA", "datatype"=>"string"}, {"name"=>"billing.state", "value"=>"Western Cape", "datatype"=>"string"}, {"name"=>"billing.postcode", "value"=>"7000", "datatype"=>"number"}, {"name"=>"shipping.street1", "value"=>"1 Example Road", "datatype"=>"string"}, {"name"=>"shipping.street2", "value"=>"LocalityA", "datatype"=>"string"}, {"name"=>"shipping.city", "value"=>"Cape Town", "datatype"=>"string"}, {"name"=>"shipping.company", "value"=>"CompanyA", "datatype"=>"string"}, {"name"=>"shipping.postcode", "value"=>"7000", "datatype"=>"number"}, {"name"=>"shipping.country", "value"=>"ZA", "datatype"=>"string"}, {"name"=>"shipping.state", "value"=>"Western Cape", "datatype"=>"string"}, {"name"=>"cart.tax", "value"=>"15.00", "datatype"=>"string"}, {"name"=>"cart.shippingAmount", "value"=>"12.25", "datatype"=>"string"}, {"name"=>"cart.discount", "value"=>"02.25", "datatype"=>"string"}, {"name"=>"createRegistration", "value"=>"false", "datatype"=>"boolean"}, {"name"=>"notificationUrl", "value"=>"", "datatype"=>"null"}, {"name"=>"cancelUrl", "value"=>"", "datatype"=>"null"}]

HEADERS

RESPONSES

status: Created

{"redirectUrl":"https://..."}