List All Deployments

post

https://example.com/v1/Deployments

List Deployments shows all Deployments summary details that are available to the User.
To filter the Deployments that appear in the response, specify one or more optional query and pagination parameters.

Query parameters are inclusive.

The following Status Codes are permitted: Deployed, FailedWithSupplier, CancelledWithSupplier, CardDeploymentFailed, NoCard, AmendLimitChangeFailed, PreDeployment, All

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Deployment Search Filters

Page

int32 | null

Which page of results to return

pageSize

int32 | null

Number of records per page.

endDate

date-time | null

Supply a created from date to only show Deployments created before this date.

If StartDate is provided EndDate must be provided. If neither are provided a default date range is used.

startDate

date-time | null

Supply a created from date to only show Deployments created after this date.

If EndDate is provided StartDate must be provided. If neither are provided a default date range is used.

spendType

string | null

Supply a spend type filter to limit Deployments to that spend type.

Permitted values: Hotel, Event, Air, Rail, CarRental, MultiType, ServiceFee

cardPoolIDs

array of int32s | null

Supply a list of Card Pool IDs to limit the Deployments to those belonging to the supplied Card Pools.

cardPoolIDs

statusCodes

array of strings | null

Supply a list of Status Codes to limit the deployments to those of that status.

Permitted values: Deployed, FailedWithSupplier, CancelledWithSupplier, CardDeploymentFailed, NoCard, AmendLimitChangeFailed, PreDeployment, All

statusCodes

transactionMatched

boolean | null

Supply a filter to filter in/out Deployments which have a matched Transaction.

If not provided Deployments with and without Transactions are returned.

isInSNAPPlus

boolean | null

Supply a filter to filter in/out Deployments which have transactions going through the Snap+ process.

If not provided Deployments in and out of the Snap+ processes are returned.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

404

Not Found

200OK

400Bad Request

500Internal Server Error