v3

latestSwagger 2.02026-08-0125316174.5 KB

5. Campaign Validation

update campaign settings for a client

put/api/validation/v1/campaign/settings/update/{campaignId}

Path parameters

campaignIdstring required

The ID of the campaign to validate the receipt

Headers

apikeystring required

API authentication key.

Request body

Example request

{
  "date": {
    "start": "2023-04-01T00:00:00.000Z",
    "end": "2023-04-01T00:00:00.000Z"
  },
  "merchantNames": {
    "list": [
      "AB Electric"
    ],
    "allowList": [
      "AB Electric"
    ],
    "blockList": [
      "CD Mechanical"
    ]
  },
  "productCodes": {
    "description": "Find product codes for Test Product",
    "list": [
      "MAF-01010101"
    ]
  },
  "balanceOwing": {
    "max": 100
  },
  "productLineItems": {
    "totalPrice": {
      "max": 100
    },
    "quantity": {
      "max": 100
    },
    "names": [
      "Apple",
      "Banana"
    ]
  },
  "smartValidate": {
    "prompts": [
      {
        "question": "Is this a credit card payment?",
        "example": {
          "is_credit_card": true
        }
      }
    ]
  }
}