On this page:

List Applications
List Supporting Documents
- GET /APPLICATION/CA/{ID}/DOCUMENTS LINK

List Applications

GET /Application/CA/List Link

Description

This GET operation returns a list of Merchant Applications in the system based upon 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/CA/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-26
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/CA/List?startDate=2017-08-01&endDate=2017-09-26

Response Content:

Success or failure based upon the response code returned.

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

[
  {
    "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

DELETE /APPLICATION/CA/{ID} LINK

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/CA/{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/CA/02abc16-fdf7-406e-8c60-b514Bde23d84

Response:

Success or failure based upon the response code returned.

This operation cannot be undone.

GET Application

GET /APPLICATION/CA/{ID} LINK

Description

This GET operation returns the Merchant Application data “payload” in the system for the unique Application ID provided.

URL

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

Parameters

Name	Required	Description	Format	Example
Application ID	Yes	The unique Application ID to retrieve	Text	02abc16-fdf7-406e-8c60-b514Bde23d84

Example

/Application/CA/02abc16-fdf7-406e-8c60-b514Bde23d84

Response Content:

Success or failure based upon the response code returned.

A successful response includes a JSON file in your “payload” format. That file has the data stored for the unique Application ID.

UPDATE Application

PUT /APPLICATION/CA/{ID}. LINK

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 the createIfNew parameter is set to “true”, adds the Merchant Application data “payload” into the system for the unique Application ID.

Caution

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

URL

https://api.sandbox.nuvei.com/applink/Application/CA/{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/CA/02abc16-fdf7-406e-8c60-b514Bde23d84

Response:

Success or failure based upon the response code returned.

If Strict = “TRUE” and failure occurs, then error information is provided. For example if the JSON file contained “CorporateState”: “ZZ”, then an error code of 400 is returned and the Response Body contains:

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

Create Application

POST /APPLICATION/CA LINK

Description

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

URL

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

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/CA

Response Content:

Success or failure based upon the response code returned.

If strict is “true” and failure occurs, then error information is provided as shown in PUT /Application/CA/{id}.

A successful response includes the unique Application ID that will be used to reference this application as shown below:

Validate Application Data – DO NOT USE

GET /APPLICATION/CA/{ID}/VALIDATIONCHECKS LINK

Description

This function is NOT AVAILABLE in the Canadian version of the API – DO NOT USE.

Validate Payload Data

GET /APPLICATION/CA/{ID}/PRESUBMITVALIDATIONS LINK

Description

This GET operation performs all the validation rules on the fields for the Merchant Application data “payload”. If validation errors occur the response contains the information needed for correction.

URL

https://api.sandbox.nuvei.com/applink/Application/CA/{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/CA/02abc16-fdf7-406e-8c60-b514Bde23d84/ PreSubmitValidations

Response Content

Success or failure based upon the response code returned.

A successful response is a 204 and nothing is returned

A failure response is a 400 and error information is provided as shown in PUT /Application/CA/{id}.

Validate & Submit Application – Synchronous

POST /APPLICATION/CA/{ID}/SUBMIT LINK

Description

This POST operation first validates the Merchant Application data “payload”, just like the PreSubmitValidations operation, for the unique Application ID. If there are no validation errors, the Merchant’s 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/CA/{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/CA/02abc16-fdf7-406e-8c60-b514Bde23d84/Submit

Response Content

Success or failure based upon the response code returned.

A failure response provides error information as shown in PUT /Application/CA/{id}.

Validate & Submit Application – Asynchronous – DO NOT USE

POST /APPLICATION/CA/{ID}/SUBMITASYNC LINK

Description:

This POST operation, based upon the unique Application ID, schedules the Merchant Application data “payload” to be validated and if there are no validation errors, the Merchant’s Application data “payload” and documents are sent to our onboarding system.

This Asynchronous scheduling operation 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/CA/{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/CA/02abc16-fdf7-406e-8c60-b514Bde23d84/ SubmitAsync?requestCallback=https://www.mycompany/applink/response

Response Content

Success or failure based upon the response code returned.

A failure response provides error information to the Callback as shown in PUT /Application/CA/{id}.

Upload Document

POST /APPLICATION/CA/{ID}/DOCUMENT LINK

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:

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

DELETE /APPLICATION/CA/{ID}/DOCUMENT/{NAME} LINK

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/CA/{id}/Document/{name}

Parameters

Name	Required	Description	Format	Example or Allowed Values
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/CA/02abc16-fdf7-406e-8c60-b514Bde23d84/Document/image.png

Response:

Success or failure based upon the response code returned.

This operation cannot be undone.

List Supporting Documents

GET /APPLICATION/CA/{ID}/DOCUMENTS LINK

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/CA/{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/CA/02abc16-fdf7-406e-8c60-b514Bde23d84/ Documents}

Response Content:

Success or failure based upon the response code returned.

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

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

Available Operations in the AppLink Web API

List Applications

GET /Application/CA/List Link

Delete Application

GET Application

UPDATE Application

Create Application

Validate Application Data – DO NOT USE

Validate Payload Data

Validate & Submit Application – Synchronous

Validate & Submit Application – Asynchronous – DO NOT USE

Upload Document

Delete Document

List Supporting Documents

GET /APPLICATION/CA/{ID}/DOCUMENTS LINK