MiPaymentChoice API: Custom Fields

Routes

Route	Description
GET /customfields/{Keys}	Gets a one or more 'pending', 'active', 'inactive' or 'deleted' custom fields for the merchant requester that match the comma-separated list of keys.
DELETE /customfields/{customFieldKeys}	Deletes one or more 'pending', 'active' or 'inactive' custom field for the merchant requester that match the comma-separated list of keys.
PATCH /customfields/{Key}	Updates a single custom field for the merchant requester with only the data provided.
PUT /customfields/{Key}	Updates a single custom field for the merchant requester by updating all fields to match the request (effectively, this replaces the resource, see PATCH to edit individual values). Please supply all values.
GET /customfields	Gets a collection of 'pending', 'active' and 'inactive' and possibly 'deleted' custom fields for the merchant requester.
POST /customfields	Creates a new custom field that can be either 'pending' or 'active'.

Request Headers

Header	Value
Authentication	Bearer [authentication (JWT) token]
Content-Type	application/json

Request Body

{
  "Name": "string",
  "IsNumeric": true,
  "ActivationStatus": "Pending",
  "DecimalPlaces": 0,
  "RegularExpression": "string",
  "IsRequired": true,
  "Description": "string",
  "ErrorMessage": "string",
  "MinValue": 0,
  "MaxValue": 0,
  "MaxLength": 0,
  "Position": 0,
  "DisplayOnVTReceipt": true,
  "DisplayOnReports": true,
  "DisplayOnHpp": true,
  "ReadOnlyOnHpp": true,
  "VisibleOnHpp": true
}

Parameter Details

Property	Required	Data	Additional Information
Name	Yes	String	The name of the the custom field (must be unique for this merchant).
IsNumeric	Yes	Boolean	Indicates if the custom field is a numeric value.
ActivationStatus	Yes	Enumeration	Defaults to 'Active'. 'Pending', 'Active', 'Inactive', 'Deleted'.
RegularExpression		String	Sets a validation Regular Expression for the custom field.
ErrorMessage		String	Indicates the error message value for the field. Cannot exceed 50 characters.

Response Body

{
  "Key": 0,
  "Name": "string",
  "MerchantKey": 0,
  "IsNumeric": true,
  "DecimalPlaces": 0,
  "RegularExpression": "string",
  "IsRequired": true,
  "ActivationStatus": "Active",
  "Description": "string",
  "ErrorMessage": "string",
  "MinValue": 0,
  "MaxValue": 0,
  "MaxLength": 0,
  "Position": 0,
  "DisplayOnVTReceipt": true,
  "DisplayOnReports": true,
  "DisplayOnHpp": true,
  "ReadOnlyOnHpp": true,
  "VisibleOnHpp": true
}