Request a Boarding Application Status

You can get the status of an application using the endpoint api/vn/boardstatus, where n is the API version number found in the API Reference heading.

Request

The boardstatus request is detailed in the Boarding Status section of the API Reference and requires the following elements.

boardstatus Elements from POST

Element

Description

Criterion Notes

boardingId

The value that is returned following a successful boarding response.

Required

In the EU, this is the Merchant ID.

clientId

The client identifier of the individual being status checked. It is the same as that sent in the initial boarding request.

Required

Elavon provides the clientId.

uniqueId

An alphanumeric value that identifies the status request specifically, but does not need to be from the initial boarding request.

Required

(Refer to Top Level Credit Check Tags)

country

The country in which the client operates.

Required

Use ISO 3166-1 alpha-3.

salesRepCode

Identifying the sales representative boarding the customer.

Required

 

Response

The boarding status response returns the following:

The Boarding Status Response

Element

Description

error

A message placeholder for if the service returns an error.

boardingStatus

The application status.

applicationID

The Merchant ID is included for ease of reference.

 

boardingStatus Values

Status

Description

COMPLETE

The application is complete, opened, and free to transact.

INPROGRESS

The application is under review.

DECLINED

The application was declined after review.

WITHDRAWN

The application has been closed and is stopped from transacting.

PEND

Pending. Try again later.

TIMED_OUT

Typical of connection issues. Try again.

ERROR

Typical of connection issues. Try again.

UNKNOWN

Status is unknown at this time.

 

 

❮ Back to Push Notifications    Next:  General Element Codes ❯