APG PayAPG Paydocs

Merchants

List travel dbi corrections

GET/travel-dbi-corrections
Request
GEThttps://api.tst.au.apgpay.dev/travel-dbi-corrections
curl -X GET https://api.tst.au.apgpay.dev/travel-dbi-corrections \
  -H "Authorization: Bearer $API_KEY"

Return the corrections staged for a merchant's entries and not yet applied. Name the merchant with merchantId or the Merchant-Id header. A merchant has few, so they page by page only.

Permissions

Required permission
merchantTravelData:query

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

Query parameters

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

columnsarray of TvldbicColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

merchantIdstring

Whose staged corrections to read. Omit it when the Merchant-Id header names the merchant.

Responses

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

Discriminated by type
type = "TvldbicPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "TvldbicPageAttributes",
  "data": [
    {
      "type": "TvldbicViewAttributes",
      "travelDbiCorrectionId": "tvlent_9f2Kd8QpLzXw",
      "ownerMerchantId": "mcht_9f2Kd8QpLzXw"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses