POST

PaymentForms.Update

Update a payment form template (payment_forms). Mirrors dashboard Setting2::add_payment_form update. Also updates unpaid customer rows (payment_forms_paid where paid=0) linked to this template.

Permissions

  • User must be logged in with a valid bearer token.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Updates the requested PaymentForms record after validating permissions and input fields.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

  • Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
  • Send parameters as POST body fields exactly as documented.
  • Send date/time values in UTC Y-m-d H:i:s format when a date or datetime field is used.

Required Parameters

NameTypeSampleExplanation
payment_form_id
post
int342Template id. Aliases: id, data_id.

Optional Parameters

NameTypeSampleWhat it gives
form_name
post
stringUpdated nameForm name.
amount
post
string70Amount.
invoice_setting_id
post
int3Invoice company id.
payment_gatway
post
int7Payment gateway id.
iteam_type
post
stringproductItem type.
iteam_id
post
int120Linked item id.
regular_installments_document_type
post
stringreceipt,purchase_ordersDocument type for product/order flows (stored in payment_type_data JSON). Preferred over document_type.
document_type
post
stringreceiptAlias for regular_installments_document_type on product/order. For subscription/legacy flows stored in payment_forms.document_type column.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/PaymentForms.Update",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "payment_form_id": "342",
        "amount": "70"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/PaymentForms.Update",
    "url_domain": "https:\/\/{domain}\/app\/PaymentForms.Update"
}

Endpoint

POST /app/PaymentForms.Update
POST https://{user}.bull36.com/app/PaymentForms.Update
POST https://{domain}/app/PaymentForms.Update

Sample Output

{
    "success": 1,
    "payment_form_id": 342,
    "message": "Payment form updated successfully."
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('payment_form_id', '342');
body.set('amount', '70');

const res = await fetch('/app/PaymentForms.Update', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Payment form not found."
}