In this page you can find a Postman collection of API calls for the below actions.  here

Follow these steps to import the collection:

     – In Postman, click Import.

     – Choose Import File.

     – Choose Files.

Accept/Reject Transaction - API

Transactions can be accepted or rejected based on decision.

In order to complete this task, to accept or reject a transaction, you need to retrieved the ID from the notification Outstanding Tasks Object.

These requests are to accept or reject Document and PEP/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, you would need to send a notification request to see this, if you have not received the notification. Please visit Get Request tab for more information.

It’s important to note that 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

Fill in the appropriate header information. The API Headers information are provided by the iSignthis Merchant Support team. 

Field Name Field Value
From API client name
Authorization Bearer API token
Content_type application/json

Example:
Field Name Field Value
From Test_APIClient
Authorization Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE
Content_type application/json

 

Accept Transaction 

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

Example: www.test.com/v1/tasks/u1djo3rfd/accept

                                       OR

Reject Transaction

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

Example: www.test.com/v1/tasks/u1djo3rfd/reject

Cancel Transaction - API

Only card transactions may be cancelled.

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

It’s important to note that 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. 

Please follow the Transaction states for more info on transaction states.

Request Method: POST

Required Headers 

Fill in the appropriate header information. The API Header information are provided by the iSignthis Merchant Support team.

Field Name Field Value
From API client name
Authorization Bearer API token
Content_type application/json

Example:
Field Name Field Value
From Test_APIClient
Authorization Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE
Content_type application/json

 

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

Example: https://test.com/v1/transaction/256b4622-ea1d-4af0-8326/cancel

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

Refund Transaction - API

These actions can only be applied in the case of a successful transaction.

Only card transactions may be refunded.

 

Request Method: POST

Required Headers

Fill in the appropriate header information. The API Header information is provided by the iSignthis Merchant Support team.

Field Name Field Value
From API client name
Authorization Bearer API token
Content_type application/json

Example:
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

Example: https://test.com/v1/transaction/256b4622-ea1d-4af0-8326/refund

Full Refund

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

Partial Refund

In order to request for a partial refund, the required API body is

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

 

EV Transaction

Information on 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 (Acquiring/Paydentity).

The results will be received through your notification URL (see JSON sample below and can be actioned from an API call here).

Note : For successful EV additional parameters are mandatory based on country:
US, AU, CA – residential_address_subdivision Valid state (for countries that have states)
UK – residential_address_postal_code
 a valid UK post code in proper format
Germany – gender (male/female/other) external verification meta object

{
    "match": "NO_MATCH",
    "detail": {
        "CREDIT_BUREAU_CONSUMER_NAME_ADDRESS": "0",
        "TENANCY_DATABASE_NAME_DOB": "0",
        "TENANCY_DATABASE_NAME_ADDRESS": "0",
        "HISTORICAL_ELECTORAL_NAME_ADDRESS": "0",
        "CREDIT_BUREAU_PUBLIC_RECORD_NAME_DOB": "0",
        "CREDIT_BUREAU_COMMERCIAL_NAME_DOB": "0",
        "CREDIT_BUREAU_CONSUMER_NAME_DOB": "0",
        "CREDIT_BUREAU_PUBLIC_RECORD_NAME_ADDRESS_DOB": "0",
        "CREDIT_BUREAU_CONSUMER_NAME_ADDRESS_DOB": "0",
        "PROPRIETARY_TELEPHONE_DIRECTORY_NAME_ADDRESS": "0",
        "ELECTORAL_NAME_ADDRESS": "0",
        "CREDIT_BUREAU_COMMERCIAL_NAME_ADDRESS_DOB": "0",
        "CREDIT_BUREAU_PUBLIC_RECORD_NAME_ADDRESS": "0",
        "CREDIT_BUREAU_COMMERCIAL_NAME_ADDRESS": "0",
        "TELEPHONE_DIRECTORY_NAME_ADDRESS": "0",
        "TENANCY_DATABASE_NAME_ADDRESS_DOB": "0",
        "NAME_DOB_PASSPORT": "0"
        }
}