Overview

Peach Payments is a South African payment gateway – cards, recurring, 3DS, instant EFT, checkouts. The Automize Peach Payments connector covers card payments, refunds, recurring tokens.

Regions: South Africa + Mauritius. Pan-African expansion underway.
Plans: Per-transaction pricing.

Setting up the connection

Auth type: API Key.

Peach Payments dashboard → API Keys → copy access token + entity ID.
In Automize → Settings → Connectors → Peach Payments. Paste credentials.

Find your credentials at https://dashboard.peachpayments.com/.

Rate limits

Per-account. Connector retries 429.

Data model

Card-focused:

    Payment ─┬─ Captures ─── Refunds
             └─ Registration Token (recurring card tokens)

Available operations

6 operations available. Click any row to jump to its detail.

Operation	Category	What it does
Create Checkout	General	Create a hosted checkout session
Create Payment	General	Create a server-to-server payment
Get Checkout Status	General	Get payment status for a checkout
Get Payment	General	Get payment details by ID
List Transactions	General	List transaction history
Refund Payment	General	Refund a payment

Operations

Create Checkout

Create a hosted checkout session

Parameter	Required	Type
Authentication.Entityid `authentication.entityId`	Yes	text
Amount `amount`	Yes	number
Currency `currency`	Yes	text
Paymenttype `paymentType`	Yes	text
Shopperresulturl `shopperResultUrl`	Yes	text

Tips

amount + currency + paymentType (DB=debit/sale, PA=preauth).
Returns id + redirect URL OR direct widget script.

Create Payment

Create a server-to-server payment

Parameter	Required	Type
Authentication `authentication`	Yes	text
Amount `amount`	Yes	number
Currency `currency`	Yes	text
Paymentbrand `paymentBrand`	Yes	text
Paymenttype `paymentType`	Yes	text
Card `card`	Yes	text

Tips

Direct server-to-server (requires PCI-DSS scope). Most builds use Checkout flow.

Get Checkout Status

Get payment status for a checkout

Parameter	Required	Type	Description
Checkoutid `checkoutId`	Yes	text

Get Payment

Get payment details by ID

Parameter	Required	Type	Description
Payment Id `payment_id`	Yes	text

List Transactions

List transaction history

No input parameters.

Refund Payment

Refund a payment

Parameter	Required	Type
Authentication `authentication`	Yes	text
Amount `amount`	Yes	number
Currency `currency`	Yes	text
Paymenttype `paymentType`	Yes	text
Payment Id `payment_id`	Yes	text

FAQ

3DS handling?: Peach handles 3DS for you in the Checkout flow. For server-to-server, 3DS results must be relayed via webhooks.

Peach Payments integration