Update - ZenPayments

Use this endpoint the update the equipment section of a Boarding Application

Just as in the dashboard, most of the fields are lockable.

Depending on permission you might not be able to update locked fields.

Important: Attempting to update a locked field or a lock flag without the appropriate permissions will simply return the old values for these fields as they won't be updated.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
   "equipment":{
      "used":{
         "value":"Equipment Name"
      },
      "note":{
         "value":"note"
      },
      "providedBy":{
         "value":"Deployment Center"
      }
   },
   "discountPeriod":{
      "value":"Daily"
   },
   "fundingPeriod":{
      "value":"TwoBusinessDays"
   },
   "type":{
      "value":"2"
   }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Update

application/json

Body

Example

{
    "equipment": {
        "used": {
            "value": "Equipment Name",
            "locked": "No"
        },
        "note": {
            "value": "note",
            "locked": "No"
        },
        "providedBy": {
            "value": "Deployment Center",
            "locked": "No"
        }
    },
    "varRequired": {
        "value": "No",
        "locked": "No"
    },
    "discountPeriod": {
        "value": "Daily",
        "locked": "No"
    },
    "fundingPeriod": {
        "value": "TwoBusinessDays",
        "locked": "No"
    },
    "type": {
        "value": "2",
        "locked": "No"
    },
    "emv": {
        "value": null,
        "locked": "No"
    },
    "mobileTerminal": {
        "value": null,
        "locked": "No"
    },
    "externalPinPad": {
        "value": null,
        "locked": "No"
    },
    "contactless": {
        "value": null,
        "locked": "No"
    },
    "existingTID": {
        "value": "No",
        "locked": "No",
        "terminals": [
            {
                "tid": 7000,
                "vNumber": null,
                "gateway": "Other",
                "note": null
            }
        ]
    },
    "serialNumberSettings": {
        "value": null,
        "locked": "No"
    },
    "pinDebitPad": {
        "value": null,
        "locked": "No"
    },
    "ebtFnsNumber": {
        "value": null,
        "locked": "No"
    },
    "terminal": {
        "paidBy": {
            "value": "Merchant",
            "locked": "No"
        },
        "paidAmount": {
            "value": null,
            "locked": "No"
        },
        "shipTo": {
            "value": null,
            "locked": "No"
        },
        "shipping": {
            "address": {
                "value": "",
                "locked": "No"
            },
            "method": {
                "value": null,
                "locked": "No"
            }
        },
        "communication": {
            "value": null,
            "locked": "No"
        },
        "batch": {
            "type": {
                "value": null,
                "locked": "No"
            },
            "period": {
                "value": null,
                "locked": "No"
            }
        },
        "header": {
            "value": "",
            "locked": "No"
        },
        "footerLine": {
            "value": null,
            "locked": "No"
        },
        "surcharge": {
            "feeDescription": {
                "value": null,
                "locked": "No"
            },
            "percentage": {
                "value": null,
                "locked": "No"
            },
            "bypassOption": {
                "value": null,
                "locked": "No"
            },
            "notes": {
                "value": null,
                "locked": "No"
            }
        },
        "tip": {
            "value": null,
            "locked": "No",
            "suggestion": {
                "value": "No",
                "locked": "No"
            }
        }
    },
    "lastEquipmentUpdated": "2024-02-15 12:44:47",
    "lastAgentReview": null
}