APG PayAPG Paydocs

Merchants

Get merchant travel setting

GET/merchant-travel-settings/{merchantTravelSettingId}
Request
GEThttps://api.tst.au.apgpay.dev/merchant-travel-settings/{merchantTravelSettingId}
curl -X GET https://api.tst.au.apgpay.dev/merchant-travel-settings/{merchantTravelSettingId} \
  -H "Authorization: Bearer $API_KEY"

Return a merchant's travel settings.

Permissions

Required permission
merchantTravelData:query

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

Path parameters

merchantTravelSettingIdstring
required

Responses

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

Discriminated by type
type = "TvlsetViewAttributes"
merchantTravelSettingsIdTvlsetIdrequired

Identifier of a merchant's travel settings, which is the merchant's own identifier.

Example mcht_9f2Kd8QpLzXw

merchantCodestringrequired

The merchant's twelve-digit travel code.

fileVersionsarray of string

The file layout versions the merchant may send, such as V02.01. An empty list allows none.

datePostponeEnabledbooleanrequired

Whether a transaction dated before the current month is moved forward.

Example true

postponeMonthsinteger (int32)required

How many months a date may be postponed by.

Example 6

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

tqcReportEmailsarray of string

Who the file quality-check report is mailed to.

Example ada@example.com

lastReminderOnstring (date)

The day the merchant was last reminded.

Example 2026-08-19

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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