Payment Method

The PostAddPaymentMethod endpoint is responsible for registering a new payment method in the MIMS system.

---

How to register a payment method

HTTP POST Request

Request Type	Example URL
POST	{{url_base}}/PostAddPaymentMethod
Example	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPaymentMethod"

Input Parameters

Parameter	Type	Required	Description
PaymentMethodNo	String(25)	Yes	External code of the payment method
DescriptionPayment	String(40)	Yes	Payment method description
InstallmentQty	Integer	Yes	Number of installments
ToleranceDays	Integer	No	Tolerance days
TolerancePercent	Float	No	Tolerance percentage
IsInactive	Boolean	No	Flag indicating that the payment method is inactive
ItemList	AddPaymentMethodItemList	Yes	List of payment method installments
OverwriteIfExists	Boolean	No	Flag indicating that data should be overwritten if the record already exists

📝 AddPaymentMethodItemList Object

The AddPaymentMethodItemList object represents a list with payment method installments.

Input Parameters

Parameter	Type	Required	Description
InstallmentNo	Integer	Yes	Installment number
InstallmentPercent	Float	Yes	Installment percentage
Days	Integer	No	Days for installment payment

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information in method execution
PaymentMethodCode	Integer	Yes	Internal payment method code generated in the MIMS system

---

Request Example

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPaymentMethod"' \
--header 'Content-Type: application/json' \
--data '{
    "PaymentMethodNo": "PM001",
    "DescriptionPayment": "Pagamento à Vista",
    "IsInactive": false,
    "InstallmentQty": 1,
    "ToleranceDays": 0,
    "TolerancePercent": 0,
    "OverwriteIfExists": true,
    "ItemList": [
        {
            "InstallmentNo": 1,
            "InstallmentPercent": 100.0,
            "Days": 0
        }
    ]
}'

---

Response Example

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "PaymentMethodCode": 123
}

---

🐞 Possible Errors

Code	Message
APM‑001	The provided External Payment Method Code parameter (PaymentMethodNo) already exists!

---