Payment Modes

Overview

The payment mode API enables the creation, retrieval, updating, and deletion of payment mode records. This documentation provides detailed information on the endpoints, request and response formats, and field descriptions.

Create

Endpoint: /api/message/payment_modes/{ Company }

This API will create a new Payment mode.

• Method: POST
• Content-Type: application/json
• Authentication: Bearer <token>

Request Body:

{ 
    "data_set": "<Data-set>",             //string
    "src_paym": "<source-payment-mode>",  //string
    "src_dsca": "<source-description>",   //string
}

Fields Details:

Field Name	Description	Data Type	Length
data_set	Data Set	String	10
src_paym	Source Payment Codes	String	3
src_dsca	Source Payment Description	String	120

---

Response Body: (Status: 200)

{
    "data_set": "<Data-set>",
    "src_dsca": "<source-description>",
    "src_paym": "<source-payment-mode>",
}

Fields Details:

Field Name	Description	Data Type	Example
data_set	Data Set	String	"Dataset1"
src_dsca	Source Payment Description	String	'CHEQUE PAYMENT"
src_paym	Source Payment Codes	String	"CQ5"

---

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request)

When both the Data set and Source Payment Mode is already present in the database:

{
    "message": "Record already exists!"
}

Response Body: (Status: 400 - Bad Request)

When invalid or wrong Data set is passed:

{
    "message": "Reference Error"
}

Response Body: (Status: 400 - Bad Request)

When invalid or wrong payment mode is passed:

{
    "message": "Reference Error: Payment Mode."
}

Response Body: (Status: 400 - Bad Request)

When there is an invalid data type is passed:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 500 - Internal Server Error)

When the mandatory fields are passed as an empty field:

{
    "message":  "Validation Errors|Validation 'isNotEmpty' failed for field 'data_set'|Validation 'isNotEmpty' failed for field 'src_paym'"
}

Update

Endpoint: /api/message/payment_modes/{ Company }

This API will update a Payment mode.

• Method: PUT
• Content-Type: application/json
• Authentication: Bearer <token>

Request Body:

{
    "data_set": "<Data-set>",            //string
    "src_paym": "<source-payment-mode>", //string
    "src_dsca": "<source-description>",  //string
}

Response Body: (Status: 200)

{  
    "data_set": "<Data-set>",
    "dsca": "<description>",
    "paym": "<payment>",
    "src_dsca": "<source-description>",
    "src_paym": "<source-payment-mode>",
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request)

When invalid or wrong Payment mode is passed:

{
    "message": "Reference Error: Payment Mode."
}

Response Body: (Status: 400 - Bad Request)

When there is an invalid data type is passed:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 400 - Bad Request)

When you are trying to update both the Data set and Source payment mode:

{
    "message": "Record not found!"
}

Response Body: (Status: 500 - Internal Server Error)

When the mandatory fields are passed as an empty field:

{
    "message":  "Validation Errors|Validation 'isNotEmpty' failed for field 'data_set'|Validation 'isNotEmpty' failed for field 'src_paym'"
}

Delete

Endpoint: /api/message/payment_modes/{ Company }/{ record_id }

This API will delete a Payment mode.

• Method: DELETE
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "Message": "Message Deleted Sucessfully!"
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 500 - Internal Server Error)

When invalid or wrong Payment mode id is paased:

{
    "Message": "Unable to Delete Record - Invalid Data Type"
}

Get

Endpoint: /api/message/payment_modes/{ Company }/{ record_id }

This API will get a Payment mode.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "data_set": "<Data-set>",
    "dsca": "<description>",
    "paym": "<payment>",
    "src_dsca": "<source-description>",
    "src_paym": "<source-payment-mode>",
}

Response Body: (Status: 200)

When invalid or wrong Payment mode id is paased:

{
    "message": "null"
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Get All

Endpoint: /api/messages/payment_modes/{ Company }/{ PageSize }/{ PageNumber }

This API will get all Payment modes.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

[
    {
        "data_set": "<Data-set>",
        "dsca": "<description>",
        "paym": "<payment>",
        "src_dsca": "<source-description>",
        "src_paym": "<source-payment-mode>",
    },
    .
    .
    .
]

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}