Exirom Payment API Documentation

Payment Method Identifier: EFT | Payment Type: BANK_TRANSFER

Swiffy EFT is a South African bank transfer payout method. The customer's bank account details and selected bank are submitted directly in the apmPayload — no redirect or QR code is needed. The request is processed server-to-server and the response returns actionType: NONE.

Currently supported for payouts via POST /api/v1/payouts/apm.

#Required Request Fields

Top-Level Fields

Field	Type	Description
`callbackUrl`	String	URL to receive transaction status updates
`successRedirectUrl`	String	URL to redirect the customer after successful payment
`failureRedirectUrl`	String	URL to redirect the customer after failed payment

Billing Details (ApmBillingDetails)

Field	Type	Description
`email`	String	The customer's email address used for communication or receipts

#Payload Structure

{
  "paymentMethod": "EFT",
  "paymentType": "BANK_TRANSFER",
  "account": "4051111222",
  "bank": "ABSA",
  "customer": "John Doe",
  "accountType": "cheque"
}

Payload Fields

Field	Type	Required	Description
`paymentMethod`	Enum	Yes	Must be set to `EFT`
`paymentType`	Enum	Yes	Must be set to `BANK_TRANSFER`
`account`	String	Yes	Customer's bank account number
`bank`	Enum	Yes	Destination bank — one of the supported banks
`customer`	String	Yes	Account holder name
`accountType`	String	Optional	Account type (e.g. `cheque`, `savings`)

#Supported Banks

ABSA, AFRIBANK, AL BARAKA BANK, BIDVEST, CAPITEC, CAPITEC BUSINESS, DISCOVERY, FIRSTRAND [TRADE SERVICES], FNB, INVESTEC, MERCANTILE, NEDBANK, OLDMUTUAL, RMB PRIVATE BANK, SASFIN, STANDARD, TYME

#Expected `apmResponseData`

{
  "paymentMethod": "EFT",
  "paymentType": "BANK_TRANSFER",
  "actionType": "NONE",
  "redirectUrl": null,
  "iframeUrl": null,
  "qrData": null,
  "qrDeepLink": null,
  "providerTransactionId": "820030759747217453"
}

#Response Fields

Field	Type	Description
`paymentMethod`	Enum	Always `EFT`
`paymentType`	Enum	Always `BANK_TRANSFER`
`actionType`	Enum	Always `NONE` — no customer redirect needed
`redirectUrl`	String	Always `null`
`iframeUrl`	String	Always `null`
`qrData`	String	Always `null`
`qrDeepLink`	String	Always `null`
`providerTransactionId`	String	Unique transaction ID from the payment provider

EFT results are typically asynchronous — the initial response may be PROCESSING / PENDING. Wait for the webhook to determine the final status.

#See Also

POST /api/v1/payouts/apm — Payout endpoint reference
Payout Flow — End-to-end APM payout flow
S2S Flow Payload — Generic S2S payload structure
APM Payload References — All supported payment methods