| POST | /InitiateBoarding |
|---|
// @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 InitiateBoardingResponse
{
public applicationGuid?: string;
public csr?: number;
public applicationQueueGuid?: string;
public queueStatus?: ApplicationQueueStatus;
public boardingStatus?: ApplicationBoardingStatus;
public errorMessages?: string[];
public constructor(init?: Partial<InitiateBoardingResponse>) { (Object as any).assign(this, init); }
}
export class InitiateBoardingRequest
{
public guid?: string;
public csr?: number;
public encryptedXML?: string;
public salesmanID?: string;
public salesmanEmail?: string;
public applicationSource?: number;
public constructor(init?: Partial<InitiateBoardingRequest>) { (Object as any).assign(this, init); }
}
TypeScript InitiateBoardingRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /InitiateBoarding HTTP/1.1
Host: abservice-featuretest.worldpay.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"guid":"00000000000000000000000000000000","csr":0,"encryptedXML":"String","salesmanID":"String","salesmanEmail":"String","applicationSource":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"applicationGuid":"00000000000000000000000000000000","csr":0,"applicationQueueGuid":"00000000000000000000000000000000","queueStatus":"Queued","boardingStatus":"PENDING","errorMessages":["String"]}