Reference lists
Four endpoints return the permitted values for fields used elsewhere in the API. Each takes only the signed JWT and returns an array.
Use these rather than hard-coding values, since the lists change — bank options in particular.
listAccountTypes
POST {server}/api/payments/v2/listAccountTypes
Returns the account types that may be assigned to a supplier.
| Post field | Type | Required | Description |
|---|---|---|---|
token | Text | Y | The signed JWT |
| Response field | Type | Required | Description |
|---|---|---|---|
jti | Text | Y | The unique JWT ID |
status | Text | Y | List of Account Types |
accountTypes | Array | Y | 1–n of account type |
listBankOptions
POST {server}/api/payments/v2/listBankOptions
Returns the banks and branches that may be assigned to a supplier.
| Post field | Type | Required | Description |
|---|---|---|---|
token | Text | Y | The signed JWT |
| Response field | Type | Required | Description |
|---|---|---|---|
jti | Text | Y | The unique JWT ID |
status | Text | Y | Described as "List of Account Types" in the source guide |
bankOptions | Array | Y | 1–n of banks and branches (typed Decimal in the source guide — see known issues) |
listSupplierTypes
POST {server}/api/payments/v2/listSupplierTypes
Returns the supplier types that may be assigned to a supplier. The supplier type
determines whether lastName is required — it is compulsory where the type is
Individual.
| Post field | Type | Required | Description |
|---|---|---|---|
token | Text | Y | The signed JWT |
| Response field | Type | Required | Description |
|---|---|---|---|
jti | Text | Y | The unique JWT ID |
status | Text | Y | Described as "List of Account Types" in the source guide |
supplierTypes | Array | Y | 1–n of supplier type |
Values seen in the guide's examples include Individual and
Private Company (Pty) Ltd.
listPaymentTypes
POST {server}/api/payments/v2/listPaymentTypes
Returns the payment types that may be assigned to a supplier: EFT, Debit Order and Cash.
| Post field | Type | Required | Description |
|---|---|---|---|
token | Text | Y | The signed JWT |
| Response field | Type | Required | Description |
|---|---|---|---|
jti | Text | Y | The unique JWT ID |
status | Text | Y | Described as "Number of payments cancelled out of the number of requests submitted" in the source guide |
paymentTypes | Array | Y | 1–n of payment type |
PayShap is not a payment type you can request. It is not defined in the payload. The bank converts a real-time clearance instruction to PayShap automatically where the destination is a participating bank and the value does not exceed R50 000.00. See participating banks.