Operations Used in the AppLink Web API

List Applications link

 

GET USAPPLICATION_LISTAPPLICATIONS

 

Description

This GET operation returns a list of Merchant Applications in the system based on the parameters provided.

 

Caution

Be careful with the range of dates, otherwise you may unintentionally generate a long running query and a large result set. 

 

URL 

https://api.sandbox.nuvei.com/applink/Application/US/list

 

Parameters

Name

Required

Description

Format

Example or Allowed Values

startDate

Yes

The filter beginning date

YYYY-MM-DD

2017-08-31

endDate

Yes

The filter ending date

YYYY-MM-DD

2017-09-30

agentName

No

Query using exact agent name provided

TEXT

RalphOscar

status

No

Query using exact status provided

TEXT
(case sensitive)

New: Application has been newly created.

OutstandingElecSign: Application has been submitted for electronic signature by the merchant but has not yet been signed. 
Electronic signatures are not available through the API; however, for partners that use both the UI and the API, applications entered through the UI will appear in the API, and vice versa.

CompleteElecSign: Application has been signed by the merchant and is ready to be reviewed and submitted for boarding

Submitted: Application has been submitted for boarding

Canceled: Application has been cancelled by the sales agent. Cancelling applications is not available through the API.           

PendingMerchantReviewLink: Application has been submitted to the merchant for review and completion. This functionality is not available through the API.

MerchantCompletedReviewLink: Application for which the merchant has completed Merchant Review.

OutstandingUnderwriting: Application has been submitted for underwriting by an external service and is pending its response prior to being submitted.

startIndex

No

Page number to start on

Integer

5

pageSize

No

Number of records to return on a page

Integer

25

 

Example
/Application/US/List?startDate=2017-08-31&endDate=2017-09-30

 

Response Content

A response code will be returned indicating success or failure.

A successful response includes a JSON file listing the Merchant Applications that satisfy the parameters supplied. An example of a single application returned is shown below.

