Checkout documentation
Published numerous Checkout documentation updates.
2025-07-03
Updated the Embedded Checkout documentation to highlight that you can use the onError event handler to hook into error events.
2025-07-02
Updated the Checkout V2 documentation with the payment methods endpoint which is the V2 version of merchant specs.
2025-06-27
Updated the Embedded Checkout documentation to highlight that you can use the onRemoveCard event handler to remove a stored card from the customer's profile.
2025-06-24
Updated the Checkout documentation to differentiate between V2 and V1 and:
- Added the V2 Status endpoint for querying the status of a checkout.
- Updated the V2 Initiate checkout endpoint to return a
redirectUrlto support Hosted Checkout.
2025-05-21
Updated the documentation to highlight that you can accept Google Pay and Samsung Pay with a Nedbank merchant account.
2025-05-14
Updated the documentation to remove the note about Google Pay and Samsung Pay not supporting forceDefaultMethod.
2025-04-11
Updated the Embedded Checkout documentation to describe how to:
- Disable and hide card brands (Visa, Mastercard, American Express, or Diners Club) without changing your Peach Payments account.
- Customise payment method availability.
- Configure the Embedded Checkout font.
- Customise the colour of payment method submit buttons.
2025-03-25
Updated the Embedded Checkout documentation to highlight that you can render Checkout using an HTML element.
2025-03-19
Updated the Embedded Checkout documentation to highlight improved SDK options in favour of new, more flexible options. The update also adds documentation for the onBeforePayment event and for card-specific customisation options:
- Custom submit button text (default:
Pay Now) - Show or hide card icon (default:
true) - Custom heading text (default:
Please enter your card details below to complete the payment.)
2025-03-14
Updated the Checkout webhook documentation to remove the content referring to the sending of two test webhooks.
2025-01-27
Updated the Embedded Checkout documentation to describe how to customise the Checkout user interface:
- For the payment method selection page and the landing page for each payment method (when you click into a payment method), you can remove the cancel button and amount.
- In addition to the above, you can remove the card brand field from the card payment form.
2024-11-18
Updated the Checkout documentation to link to the Python sample projects for Embedded and Hosted Checkout.
2024-11-07
Updated the Checkout documentation to include support for the cancelUrl parameter.
2024-10-08
Updated the Embedded Checkout documentation to include support for Apple Pay.
2024-06-26
Updated the Checkout documentation to remove support for FinChoicePay.
2024-04-15
Updated the Checkout documentation to add support for:
2024-03-13
Updated the Embedded Checkout documentation to include support for Payflex.
2024-02-12
Updated the Embedded Checkout documentation to include a React Native tutorial.
2024-01-29
Updated the Embedded Checkout documentation to include support for Pay by Bank and removed support for InstantEFT.
2024-01-23
Updated the Embedded Checkout documentation to include support for Mobicred.
2023-10-30
Updated the Embedded Checkout documentation to include support for ZeroPay.
2023-10-06
Published documentation describing Embedded Checkout and how to use it.
Also reorganised the Checkout category to group content for the different Checkout implementations together.
2022-09-22
Published the Checkout API reference.