Create Custom Fields for Customers

You can create custom fields for your customers which you would then pass into the create customer route

post/v3/field

Request

Base URL
https://sandbox.api.mxmerchant.com/checkout
Auth
HTTP basic
TypeScript
https://skmtc.dev/mxmerchant/apis/checkout-api/docs/v3/field/post.ts
A function with typed inputs. Its response is checked against the schema.

merchantIdinteger required

Your merchant Id

echoboolean

true

idstring

Id for the custom field (Auto-generated by server)

namestring

Descriptor name for the custom field

fieldNamestring required

Name for the custom field object

fieldDataTypestring required

Type of field. Values: Boolean, String, Integer, Decimal, or List

fieldSourceTypestring required

Always customer

isDeletedboolean required

System level field (Always False)

isSystemboolean required

System Level Field (Always False)

isRequiredboolean required

Noting if the custom field is required to fill out

201

idinteger

fieldNamestring

fieldDataTypestring

fieldSourceTypestring

isSystemboolean

isDeletedboolean

isRequiredboolean

optionsobject[]

{
  "id": 211787,
  "fieldName": "new field",
  "fieldDataType": "String",
  "fieldSourceType": "Customer"
}

No recorded changes to this operation across all 1 revision of this API.