JSON
[ { "ApplicationId": "45358060-7336-4c76-ad5e-ecc8c028a966", "DbaName": "AppLink API Test US", "CountryCode": "US", "OrganizationId": null, "User": "test", "Status": "New", "SignatureStatus": null, "AgentRole": "Test Agent (Primary Agent)", "Agent": "Test Company", "Office": "Test Agent US", "Created": "2017-07-03T15:59:17.29", "CreatedBy": "test", "Updated": "2017-07-03T15:59:17.29", "UpdatedBy": "test" },

Delete Application link

 

DELETE USAPPLICATION_DELETEAPPLICATION

 

Description 

This DELETE operation deletes the Merchant Application data from the system for one unique Application ID provided. The delete includes the payload data and any associated documents.

 

Caution

This operation cannot be undone.

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/{ApplicationID}

 

Parameters

Name

Required

Description

Format

Example

Application ID

Yes

The unique Application ID to delete

Unique ID

02abc16-fdf7-406e-8c60-b514Bde23d84

 

Example
/Application/US/02abc16-fdf7-406e-8c60-b514Bde23d84

 

Response Content

A response code will be returned indicating success or failure.

 

 

GET APPLICATION link

 

GET USAPPLICATION_GETAPPLICATION

 

Description 

This GET operation returns the Merchant Application data payload for the unique Application ID provided.

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/{ApplicationID}

 

Parameters

Name

Required

Description

Format

Example

Application ID

Yes

The unique Application ID to retrieve

Text

02abc16-fdf7-406e-8c60-b514Bde23d84

 

Example
/Application/US/02abc16-fdf7-406e-8c60-b514Bde23d84

 

Response Content 
A response code will be returned indicating success or failure. 

A successful response includes a JSON file with all the data associated with the ApplicationID in your payload format. 

 

 

Update Application link

PUT USAPPLICATION_UPDATEAPPLICATION

 

Description 

This PUT operation replaces the existing Merchant Application data payload in the system for the unique Application ID provided. Or, if the unique Application ID does not exist, and createIfNew is set to "TRUE", this operation will add the Merchant Application data payload into the system.

 

Caution

It is a better practice to create a new application, rather than use this operation.

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/{ApplicationID}

 

Parameters

Name

Required

Description

Format

Example

Application ID

Yes

The unique Application ID to overwrite the payload

Text

02abc16-fdf7-406e-8c60-b514Bde23d84

payload file

Yes

The complete payload data file for this Application ID

JSON file

See appendix for an example

strict

No

Pre-validates the Merchant Application data using the same rules as the PreSubmitValidations operation

Text

True

createIfNew

No

If the unique Application ID does not exist, creates a Merchant Application for the unique Application ID

Text

False

 

Example
/Application/US/02abc16-fdf7-406e-8c60-b514Bde23d84

 

Response 
A response code will be returned indicating success or failure. 

If Strict="TRUE" and failure occurs, error information is provided. For example, if the JSON file contained "CorporateState": "ZZ", an error code of 400 would be returned with Response Body as follows.

JSON
{ "Message": "Error converting value \"ZZ\" to type 'PivotalPayments.App.AppLink.WebApi.Models.US.MerchantBusinessInformation_CorporateState'. Path 'MerchantBusinessInformation.CorporateState', line 10, position 38." }

Create Application link

POST USAPPLICATION_CREATEAPPLICATION

 

Description 
This POST operation adds the Merchant Application data payload into the system. 

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/

 

Parameters

Name

Required

Description

Format

Example

payload file

Yes

The complete payload data file for this Application ID

JSON file 

See appendix for an example

strict

No

Pre-validates the Merchant Application data using the same rules as the PreSubmitValidations operation

Text

True or False

 

Example

/Application/US

 

Response Content 

A response code will be returned indicating success or failure. 

If Strict="true" and failure occurs, error information is provided as shown in PUT /Application/US/{id}.

A successful response includes the unique Application ID used to reference this application as follows:

 

 

 

 

Validate Application Data - DO NOT USE link

 

GET USAPPLICATION_VALIDATIONCHECKS

 

Description 
This function is obsolete – DO NOT USE.

 

Validate Payload Data link

 

GET USAPPLICATION_PRESUBMITVALIDATIONS

 

Description

This GET operation validates all application data fields in the payload. If any data is invalid, the response indicates what needs correction.

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/{id}/PreSubmitValidations

 

Parameters

Name

Required

Description

Format

Example

Application ID

Yes

The unique Application ID to be validated

Text

02abc16-fdf7-406e-8c60-b514Bde23d84

resubmit

 

DO NOT USE – internal Nuvei use only

 

 

 

Example

/Application/US/02abc16-fdf7-406e-8c60-b514Bde23d84/PreSubmitValidations

 

Response Content 

A response code will be returned indicating success or failure. 

A successful response is a 204 and nothing is returned

A failure response is a 400 and error information is provided as shown in Update Application.

 

 

Validate & Submit Application - Synchronous link

 

POST USAPPLICATION_SUBMITAPPLICATIONSYNC

 

Description 

This POST operation first validates the Merchant Application data payload for the unique Application ID, as outlined in PreSubmitValidations. If there are no validation errors, the application data payload and documents are sent to our onboarding system. 

 

Caution

This operation is synchronous; the operation waits until a success or failure response occurs before the operation is complete. This operation can take a long time and you should carefully evaluate its use in your application design.

If your application design can be structured to avoid waiting for a response, consider using the SubmitAsync operation instead.

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/{id}/Submit

 

Parameters

 

Name

Required

Description

Format

Example

Application ID

Yes

The unique Application ID to Submit

Text

02abc16-fdf7-406e-8c60-b514Bde23d84

resubmit

 

DO NOT USE – internal Nuvei use only

 

 

 

Example

/Application/US/02abc16-fdf7-406e-8c60-b514Bde23d84/Submit

 

Response Content

A response code will be returned indicating success or failure. 

A successful response is a 204 and nothing is returned

A failure response is a 400 and error information is provided as shown in Update Application.

 

Validate & Submit Application - Asynchronous link

 

POST USAPPLICATION_SUBMITAPPLICATIONASYNC

 

Description 

This POST operation first validates the Merchant Application data payload for the unique Application ID, as outlined in PreSubmitValidations. If there are no validation errors, the application data payload and documents are sent to our onboarding system. 

 

Caution

This operation is asynchronous; it does not wait for the success or failure response. The response for this operation is returned to the URL provided in the requestCallback parameter. 

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/{id}/SubmitAsync

 

Parameters

 

Name

Required

Description

Format

Example

Application ID

Yes

The unique Application ID to Submit

Text

02abc16-fdf7-406e-8c60-b514Bde23d84

requestCallback

Yes

The URL where the response will be sent once the operation completes

URL

https://www.mycompany/applink/response

resubmit

No

DO NOT USE – internal Nuvei use only

 

 
 
Example
 
/Application/US/02abc16-fdf7-406e-8c60-b514Bde23d84/ SubmitAsync?requestCallback=https://www.mycompany/applink/response
 
 
Response Content
 

A response code will be returned indicating success or failure. 

A successful response is a 204 and nothing is returned

A failure response is a 400 and error information is provided as shown in Update Application.

 

 

 

Upload Document link

 

POST USAPPLICATION_CREATEDOCUMENT

 
Description
 
This POST operation uploads a supporting document for the Merchant Application identified by the unique Application ID. Digital file types accepted are:

 

  • XML
  • PDF
  • JPG
  • PNG
  • TIFF
  • TXT
  • DOC
  • DOCX
  • ZIP
  • JPEG
  • WAV
 
Any other file extension will cause the API to respond with a 401 Fail response. Only one document file can be uploaded at a time, but this operation can be repeated as many times as needed to provide all the supporting documents required. 
 
The file must be uploaded in the multipart/form-data format with an attachment named “file”. For example:
JSON
POST /Application/US/ 9f11f1a4-01ac-4c1c-a3bf-8836ed97f4a9/Document?documentType=Other&api_key=<... API Key ...> HTTP/1.1 Cache-Control: no-cache User-Agent: PostmanRuntime/7.2.0 Accept: */* Host: applinkapi.service.preproduction.nuvei.com Accept-Encoding: gzip, deflate Content-Type: multipart/form-data; boundary=--------------------------472144426427217032865867 Content-Length: 7574 Connection: keep-alive   ----------------------------472144426427217032865867 Content-Disposition: form-data; name="file"; filename="image.png" Content-Type: image/png <... content here ... > ----------------------------472144426427217032865867--

 

Most HTTP libraries and REST clients provide helper functions that help construct a multipart/form-data payload for a file to be uploaded.
 

Parameters

Name

Required

Description

Format

Example or Allowed Values

Application ID

Yes

The unique Application ID for the Merchant Application that this document is to be attached to.

Text

02abc16-fdf7-406e-8c60-b514Bde23d84

documentType

Yes

One of the Allowed Values listed that best describes the document being uploaded

Text (case sensitive) 

ApplicationAndAgreement

ProcessingStatements

ProofOfBusiness

VoidCheck

EquipmentForm

Other

NonProfitEvidence

file

Yes

The full path for the file that will be upload

File Title

C:/my/app/voidcheck.pdf

 

Example

See above. 

 

Response

A response code will be returned indicating success or failure.

 

 

 

Delete Document link

 

DELETE USAPPLICATION_DELETEDOCUMENT

 

Description 
This DELETE operation deletes the named supporting document for the Merchant Application identified by the unique Application ID. 

 

Caution

This operation cannot be undone.

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/{id}/Document/{name}

 

Parameters

Name

Required

Description

Format

Example

Application ID

Yes

The unique Application ID for the Merchant Application that the document is part of

Text

02abc16-fdf7-406e-8c60-b514Bde23d84

name

 

Yes

The name of the document to be deleted. This is the filename provided in the Content-Disposition in multipart/form-data – filename="image.png"

 

Text

image.png

 

Example

/Application/US/02abc16-fdf7-406e-8c60-b514Bde23d84/Document/image.png

 

Response

A response code will be returned indicating success or failure.

 

List Supporting Documents link

GET USAPPLICATION_DOCUMENTLIST

 

Description 

This GET operation returns a list of the supporting documents related to the Merchant Application identified by the unique Application ID. 

 

URL

https://api.sandbox.nuvei.com/applink/Application/US/{id}/Documents

 

Parameters

Name

Required

Description

Format

Example

Application ID

Yes

The unique Application ID associated with the documents

Text

02abc16-fdf7-406e-8c60-b514Bde23d84

 

Example
/Application/US/02abc16-fdf7-406e-8c60-b514Bde23d84/Documents

 

Response Content
A response code will be returned indicating success or failure. 

A successful response includes a JSON file of documents related to the Merchant Application in the format shown below:

JSON
[ { "FileName": "Other_1.pdf", "DocumentTypes": [ "Other" ], "Created": "2018-08-31T13:17:51.937", "CreatedBy": "test" } ]

Need Help?

How can we help you today?  Our team is standing by and just a click away.

Knowledge Base Contact Support