Autoboard Webservice v5.13.0.0

<back to all web services

RetrieveBoardingResultRequest

json-appxml-appjson-order
Requires Authentication
The following routes are available for this service:
GET/RetrieveBoardingResult
RetrieveBoardingResultRequest Parameters:
NameParameterData TypeRequiredDescription
AppQueueGuidqueryGuidNo
RetrieveBoardingResultResponse Parameters:
NameParameterData TypeRequiredDescription
AppQueueGUIDformGuid?No
ApplicationIdformstringNo
CSRformstringNo
PartyIDformstringNo
AutoboardedformboolNo
QueueStatusformApplicationQueueStatusNo
BoardingStatusformApplicationBoardingStatus?No
ErrorMessagesformList<string>No
OrderIdformstringNo
LEIDformstringNo
PartyIndividualsformList<string>No
ApplicationQueueStatus Enum:
NameValue
Queued0
StandardisedXML20
ReadyToDistribute40
AwaitingDistributeResponse60
ReadyToAutoboard80
ThrottleCheckPassed100
EligibilityCheckPassed300
SentToAutoboardService400
AutoboardingSuspended450
SuccessfullyBoarded500
QueueError1000
ThrottleCheckError1100
XMLStandardisationError1200
EligibilityCheckError1300
AutoboardingError1400
IneligibleThrottleLimit2100
IneligibleApplication2300
ApplicationBoardingStatus Enum:
NameValue
PENDING0
IN_PROGRESS5
FAILED9
COMPLETED10

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

HTTP + JSON

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.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"]}