Overview
Yoco is a South African card-payments provider – POS terminals + online checkouts + payment links. Used by 200k+ SA SMEs. The Automize Yoco connector covers checkouts, refunds, and webhooks.
- Regions: South Africa only.
- Plans: Pay-per-transaction. No monthly fees.
Setting up the connection
Auth type: Bearer Token.
- Yoco developer dashboard → API Keys → copy Secret Key.
- In Automize → Settings → Connectors → Yoco. Paste key.
Find your credentials at https://yoco.com/za/developers/.
Rate limits
Per-account, typical 60 req/min.
Data model
Checkout-based:
Merchant ─── Checkouts (hosted payment pages) ─── Payments ─── RefundsAvailable operations
4 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Create checkout | General | Create a payment checkout session via Yoco. |
| Get checkout | General | Get checkout details by ID from Yoco. |
| Get refund | General | Get refund details by ID from Yoco. |
| Refund payment | General | Refund a Yoco payment (full or partial). |
Operations
Create checkout
Create a payment checkout session via Yoco.
| Parameter | Required | Type | Description |
|---|---|---|---|
Amount (cents) amount | Yes | number | |
Currency currency | Yes | text | |
Success URL successUrl | Yes | text | |
Cancel URL cancelUrl | No | text | |
Failure URL failureUrl | No | text | |
Metadata metadata | No | text |
Tips
- amount + currency + lineItems + successUrl + cancelUrl.
- Returns redirectUrl. Send customer there.
Get checkout
Get checkout details by ID from Yoco.
| Parameter | Required | Type | Description |
|---|---|---|---|
Checkout ID checkout_id | Yes | text |
Tips
- checkout_id. Returns status + linked payment.
Get refund
Get refund details by ID from Yoco.
| Parameter | Required | Type | Description |
|---|---|---|---|
Refund ID refund_id | Yes | text |
Refund payment
Refund a Yoco payment (full or partial).
| Parameter | Required | Type | Description |
|---|---|---|---|
Payment ID paymentId | Yes | text | |
Amount (cents) amount | Yes | number | |
Metadata metadata | No | text |
Tips
- Refund a captured payment. amount in cents (omit for full).
FAQ
- POS terminal integration?
- Yoco POS terminals are separate from this API. This connector targets the online Checkouts API.
- Sandbox?
- Test mode keys + test cards available. Yoco doesn't have a separate sandbox URL.