| GET | /RetrieveBoardingResult |
|---|
// @DataContract
export enum ApplicationQueueStatus
{
Queued = 0,
StandardisedXML = 20,
ReadyToDistribute = 40,
AwaitingDistributeResponse = 60,
ReadyToAutoboard = 80,
ThrottleCheckPassed = 100,
EligibilityCheckPassed = 300,
SentToAutoboardService = 400,
AutoboardingSuspended = 450,
SuccessfullyBoarded = 500,
QueueError = 1000,
ThrottleCheckError = 1100,
XMLStandardisationError = 1200,
EligibilityCheckError = 1300,
AutoboardingError = 1400,
IneligibleThrottleLimit = 2100,
IneligibleApplication = 2300,
}
// @DataContract
export enum ApplicationBoardingStatus
{
PENDING = 0,
IN_PROGRESS = 5,
FAILED = 9,
COMPLETED = 10,
}
export class RetrieveBoardingResultResponse
{
public appQueueGUID?: string;
public applicationId?: string;
public csr?: string;
public partyID?: string;
public autoboarded?: boolean;
public queueStatus?: ApplicationQueueStatus;
public boardingStatus?: ApplicationBoardingStatus;
public errorMessages?: string[];
public orderId?: string;
public leid?: string;
public partyIndividuals?: string[];
public constructor(init?: Partial<RetrieveBoardingResultResponse>) { (Object as any).assign(this, init); }
}
export class RetrieveBoardingResultRequest
{
public appQueueGuid?: string;
public constructor(init?: Partial<RetrieveBoardingResultRequest>) { (Object as any).assign(this, init); }
}
TypeScript RetrieveBoardingResultRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /RetrieveBoardingResult HTTP/1.1 Host: abservice-featuretest.worldpay.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RetrieveBoardingResultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Autoboarding.Common.Responses">
<AppQueueGUID>00000000-0000-0000-0000-000000000000</AppQueueGUID>
<ApplicationId>String</ApplicationId>
<Autoboarded>false</Autoboarded>
<BoardingStatus>PENDING</BoardingStatus>
<CSR>String</CSR>
<ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ErrorMessages>
<LEID>String</LEID>
<OrderId>String</OrderId>
<PartyID>String</PartyID>
<PartyIndividuals xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PartyIndividuals>
<QueueStatus>Queued</QueueStatus>
</RetrieveBoardingResultResponse>