Specification
Payment Methods
Payment methods used by other API calls
List
List all active payment methods available on the platform for EFT Debit Orders, DebiCheck, Pay-in, Payouts and Card payments.
Path
GET /payment-methods
Response Body
The debicheck section only relate to DebiCheck payment methods and the payments section only relate to Pay-In and Payouts payment methods.
{
"status": true,
"payment_methods": [{
"id": "pam_abc123...",
"payment_method_type_lookups_id": "loo_abc123...",
"payment_industry_lookups_id": "loo_abc123...",
"abbreviated_name": "KWIK PAY",
"item_limit": "20000.00",
"monthly_limit": "200000.00",
"debicheck": {
"allow_date_adjustment": true,
"allow_variable_amount": false,
"allow_payment_tracking": true,
"payment_tracking_max_days": 2,
"adjustment_category_lookups_id": "loo_abc123...",
"adjustment_type_lookups_id": "loo_abc123...",
"adjustment_rate": "5.12345",
"adjustment_amount": "0.00",
"approval_window_lookups_id": "loo_abc123..."
},
"payments": {
"bank_name_lookups_id": "loo_abc123...",
"bank_branch_code": 632005,
"bank_account_number": "1201303338",
"bank_account_type_lookups_id": "loo_abc123...",
"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_lookups_id | String(32) | Unique lookups ID representing the type of payment method this is e.g. DebiCheck, EFT, Card | loo_abc123... |
| *.payment_industry_lookups_id | String(32) | Unique lookups ID representing the default type of payment e.g. Insurance Premium | loo_abc123... |
| *.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_lookups_id | String(32) | Unique lookups ID representing how often the amount of the collection is adjusted by default e.g. annually | loo_abc123... |
| *.debicheck.adjustment_type_lookups_id | String(32) | Unique lookups ID representing the type of adjustment to be done; rate or amount | loo_abc123... |
| *.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_lookups_id | String(32) | Unique lookups ID representing how long clients have to approve DebiCheck mandates. The default is 3 Days | loo_abc123... |
| *.payments.bank_name_lookups_id | String(32) | Unique lookups ID representing the name of the bank e.g. ABSA | loo_abc123... |
| *.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_lookups_id | String(32) | Unique lookups ID representing the type of bank account e.g. Cheque/Current | loo_abc123... |
| *.payments.bank_account_holder_name | string(30) | Bank account holder name as registered at the bank | J DOE |