Debit Order API
Endpoint: {server}/api/collections/v1/ — see Getting started for the server URL, authentication and JSON Web Tokens.
API Post Functions
addCustomers
Endpoint: {server}/api/collections/v1/addCustomers
addCustomers: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| test | Boolean | O | Set to true if testing. This will bypass billing and will only validate test data |
| customer | Array | Y | 1-n of customer data to add |
addCustomers: CUSTOMER FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| uniqueReference | Text | Y | Your unique customer reference identifier |
| customerType | Text | Y | Identifies the customer. See listCustomerTypes |
| name | Text | Y | The first name of the account holder if customer type is Individual or the Entity name for all other customer types |
| lastName | Text | CY | Surname of the account holder if customer type is Individual. Required if customer type is Individual. |
| group | Text | O | The name of a group to assign the customer to |
| cellNumber | Text | O | The customers cell phone number |
| emailAddress | Text | O | The customers email address for correspondence |
| vatNo | Text | O | Customers vat number |
| addressLine1 | Text | O | Customers address |
| addressLine2 | Text | O | Customers address |
| addressLine3 | Text | O | Customers address |
| addressLine4 | Text | O | Customers address |
| Town | Text | O | Customers address |
| postalCode | Text | O | Customers address |
| paymentType | Text | Y | Customer payments are done via: - EFT - Debit Order - Cash (See listPaymentTypes) |
| identificationType | Text | CY | Identification type. Possible values are: SID – South African ID SPP – Passport number SBR – Business registration number TRN – Trust number Required if payment type is Debit Order |
| identificationNumber | Text | CY | The account holder's identity, passport, company registration or trust number. Required if payment type is Debit Order |
| bank | Text | CY | The Bank the account is held at (see listBankOptions). Required if payment type is Debit Order |
| accountType | Text | CY | The account type (see listAccountTypes). Required if payment type is Debit Order |
| accountNumber | Text | CY | The account number. Required if payment type is Debit Order |
| branchCode | Text | CY | The account branch code. Required if payment type is Debit Order |
| branchName | Text | O | The branch name |
addCustomers: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| Status | Text | Y | Number of customers imported |
| customer | Array | Y | 1-n of customer data added |
addCustomers: FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| uniqueReference | Text | Y | Your unique customer reference identifier |
| status | Text | Y | Success or Failed |
| message | Text | O | Provided if the status is Failed. This will be the failure reason |
| customerCode | Text | N | Provided if status is Success or there is already a customer. Customer Code is in alphanumeric format AAA000 and is the system code for the Customer |
Example addCustomer Post:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
Example addCustomer response:
:::warning Source conflict — confirm before use
This example wraps the results in customers and names each entry's identifier reference, while the tables above specify customer (RESPONSE FIELDS) and uniqueReference (FIELDS). The source document is inconsistent here and the correct field names have not been confirmed with the platform team.
:::
{
"jti": "<UNIQUE VALUE>",
"status": "1 of 2customer s imported",
"customers": [
{
"reference": "Ref1",
"status": "Success",
"customerCode": "JOE002"
},
{
"reference": "Ref2",
"status": "Failed",
"message": "Unique reference already exists",
"customerCode": "RON001"
}
]
}
updateCustomer
Endpoint: {server}/api/collections/v1/updateCustomers
updateCustomer: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| customers | Array | Y | 1-n of customer update data |
updateCustomer: FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| customerCode | Text | Y | The systems 6 character alphanumeric customerCode |
| uniqueReference | Text | O | Your unique customer reference identifier |
| customerType | Text | O | Identifies the customer. See listCustomerTypes below |
| name | Text | O | The first name of the account holder if customer type is Individual or the Entity name for all other customer types |
| lastName | Text | O | Surname of the account holder if customer type is Individual. Required if customer type is Individual. |
| group | Text | O | The name of a group to assign the customer to |
| cellNumber | Text | O | The customers cell phone number |
| emailAddress | Text | O | The customers email address for correspondence |
| vatNo | Text | O | Customers vat number |
| addressLine1 | Text | O | Customers address |
| addressLine2 | Text | O | Customers address |
| addressLine3 | Text | O | Customers address |
| addressLine4 | Text | O | Customers address |
| Town | Text | O | Customers address |
| postalCode | Text | O | Customers address |
| paymentType | Text | O | Customer payments are done via: - EFT - Debit Order - Cash (See listPaymentTypes) |
| identificationType | Text | O | Identification type. Possible values are: SID - South African ID SPP - Passport number SBR - Business registration number TRN - Trust number Required if Payment type is Debit Order |
| identificationNumber | Text | O | The account holder's identity, passport, company registration or trust number. Required if Debit Order |
| bank | Text | O | The Bank the account is held at (see listBankOptions). Required if payment type is EFT |
| accountType | Text | O | The account type (see listAccountTypes). Required if payment type is EFT |
| accountNumber | Text | CY | The account number. Required if payment type is EFT |
| branchCode | Text | O | The account branch code. Required if payment type is EFT |
| branchName | Text | O | The branch name |
updateCustomer: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| Jti | Text | Y | The unique JWT ID |
| status | Text | Y | Number of Customers Updated |
| customers | Array | Y | 1-n of each customer update submission |
updateCustomer: CUSTOMER FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| customerCode | Text | Y | The provided systems 6 character alphanumeric Customer Code |
| status | Test | Y | Success or Failed |
| message | Text | N | Provided the status is Failed. This will be the failure reason |
Example updateCustomer Post:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJ7UFJPVklERUQgQVBJIEtFWX0iLCJhY2Nlc3NUb2tlbiI6IntQUk9WSURFRCBBQ0NFU1MgVE9LRU59IiwianRpIjoie1VOSVFVRSBWQUxVRX0iLCJpYXQiOjE1ODk5OTA5MDIsImV4cCI6MTU4OTk5MTUwMn0._Lk6FPqYITrJIUztulif8MdvuOMAVBZXZJEiBpdSwkw ",
"customers": [
{
"customerCode": "JOE001",
"uniqueReference": "Ref1",
"customerType": "Individual",
"name": "Joe",
"lastName": "Soap",
"group": "Test",
"cellNumber": "0823456789",
"emailAddress": "joesoap@gmail.com ",
"addressLine1": "21 Jump Street",
"addressLine2": "Newlands",
"town": "Cape Town",
"postalCode": "7979",
"paymentType": "EFT",
"bank": "Standard Bank",
"accountType": "Cheque",
"accountNumber": "700000000",
"branchCode": "051001"
},
{
"customerCode": "RON001",
"bank": "ABSA",
"paymentType": "EFT",
"identificationType": "SID",
"identificationNumber": "7410025102082",
"accountType": "Cheque Account",
"accountNumber": "100000000",
"branchCode": " 632005"
}
]
}
Example updateCustomer Response:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
listCustomers
Endpoint: {server}/api/collections/v1/listCustomers
listCustomers: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| customerCodes | Text | O | Array of the systems 6 character alphanumeric Customer Code |
NOTE: customerCodes is optional and will return customer details of all customer codes in the request list. If customerCodes is not provided, then all customers on the system will be returned.
listCustomers: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| customers | Text | Y | Array Customers |
listCustomers: RESULT FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| customerCode | Text | Y | The systems 6 character alphanumeric Customer Code |
| customerType | Text | O | Identifies the customer. |
| name | Text | O | The first name of the account holder if customer type is Individual or the Entity name for all other customer types |
| lastName | Text | O | Surname of the account holder if customer type is Individual. Required if customer type is Individual. |
| uniqueReference | Text | O | Your unique customer reference identifier |
| group | Text | O | The name of a group to assign the customer to |
| identificationType | Text | O | The customer identification type |
| identificationNumber | Text | O | The customer identity number |
| cellNumber | Text | O | The customers cell phone number |
| emailAddress | Text | O | The customers email address for correspondence |
| vatNo | Text | O | Customers vat number |
| addressLine1 | Text | O | Customers address |
| addressLine2 | Text | O | Customers address |
| addressLine3 | Text | O | Customers address |
| addressLine4 | Text | O | Customers address |
| Town | Text | O | Customers address |
| postalCode | Text | O | Customers address |
| paymentType | Text | O | Customer payment type |
| bank | Text | O | The Bank the account is held at |
| accountType | Text | O | The account type |
| accountNumber | Text | O | The account number |
| branchCode | Text | O | The account branch code |
| branchName | Text | O | The branch name |
| message | Text | O | For Invalid Customer Codes |
Example listCustomers Post:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJ7UFJPVklERUQgQVBJIEtFWX0iLCJhY2Nlc3NUb2tlbiI6IntQUk9WSURFRCBBQ0NFU1MgVE9LRU59IiwianRpIjoie1VOSVFVRSBWQUxVRX0iLCJpYXQiOjE1ODk5OTA5MDIsImV4cCI6MTU4OTk5MTUwMn0._Lk6FPqYITrJIUztulif8MdvuOMAVBZXZJEiBpdSwkw ",
"customerCodes": [
"ABC001", "ABC002", "ABC003"
]
}
Example listCustomers response:
:::warning Source conflict — confirm before use
This example uses type, idType, idNumber, cellphone and email, while the RESULT FIELDS table above specifies customerType, identificationType, identificationNumber, cellNumber and emailAddress. The source document is inconsistent here and the correct field names have not been confirmed with the platform team.
:::
{
"jti": "{UNIQUE VALUE}",
"status": "List of Customer s",
"customers": [
{
"customerCode": "ABC001",
"uniqueReference": "Ref1",
"idType": "Business Registration Number",
"idNumber": "2008/027519/07",
"type": "Individual",
"name": "JOE SOAP",
"group": "Test",
"cellphone": "0823456789",
"email": " joesoap@gmail.com ",
"addressLine1": "21 Jump Street",
"addressLine2": "Newlands",
"town": "Cape Town",
"postalCode": "7979",
"paymentType": "EFT",
"bank": "Standard Bank",
"accountType": "Cheque",
"accountNumber": "700000000",
"branchCode": "051001"
},
{
"customerCode": "ABC002",
"message": "Does not exist"
}
]
}
addMandate
Endpoint: {server}/api/collections/v1/addMandate
NOTE: The addMandate method is to load mandates against existing customers setup with Debit Order payment type so that the collection can run on defined schedule. Calendar dates are in ISO 8601. Format of YYYY-MM-DD
addMandate: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| mandate | Text | O | 1-n of mandate data |
addMandate: PAYMENT FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| customerCode | Text | Y | The systems 6-character alphanumeric Customer Code of the customer to pay |
| mandateType | Text | Y | Written, Voice, or Digital |
| frequency | Text | Y | The collection frequency: onceoff, weekly, biweekly, monthly, bimonthly, annually, quarterly |
| collectionDays | Text | Y | The date(s), day of the week, or day of the month depending on frequency. Set day of month to 0 for last day of the month |
| dateFrom | Date | Y | The date from which the mandate is active from |
| dateTo | Date | O | The date the mandate is active to. If not set the mandate does not expire |
| amountType | Text | Y | Fixed or Variable |
| amount | Decimal | Y | The collection amount. When amountType is variable this value is the maximum amount the collection can be set to |
| variableAmount | Decimal | O | Set if the amountType is variable |
| bankReference | Text | O | Maximum 7 characters. Displayed in addition to your merchant short code on the customers bank statement |
| annualIncrease | Boolean | O | Set if the mandate must have an annual increase applied |
| increaseType | Text | CO | Options are % for percentage increase or R for increase amount |
| increaseAmount | Decimal | CO | The value or percentage amount based on increaseType |
| increaseDate | Date | CO | The date the increase must be applied |
| callCabinetID | Text | CO | Used if mandateType is Voice and the Call Cabinet voice recorder is used. |
| filename | Text | CO | Used for the mandate file |
| fileMimeType | Text | CO | IANA is the official registry of MIME media types and maintains a list of all the official MIME types |
| fileContent | Text | CO | Base64 encoded file contents |
addMandate: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| status | Text | Y | Number of mandates successful out of the number of requests submitted |
| mandates | Decimal | Y | 1-n of each mandate submitted |
addMandate: RESULT FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| customerCode | Text | Y | The systems 6 character alphanumeric Customer Code |
| mandateID | Text | Y | Success or Failed |
| status | Text | N | The mandate document ID |
| message | Text | O | Failure Reason |
Example addMandate Post:
:::warning Source conflict — confirm before use
This example wraps the payload in mandates, while the POST FIELDS table above specifies mandate. The source document is inconsistent here and the correct field name has not been confirmed with the platform team.
:::
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJ7UFJPVklERUQgQVBJIEtFWX0iLCJhY2Nlc3NUb2tlbiI6IntQUk9WSURFRCBBQ0NFU1MgVE9LRU59IiwianRpIjoie1VOSVFVRSBWQUxVRX0iLCJpYXQiOjE1ODk5OTA5MDIsImV4cCI6MTU4OTk5MTUwMn0._Lk6FPqYITrJIUztulif8MdvuOMAVBZXZJEiBpdSwkw ",
"mandates": [
{
"customerCode": "JOE001",
"mandateType": "written",
"frequency": "monthly",
"collectionDays": "1",
"dateFrom": "2021-11-01",
"dateTo": "2022-10-31",
"amountType": "variable",
"amount": 100.00,
"variableAmount": 75.00,
"bankReference": "SUPPORT",
"annualIncrease": true,
"increaseType": "%",
"increaseAmount": 10,
"increaseDate": "2022-01-01",
"filename": "mandate.pdf",
"fileMimeType": "application/pdf",
"fileContent": "/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNreQABAAQAAABkAAD/4QQIaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI /PiA8eDp4bX"
},
{
"customerCode": "JAC001",
"mandateType": "voice",
"frequency": "monthly",
"collectionDays": "1",
"dateFrom": "2021-11-01",
"dateTo": "2022-10-31",
"amountType": "fixed",
"amount": 100.00,
"bankReference": "CONTRAC",
"annualIncrease": false,
"callCabinetID": "5dd1d98d-6491-11ec-b074-0242ac120004"
}
]
}
Example addMandate response:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
cancelMandates
Endpoint: {server}/api/collections/v1/cancelMandate
cancelMandates: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| mandateIDs | Array | Y | 1-n of mandate ID's |
cancelMandates: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| status | Text | Y | Number of mandates cancelled out of the number of requests submitted |
| mandates | Array | Y | 1-n of each mandate ID |
cancelMandates: RESULT FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| mandateID | Text | Y | The System's Mandate ID |
| status | Text | Y | Cancelled or Failed |
| message | Text | O | Failure reason |
Example cancelMandates post:
:::warning Source conflict — confirm before use
This example uses mandates, while the parameter table above specifies mandateIDs. The source document is inconsistent here and the correct field name has not been confirmed with the platform team.
:::
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJ7UFJPVklERUQgQVBJIEtFWX0iLCJhY2Nlc3NUb2tlbiI6IntQUk9WSURFRCBBQ0NFU1MgVE9LRU59IiwianRpIjoie1VOSVFVRSBWQUxVRX0iLCJpYXQiOjE1ODk5OTA5MDIsImV4cCI6MTU4OTk5MTUwMn0._Lk6FPqYITrJIUztulif8MdvuOMAVBZXZJEiBpdSwkw ",
"mandates": [
"MA04235",
"MA04236"
]
}
Example cancelMandates response:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
changeMandateState
Endpoint: {server}/api/collections/v1/changeMandateState
changeMandateState: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| mandateIDs | Array | Y | 1-n of mandate ID's |
| state | Text | Y | Activate or Deactivate |
changeMandateState: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| status | Text | Y | Number of mandates cancelled out of the number of requests submitted |
| mandates | Array | Y | 1-n of each mandate ID |
changeMandateState: RESULT FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| mandateID | Text | Y | The System's Mandate ID |
| status | Text | Y | Cancelled or Failed |
| message | Text | Y | Failure Reason |
Example changeMandateState Post:
:::warning Source conflict — confirm before use
This example uses mandates, while the parameter table above specifies mandateIDs, and it omits state, which the table marks as required ("Activate or Deactivate"). The source document is inconsistent here and the correct form has not been confirmed with the platform team.
:::
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJ7UFJPVklERUQgQVBJIEtFWX0iLCJhY2Nlc3NUb2tlbiI6IntQUk9WSURFRCBBQ0NFU1MgVE9LRU59IiwianRpIjoie1VOSVFVRSBWQUxVRX0iLCJpYXQiOjE1ODk5OTA5MDIsImV4cCI6MTU4OTk5MTUwMn0._Lk6FPqYITrJIUztulif8MdvuOMAVBZXZJEiBpdSwkw ",
"mandates": [
"MA04235",
"MA04236"
]
}
Example changeMandateState Response:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
mandateStatus
Endpoint: {server}/api/collections/v1/mandateStatus
Use one of mandateIDs or customerCodes. Should customerCode be used, all mandates linked to that customer will be returned.
mandateStatus: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| Token | Text | Y | The signed JWT |
| mandateIDs | Array | CO | 1-n of Mandate ID's |
| customerCodes | Array | CO | 1-n of Customer Codes |
mandateStatus: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| status | Text | Y | Mandate Status Results |
| Mandates | Array | Y | 1-n of each Mandate ID |
mandateStatus: FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| mandateID | Text | Y | The mandate ID |
| customerCode | Text | Y | The systems 6 character alphanumeric Customer Code |
| status | Text | Y | - Active - Inactive - Authorised - Cancelled - Failed - Completed |
| message | Text | O | Failure reason |
| mandateType | Text | Y | Written, Voice, or Digital |
| frequency | Text | Y | The collection frequency: onceoff, weekly, biweekly, monthly, bimonthly, annually, Quarterly |
| collectionDays | Text | Y | The date(s), day of the week, or day of the month depending on frequency. Set day of month to 0 (Zero) for last day of the month |
| dateFrom | Date | Y | The date from which the mandate is active from |
| dateTo | Date | O | The date the mandate is active till |
| amountType | Text | Y | Fixed or Variable |
| amount | Decimal | Y | The collection amount. When amountType is variable this value is the maximum amount the collection can be set to |
| variableAmount | Decimal | O | Set if the amountType is variable |
| bankReference | Text | O | Maximum 7 characters. Displayed in addition to your merchant short code on the customers bank statement |
| annualIncrease | Boolean | O | Set if the mandate must have an annual increase applied |
| increaseType | Text | CO | Options are % for percentage increase or R for increase amount |
| increaseAmount | Decimal | CO | The value or percentage amount based on increaseType |
| increaseDate | Date | CO | The date the increase must be applied |
| lastCollectionDate | Date | O | Date of last collection |
| lastCollectionAmount | Decimal | O | Amount of last collection |
| lastCollectionResult | Text | O | Last collection result |
| lastCollectionResultMessage | Text | O | Last collection result message |
First example mandateStatus Post:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJ7UFJPVklERUQgQVBJIEtFWX0iLCJhY2Nlc3NUb2tlbiI6IntQUk9WSURFRCBBQ0NFU1MgVE9LRU59IiwianRpIjoie1VOSVFVRSBWQUxVRX0iLCJpYXQiOjE1ODk5OTA5MDIsImV4cCI6MTU4OTk5MTUwMn0._Lk6FPqYITrJIUztulif8MdvuOMAVBZXZJEiBpdSwkw ",
"mandateIDs": [
"MA04235",
"MA04236"
]
}
Second example mandateStatus Post:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJ7UFJPVklERUQgQVBJIEtFWX0iLCJhY2Nlc3NUb2tlbiI6IntQUk9WSURFRCBBQ0NFU1MgVE9LRU59IiwianRpIjoie1VOSVFVRSBWQUxVRX0iLCJpYXQiOjE1ODk5OTA5MDIsImV4cCI6MTU4OTk5MTUwMn0._Lk6FPqYITrJIUztulif8MdvuOMAVBZXZJEiBpdSwkw ",
"customerCodes": [
"TES001"
]
}
Example mandateStatus Response:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
changeVariableAmount
Endpoint: {server}/api/collections/v1/changeVariableAmount
changeVariableAmount: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
| Mandates | Array | Y | 1-n of mandate data |
changeVariableAmount: FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| mandateID | Text | Y | The System's Mandate ID |
| amount | Decimal | Y | Amount to change the variable amount to |
changeVariableAmount: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| Jti | Text | Y | The unique JWT ID |
| status | Text | Y | Changed or Failed |
| message | Text | O | Failure Reason |
Example changeVariableAmount Post:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
Example changeVariableAmount Response:
Example pending — this example could not be reconstructed reliably from the source document and is being prepared.
listAccountTypes
Endpoint: {server}/api/collections/v1/listAccountTypes
listAccountTypes: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
listAccountTypes: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| status | Text | Y | List of Account Types |
| accountTypes | Array | Y | 1-n of accountType |
listBankOptions
Endpoint: {server}/api/collections/v1/listBankOptions
listBankOptions: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
listBankOptions: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| status | Text | Y | List of Account Types |
| bankOptions | Decimal | Y | 1-n of banks and branches |
listCustomerTypes
Endpoint: {server}/api/collections/v1/listCustomerTypes
listCustomerTypes: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
listCustomerTypes: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| status | Text | Y | List of Account Types |
| customerTypes | Array | Y | 1-n of customerType |
listPaymentTypes
Endpoint: {server}/api/collections/v1/listPaymentTypes
listPaymentTypes: POST FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| token | Text | Y | The signed JWT |
listPaymentTypes: RESPONSE FIELDS
| Name | Type | Required | Description |
|---|---|---|---|
| jti | Text | Y | The unique JWT ID |
| status | Text | Y | List of Account Types |
| paymentTypes | Array | Y | 1-n of paymentType |
Errors
If there is any submission error relating to authentication or missing fields the response fields will be:
- status: The status will be Error
- error: The error message
Example Error Message:
{
"status": "Error",
"error": "Token secret verify fail"
}