Manage merchant properties

Merchant properties allow you to store and manage additional metadata associated with a merchant account. These properties may include configuration flags, labels, or internal values needed to support business logic or integration workflows.

This includes two steps:

1

Update merchant properties

The Update Merchant Properties endpoint is used to add or update custom attributes for a specific merchant account. These properties help identify or categorize the merchant in your system such as, by associating a custom external identifier.

Use the PUT method with endpoint /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Properties to update properties for your merchant number. Refer to the below sample request code for reference:

{
  "properties": [
    {
      "key": "ExternalCustomerId",
      "value": "ABC123"
    },
    {
      "key": "SalesRegion",
      "value": "West"
    },
    {
      "key": "StoreType",
      "value": "Retail"
    }
  ]
}

Refer to the following response sample code:

{
  "content": {
    "ExternalCustomerId": "external-system-customer-id"
  },
  "metadata": {
    "exchangeId": "ID-e5244b08-ffc7-4826-8d05-c8322933806d",
    "timestamp": "2020-01-07T16:32:38.0236827Z"
  }
}

2

Retrieve merchant properties

The Retrieve Merchant Properties endpoint is used to fetch custom attributes that were previously set for a specific merchant account. This allows you to view stored data such as external identifiers or categorization details linked to the merchant.

Use GET method with endpoint /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Properties/{propertyName} to retrieve a specific merchant number property that was previously created. Refer to the below sample response code:

{
  "content": {
    "ExternalCustomerId": "external-system-customer-id"
  },
  "metadata": {
    "exchangeId": "ID-8165572b-a0ce-4f2e-947f-8c8406f06531",
    "timestamp": "2020-01-07T16:32:38.0245961Z"
  }
}