Payment Methods
Retrieve available payment methods including EFT Debit Orders, DebiCheck, Registered Mandates, Card payments, and Pay-in methods. Essential for determining supported banks and payment options for your customers.
List
List all active payment methods available on the platform.
Path
GET /payment-methods
Response Body
The debicheck section relates to both DebiCheck and Registered Mandate (RM) payment methods. RM is very much like DebiCheck except there is no approval window component and as such the approval window is not relevant for RM.
The payments section only relate to Pay-In and Payouts payment methods.
{
"status": true,
"payment_methods": [{
"id": "pam_abc123...",
"payment_method_type": "DEBIT_ORDER",
"payment_industry": "ACCOUNT_REPAYMENT",
"provider_bank": "ABSA_BANK_LIMITED",
"abbreviated_name": "KWIK PAY",
"item_limit": "20000.00",
"monthly_limit": "200000.00",
// DebiCheck & Registered Mandates
"debicheck": {
"allow_date_adjustment": true,
"allow_variable_amount": false,
"allow_payment_tracking": true,
"payment_tracking_max_days": 2,
"adjustment_category": "ANNUALLY",
"adjustment_type": "RATE",
"adjustment_rate": "5.12345",
"adjustment_amount": "0.00",
"approval_window": "BATCH_TT2_APPROVE_BY_19H00_ON_DAY_2"
},
// Pay-In & Payouts
"payments": {
"bank_name": "ABSA_BANK_LIMITED",
"bank_branch_code": 632005,
"bank_account_number": "1201303338",
"bank_account_type": "CHEQUE_OR_CURRENT",
"bank_account_holder_name": "J DOE"
}
}, {
...
}]
}
Response Parameters
| Field | Type | Description | Example |
|---|---|---|---|
| status | Boolean | true - success, false - error | true |
| payment_methods | Array of objects | ||
| *.id | String(32) | Unique ID of the payment method to be used in other API calls | pay_abc123... |
| *.payment_method_type | ENUM | (1VOUCHER,APPLE_PAY,CARD,DEBICHECK,DEBIT_ORDER,GOOGLE_PAY,HAPPY_PAY,MONEYBADGER,OZOW,PAYIN,PAYOUTS,RCS,REGISTERED_MANDATES,SCAN_TO_PAY,SCODE,SNAPSCAN,ZAPPER) | DEBICHECK |
| *.payment_industry | ENUM | (ACCOUNT_REPAYMENT,BOND_REPAYMENT,CHARITABLE_OR_RELIGIOUS_CONTRIBUTIONS,H_P__REPAYMENT,INSURANCE_PREMIUM,LOAN_REPAYMENT_OTHER_THAN_MORTGAGE,MEDICAL_AID_FUND_CONTRIBUTION,PENSION_FUND_CONTRIBUTION,RENT_PROPERTY,RENTALLEASE_OTHER_THAN_PROPERTY,SERVICE_CHARGE_MAINTENANCE,SERVICE_CHARGE_VARIABLE_AMOUNTS,UNIT_TRUST_PURCHASE) | ACCOUNT_REPAYMENT |
| *.provider_bank | ENUM | (ABSA_BANK_LIMITED,NEDBANK) | NEDBANK |
| *.abbreviated_name | String(8) | Unique reference that will appear on the statement | KWIK PAY |
| *.item_limit | Decimal | Maximum amount a single collection may bill on a given day | 20000.00 |
| *.monthly_limit | Decimal | Maximum amount this payment method may collect in a month's time | 200000.00 |
| *.debicheck.allow_date_adjustment | Boolean | true - collections may be collected on days other than the billing day specified by the mandate. | true |
| *.debicheck.allow_variable_amount | Boolean | true - collection amounts may differ from the amount specified by the mandate as long as it is less than the maximum collection amount specified. | false |
| *.debicheck.allow_payment_tracking | boolean | true - allow failed payments to be re-presented up to a maximum amount of days. However these re-presentments become disputable | false |
| *.debicheck.payment_tracking_max_days | Integer | Up to how many days are failed payments allowed to be re-presented | 2 |
| *.debicheck.adjustment_category | ENUM | How often the amount of the collection is adjusted. (ANNUALLY,BIANNUALLY,NEVER,QUARTERLY) | NEVER |
| *.debicheck.adjustment_type | ENUM | Type of adjustment to be done. (AMOUNT,RATE) | AMOUNT |
| *.debicheck.adjustment_rate | Decimal | Adjust the collection amount by this percentage per adjustment category e.g. 5.12345% per year | 5.12345 |
| *.debicheck.adjustment_amount | Decimal | Adjust the collection amount by this amount per adjustment category e.g. R 10.25 per year. Either adjustment_rate or adjustment_amount must be specified when the adjustment category is set; both may not be used at the same time. | 10.25 |
| *.debicheck.approval_window | ENUM | How long clients have to approve DebiCheck mandates. The default is 3 Days. Does NOT apply to Registered Mandates. (BATCH_TT2_APPROVE_BY_19H00_ON_DAY_2,DELAYED_REAL_TIME_TT1_APPROVE_BY_20H00_ON_THE_SAME_DAY,MAC_TT3_MESSAGE_AUTHENTICATION_CODE_CARD_AND_PIN,REAL_TIME_TT1_APPROVE_WITHIN_120_SECONDS_CELLPHONE_MUST_MATCH_BANK,REAL_TIME_TT1_APPROVE_WITHIN_120_SECONDS_SENT_TO_BANK_CELLPHONE) | BATCH_TT2_APPROVE_BY_19H00_ON_DAY_2 |
| *.payments.bank_name | ENUM | (ABSA_BANK_LIMITED,NEDBANK) | NEDBANK |
| *.payments.bank_branch_code | integer | Universal branch code associated with the bank name e.g. 632005 for ABSA | 632005 |
| *.payments.bank_account_number | string(17) | Bank account number to be used for payments | 1201303338 |
| *.payments.bank_account_type | ENUM | (CHEQUE_OR_CURRENT,SAVINGS,TRANSMISSION) | CHEQUE_OR_CURRENT |
| *.payments.bank_account_holder_name | string(30) | Bank account holder name as registered at the bank | J DOE |
Lookups
Retrieve reference data and validation values used across the API including bank names, account types, countries, provinces, client types, and ID types. Essential for populating dropdown lists and validating form inputs.
Customers
Manage customer records including personal details, billing and shipping addresses, ID verification, and metadata. Create, update, retrieve, and delete customer profiles for payment processing and mandate management.