Update Transactions Using XML through the REST Integration Service

Fairways Debt enables you to import and edit transactions using XML files in two different ways. You can either:

Note: Only administrators can import transactions using XML files.

 

Update Transactions Using XML through the REST Integration Service

Enter a command including these parameters:

Parameter

Description

X-App-Token

Unique for each account and generated when creating the account.

uploadedFile

XML file to import.

type

Data type: text/xml

URL

URL of the Fairways Debt platform.

Version

Version of the importation type.

Note: Enter V3 by default, the latest version, unless your consultant has recommended another version for specific purposes.

The importation generates an executionId.

 

Example

Here is an example using cURL.

curl -H “X-App-Token:[token]” --form “uploadedFile=[name of the file to import];type=text/xml” https://[URL]/rest/integration/upload/[version]
curl -H “X-App-Token:sred23-noy966-eb3377” --form “uploadedFile=transactions.xml;type=text/xml” https://debt.hivedev.net/rest/integration/upload/v3

 

Verify the Importation Status

If some transactions are rejected, verify the importation report using the executionId. Enter a command including these parameters:

Parameter

Description

X-App-Token

Unique for each account and generated when creating the account.

URL

URL of the Fairways Debt platform.

executionId

Unique ID generated after a transaction importation.

 

Example

Here is an example using cURL.

curl -H “X-App-Token:[token]” https://[URL]/rest/integration/status?executionId=[ID]
curl -H “X-App-Token:sred23-noy966-eb3377” https://debt.hivedev.net/rest/integration/status?executionId=835926
Was this article helpful?
0 out of 0 found this helpful