Payment Mode

Create a Payment Mode

• Endpoint: {SERVER_URL}/api/method/eclectics.api.payment_mode.create

• Method: POST

• Payload:

{
    "mode_of_payment": "Mpesa",
    "enabled": "true",
    "type": "Cash",
    "default_account_number": "1110"
}

• Headers:

{
    "Authorization": "token <YOUR_TOKEN>"
}

Get a list of Payment Modes

• Endpoint: {SERVER_URL}/api/method/eclectics.api.payment_mode.list

• Method: GET

• Payload:

{
    "fields": ["mode_of_payment", "type", "enabled"],
    "filters": [],
    "start": 0,
    "page_length": 0,
    "order_by": "creation desc"
}

• Headers:

{
    "Authorization": "token <YOUR_TOKEN>"
}

• Refer to Document List API Parameters for guidance on the payload.

Get a single Payment Mode

• Endpoint: {SERVER_URL}/api/method/eclectics.api.payment_mode.get

• Method: GET

• Payload:

{
    "payment_mode": "Mpesa"
}

• Headers:

{
    "Authorization": "token <YOUR_TOKEN>"
}

Delete a Payment Mode

• Endpoint: {SERVER_URL}/api/method/eclectics.api.payment_mode.delete

• Method: DELETE

• Payload:

{
    "payment_mode": "Mpesa"
}