Autoboard Webservice v5.13.0.0

<back to all web services

InitiateBoardingRequest

xml-app
Requires Authentication
The following routes are available for this service:
POST/InitiateBoarding
import java.math.*
import java.util.*
import net.servicestack.client.*


open class InitiateBoardingRequest
{
    var guid:UUID? = null
    var csr:Int? = null
    var encryptedXML:String? = null
    var salesmanID:String? = null
    var salesmanEmail:String? = null
    var applicationSource:Int? = null
}

open class InitiateBoardingResponse
{
    var applicationGuid:UUID? = null
    var csr:Int? = null
    var applicationQueueGuid:UUID? = null
    var queueStatus:ApplicationQueueStatus? = null
    var boardingStatus:ApplicationBoardingStatus? = null
    var errorMessages:ArrayList<String> = ArrayList<String>()
}

@DataContract
enum class ApplicationQueueStatus(val value:Int)
{
    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
enum class ApplicationBoardingStatus(val value:Int)
{
    Pending(0),
    InProgress(5),
    Failed(9),
    Completed(10),
}

Kotlin 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

HTTP + JSON

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