GetDestinationsRequest

GetDestinationsRequest retrieves catalogued destinations.

criteria object

Filters describing which destinations to return.

destinationCodesstring[]

Destination codes to include; empty to retrieve all.

languagelanguage (string)

ISO 639-1 language code for destination descriptions.

settings object

Execution settings shared across aggregator requests.

requestIdrequestId (string)

Unique identifier used to correlate downstream provider calls and responses.

accessIdsstring[]

Provider access identifiers that the request should target.

pos object

Point of sale information for commercial routing.

branchOfficebranchOffice (string)

Branch or office that originated the enquiry, when available.

auditTransactionsauditTransactions (boolean)

When true, raw provider transactions are collected for auditing.

timeoutinteger<int32>

Maximum time in milliseconds allowed for the aggregator to respond.

testModetestMode (boolean)

Enables sandbox flows where providers expose dedicated mock behaviour.

debugDatadebugData (boolean)

Enables diagnostic payloads that surface debug data in responses.

tokentoken (string)

Token that propagates caller authentication to downstream services.

GetDestinationsRequest

{
  "criteria": {
    "destinationCodes": [
      "string"
    ],
    "language": "string"
  },
  "settings": {
    "requestId": "string",
    "accessIds": [
      "string"
    ],
    "pos": {
      "branchOffice": "string"
    },
    "auditTransactions": true,
    "timeout": 0,
    "testMode": true,
    "debugData": true,
    "token": "string"
  }
}