Resource URIs

Base Address

Sandbox:  https://demo.firstonboard.net
Production:  https://api.firstonboard.net

AcceptanceLanguage

Use this URI to request the Acceptance Language that should be displayed to the Merchant on the signature page.

Get Acceptance Language
Resource URI
GET {baseaddress}/api/office/{officeid}/acceptancelanguage
Request
Pass the {officeid} in the resource URI.
Response
Returns an AcceptanceLanguage object. Note that some of the data contains HTML markup.
Example
GET https://demo.firstonboard.net/api/office/200002/acceptancelanguage

Application

Use this URI to create an Application or get a list of Applications.

Post Application
Resource URI
POST {baseaddress}/api/office/{officeid}/application
Request
Pass the {officeid} in the resource URI and an Application object in the request content.
Response
Returns an Application object along with the new ApplicationID.
Example
POST https://demo.firstonboard.net/api/office/200002/application

Get List of Applications
Resource URI
GET {baseaddress}/api/office/{officeid}/application/
Request
Pass the {officeid} in the resource URI.
Response
Returns a list of ApplicationListItem object along with the new ApplicationID.
Example
GET https://demo.firstonboard.net/api/office/200002/application

AvailableEquipment

Use this URI to get a list of Equipment that can be assigned to an Application. (This would be used if you were developing a full-scale application interface.)

Get Available Equipment
Resource URI
GET {baseaddress}/api/office/{officeid}/availableequipment
Request
Pass the {officeid} in the resource URI.
Response
Returns a list of AvailableEquipment.
Example
GET https://demo.firstonboard.net/api/office/200002/availableequipment

IdentityAnswerSet

Use this URI to return the Answers to the credit bureau Identity Questions.

Post Identity Answers
Resource URI
POST {baseaddress}/api/office/{officeid}/answerset/{applicationid}
Request
Pass the {officeid} and {applicationid} parameters in the resource URI along with the IdentityAnswerSet object in the request content.
Response
Returns a HTTP Response Code.
Example
GET https://demo.firstonboard.net/api/office/200002/answerset/2205

IdentityQuestionSet

Use this URI to get the credit bureau Identity Questions for an Application.

Get Identity Questions
Resource URI
GET {baseaddress}/api/office/{officeid}/questionset/{applicationid}
Request
Pass the {officeid} and {applicationid} parameters in the resource URI.
Response
Returns a IdentityQuestionSet object for the Application.
Example
GET https://demo.firstonboard.net/api/office/200002/questionset/2205

MerchantDecision

Use this URI to post the Merchant's Decision.

Post Merchant Decision
Resource URI
POST {baseaddress}/api/office/{officeid}/merchantdecision/{applicationid}
Request
Pass the {officeid} and {applicationid} parameters in the resource URI along with the MerchantDecision object in the request content.
Response
Returns a success/failure message.
Example
GET https://demo.firstonboard.net/api/office/200002/merchantdecision/2205

PaymentMethod

Use this URI to get a list of Payment Methods. (This would be used if you were developing a full-scale application interface.)

Get Payment Methods
Resource URI
GET {baseaddress}/api/office/{officeid}/paymentmethod
Request
Pass the {officeid} in the resource URI.
Response
Returns a list of PaymentMethod.
Example
GET https://demo.firstonboard.net/api/office/200002/paymentmethod

PDF

Use this URI to get a PDF version of the Application.

Get Application PDF
Resource URI
GET {baseaddress}/api/office/{officeid}/pdf/{applicationid}
Request
Pass the {officeid} and the {applicationid} in the resource URI.
Response
Returns a byte stream that can be read as a PDF document.
Example
GET https://demo.firstonboard.net/api/office/200002/pdf/2205

SalesTaxRate

Use this URI to get the sales tax rate for a given office, city, state, and zip. (This would be used if you were developing a full-scale application interface.)

Get Sales Tax Rate
Resource URI
GET {baseaddress}/api/office/{officeid}/salestaxrate?city={city}&state={state}&zip={zip}
Request
Pass the {officeid}, {city}, {state}, and {zip} in the resource URI.
Response
Returns a SalesTaxRate object.
Example
GET https://demo.firstonboard.net/api/office/200002/salestaxrate?city=Fort%20Worth&state=TX&zip=76102