GET | /RetrieveBoardingResult |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AppQueueGuid | query | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AppQueueGUID | form | Guid? | No | |
ApplicationId | form | string | No | |
CSR | form | string | No | |
PartyID | form | string | No | |
Autoboarded | form | bool | No | |
QueueStatus | form | ApplicationQueueStatus | No | |
BoardingStatus | form | ApplicationBoardingStatus? | No | |
ErrorMessages | form | List<string> | No | |
OrderId | form | string | No | |
LEID | form | string | No | |
PartyIndividuals | form | List<string> | No |
Name | Value | |
---|---|---|
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 |
Name | Value | |
---|---|---|
PENDING | 0 | |
IN_PROGRESS | 5 | |
FAILED | 9 | |
COMPLETED | 10 |
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.
GET /RetrieveBoardingResult HTTP/1.1 Host: abservice-featuretest.worldpay.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"appQueueGUID":"00000000000000000000000000000000","applicationId":"String","csr":"String","partyID":"String","autoboarded":false,"queueStatus":"Queued","boardingStatus":"PENDING","errorMessages":["String"],"orderId":"String","leid":"String","partyIndividuals":["String"]}