Peach Payments Public API Documentation
Initiate Checkout
POST {{baseUrl}}/checkout
Load the Checkout frontend to complete a payment. The POST request contains the entityId, signature, purchase parameters, and any custom parameters that a merchant optionally sends.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string | ||
Referer
|
string | Whitelisted Merchant Domain |
RESPONSES
status OK
| <html lang="en">
... |
Curl
curl -X POST 'baseUrl/checkout' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: text/html' -H 'Referer: merchantWebsite' --data-urlencode '%7B%22name%22%3D%3E%22authentication.entityId%22%2C+%22value%22%3D%3E%22entityId%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22signature%22%2C+%22value%22%3D%3E%22signature%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22merchantTransactionId%22%2C+%22value%22%3D%3E%22%3CPopulated+for+Checkout+request%3E%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22amount%22%2C+%22value%22%3D%3E%22100.00%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22paymentType%22%2C+%22value%22%3D%3E%22DB%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22currency%22%2C+%22value%22%3D%3E%22ZAR%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22nonce%22%2C+%22value%22%3D%3E%22autoNonce%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22shopperResultUrl%22%2C+%22value%22%3D%3E%22merchantWebsite%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22defaultPaymentMethod%22%2C+%22value%22%3D%3E%22CARD%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22forceDefaultMethod%22%2C+%22value%22%3D%3E%22false%22%2C+%22datatype%22%3D%3E%22boolean%22%7D&%7B%22name%22%3D%3E%22merchantInvoiceId%22%2C+%22value%22%3D%3E%22merchantInvoiceId%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customParameters%5Bexample%5D%22%2C+%22value%22%3D%3E%22example%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.merchantCustomerId%22%2C+%22value%22%3D%3E%220001%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.givenName%22%2C+%22value%22%3D%3E%22John%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.surname%22%2C+%22value%22%3D%3E%22Smith%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.mobile%22%2C+%22value%22%3D%3E%220712345678%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.email%22%2C+%22value%22%3D%3E%22johnsmith%40mail.com%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.status%22%2C+%22value%22%3D%3E%22NEW%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.birthDate%22%2C+%22value%22%3D%3E%221999-01-01%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.ip%22%2C+%22value%22%3D%3E%22192.168.1.1%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.phone%22%2C+%22value%22%3D%3E%220212345678%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22customer.idNumber%22%2C+%22value%22%3D%3E%221234567891234%22%2C+%22datatype%22%3D%3E%22number%22%7D&%7B%22name%22%3D%3E%22billing.street1%22%2C+%22value%22%3D%3E%221+Example+Road%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22billing.street2%22%2C+%22value%22%3D%3E%22LocalityA%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22billing.city%22%2C+%22value%22%3D%3E%22Cape+Town%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22billing.company%22%2C+%22value%22%3D%3E%22CompanyA%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22billing.country%22%2C+%22value%22%3D%3E%22ZA%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22billing.state%22%2C+%22value%22%3D%3E%22Western+Cape%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22billing.postcode%22%2C+%22value%22%3D%3E%227000%22%2C+%22datatype%22%3D%3E%22number%22%7D&%7B%22name%22%3D%3E%22shipping.street1%22%2C+%22value%22%3D%3E%221+Example+Road%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22shipping.street2%22%2C+%22value%22%3D%3E%22LocalityA%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22shipping.city%22%2C+%22value%22%3D%3E%22Cape+Town%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22shipping.company%22%2C+%22value%22%3D%3E%22CompanyA%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22shipping.postcode%22%2C+%22value%22%3D%3E%227000%22%2C+%22datatype%22%3D%3E%22number%22%7D&%7B%22name%22%3D%3E%22shipping.country%22%2C+%22value%22%3D%3E%22ZA%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22shipping.state%22%2C+%22value%22%3D%3E%22Western+Cape%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22cart.tax%22%2C+%22value%22%3D%3E%2215.00%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22cart.shippingAmount%22%2C+%22value%22%3D%3E%2212.25%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22cart.discount%22%2C+%22value%22%3D%3E%2202.25%22%2C+%22datatype%22%3D%3E%22string%22%7D&%7B%22name%22%3D%3E%22createRegistration%22%2C+%22value%22%3D%3E%22false%22%2C+%22datatype%22%3D%3E%22boolean%22%7D&%7B%22name%22%3D%3E%22notificationUrl%22%2C+%22value%22%3D%3E%22%22%2C+%22datatype%22%3D%3E%22null%22%7D&%7B%22name%22%3D%3E%22cancelUrl%22%2C+%22value%22%3D%3E%22%22%2C+%22datatype%22%3D%3E%22null%22%7D&%7B%22name%22%3D%3E%22cardTokens%22%2C+%22value%22%3D%3E%22%22%2C+%22datatype%22%3D%3E%22null%22%7D&%7B%22name%22%3D%3E%22allowStoringDetails%22%2C+%22value%22%3D%3E%22%22%2C+%22datatype%22%3D%3E%22null%22%7D'
ENDPOINTS