APG PayAPG Paydocs

Merchants

Update merchant travel setting

PATCH/merchant-travel-settings/{merchantTravelSettingId}

Replace what the merchant may change on its travel settings.

Permissions

Required permission
merchantTravelData:update

Requires the `update` action on `merchantTravelData` for the supplied runtime context

Path parameters

merchantTravelSettingIdstring
required

Request body

This body is a tagged shape: type is always "TvlsetUpdateSettings". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "TvlsetUpdateSettings"
fileVersionsarray of string
datePostponeEnabledbooleanrequired

Example true

postponeMonthsinteger (int32)required

Example 6

When a merchant who has sent no travel file is reminded to.

tqcReportEmailsarray of string

Example ada@example.com

curl -X PATCH https://api.tst.au.apgpay.dev/merchant-travel-settings/{merchantTravelSettingId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "TvlsetUpdateSettings",
  "fileVersions": [
    "string"
  ],
  "datePostponeEnabled": true,
  "postponeMonths": 6,
  "reminder": {
    "type": "TvlsetReminderAttributes",
    "enabled": true,
    "schedule": "Never",
    "weekday": "Sunday"
  },
  "tqcReportEmails": [
    "ada@example.com"
  ]
}'

Responses

The response is a tagged shape: type is always "TvlsetUpdateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "TvlsetUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "TvlsetUpdateRspAttributes",
  "updated": {
    "type": "TvlsetViewAttributes",
    "merchantTravelSettingsId": "mcht_9f2Kd8QpLzXw",
    "merchantCode": "string",
    "fileVersions": [
      "string"
    ],
    "datePostponeEnabled": true,
    "postponeMonths": 6,
    "reminder": {
      "type": "TvlsetReminderAttributes",
      "enabled": true,
      "schedule": "Never",
      "weekday": "Sunday"
    },
    "tqcReportEmails": [
      "ada@example.com"
    ],
    "lastReminderOn": "2026-08-19",
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses