Actions

1 1. Introduction
2 2. Accept/Reject Transaction - API
3 3. Cancel Transaction - API
4 4. Refund Transaction - API
5 5. Full Refund
6 6. Partial Refund
7 7. Electronic Verification (EV) Transactions

1. Introduction

Execute the following steps to import the Postman collection:

In Postman, click Import.
Select Import File.
Select the files.

2. Accept/Reject Transaction - API

Transactions can be accepted or rejected based on decisions.

To complete this task, to accept or reject a transaction, retrieve the ID from the notification Outstanding Tasks Object.

These requests are to accept or reject, document and PEP or Sanction Review, and are only applicable when this Outstanding Tasks Object is present in your notifications.

It will not be visible via a status request, send a notification request to see this, if you have not received the notification.

Refer to Get Request for more information.

Accept/Reject Requests will only work if the transaction has not reached its final state.
If you have received the notification with a state of “SUCCESS”, then the transaction has reached its final state, and these requests will not be valid.

Request Method: POST

Required Headers

Complete the appropriate header information.

The API Headers information are provided by the ISX relationship management team.

Field Name	Field Value

Field Name	Field Value
From	API client name
Authorization	Bearer API token
Content-Type	application/json

Example:

Field Name	Field Value

Field Name	Field Value
From	Test_APIClient
Authorization	Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE
Content-Type	application/json

The word Bearer must be present in the API token or else an error will result.

Accept Transaction

Request URL: POST /v1/tasks/ID/accept

Reject Transaction

Request URL: POST /v1/tasks/ID/reject

3. Cancel Transaction - API

The Cancel Transaction Request will only work if the transaction has not reached its final state.

If you have received the notification with a state of “SUCCESS”, then the transaction has reached its final state, and this request will not be valid.

Cancel Transaction request uses the transaction ID to cancel the transaction.

Refer to Transaction Events & States for more info on transaction states.

Required Headers

Fill in the appropriate header information.

The API Header information is provided by the ISX relationship management team.

Field Name	Field Value

Field Name	Field Value
From	API client name
Authorization	Bearer API token
Content-Type	application/json

Example:

Field Name	Field Value

Field Name	Field Value
From	Test_APIClient
Authorization	Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE
Content-Type	application/json

Request URL: POST /v1/transaction/iSignthis-transaction-ID/cancel

Once a transaction is successfully cancelled, an HTTP status code will be sent

4. Refund Transaction - API

Required Headers

Fill in the appropriate header information.

The API Header information is provided by the ISX relationship management team.

Field Name	Field Value

Field Name	Field Value
From	API client name
Authorization	Bearer API token
Content-Type	application/json

Example:

Field Name	Field Value

Field Name	Field Value
From	Test_APIClient
Authorization	Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE
Content-Type	application/json

Request URL to refund a transaction

Request URL: POST /v1/transaction/iSignthis-transaction-ID/refund

5. Full Refund

This body is optional.

If no body is included with the POST request, then a full refund will performed.

6. Partial Refund

In order to request a partial refund, the required API body is as follows:

{
	"refund_amount":,
	"description":""
}

{
	"refund_amount":1234,
	"description":"Test refund message"
}

Sample JSON Payment Response

{
	"code":"IN_PROGRESS",
	"message":"Request has passed basic validation and is currently in progress",
	"status_url":"https://gateway.isignthis.com/v1/transaction/725136f8-acd4-4879-8bf4-f7c816cf7d79"
}

7. Electronic Verification (EV) Transactions

We obtain EV Information data across a large number of countries offering the best results in matching/verification.

The available data used to offer identity verification include public and private data, address, gender etc.

This verification process is based on each jurisdiction’s/region’s coverage needs.

The API request itself is the same as the default transactions (refer to Card Payments and/or Paydentity).

The results will be received through your notification URL (refer to the JSON sample on the right).