Get Request

1 1. Get Transaction State
2 2. Get Transactions and States per RID
3 3. Get Transaction Notifications
4 4. Get Identity Details

1. Get Transaction State

The GET request consists of three steps: Method, URL, and Header.

Method

Method used: GET

Example: GET /v1/authorization/iSignthis-transaction-ID

URL

Production Environment URL: https://gateway.isignthis.com/v1/authorization/iSignthis-transaction-ID

Header

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

Example:

Field Name	Field Value

Field Name	Field Value
From	Test_APIClient
Authorization	Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE

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

Response Body

The response to a transaction state request.

Field	Type	Description

Field	Type	Description
id	String	Unique response identification code.
secret	String	The transaction secret code.
expires_at	String	The transaction expiry (JavaScript format).
mode	String	The transaction mode detected by ISX.
original_message	Object	Information about your transaction request.
payment_provider_responses	Object	Additional payment information.
identity	Object	Information about the identity.
workflow_state	Object	State information about the workflow.
state	String	State of the transactionRefer to Transaction Errors & States.
compound_state	String	Compound state of the transaction. Refer to Transaction Errors & States.
response_code	String	Response code of the transaction. Refer to Transaction Errors & States.
response_code_description	String	Response code description.
test_transaction	Boolean	Denotes use of test card.

Sample JSON Transaction State Response

"id":"885e3506-eb13-4d2c-bc24-e336aaf94037",
"secret":"083daa84-77b6-4817-a4f3-5771779c1c82",
"expires_at":"2016-11-29T23:34:51.275Z",
"mode":"registration",
"original_message":{
	"merchant_id":"widgets-pty-ltd",
	"transaction_id":"6efa5fac-89de-4e75-a2f9-4d34333e7cf1",
	"reference":"256b4622-ea1d-4af0-8326-a276a0627810",
	"account":{
		"identifier":"Test_ID",
		"ext":{
			
		}
	}"payment_provider_responses":[
		{
			"operation_type":"authorization-and-capture",
			"operation_successful":true,
			"provider_type":"credit_card",
			"provider_name":"ISXMock",
			"request_currency":"AUD",
			"reference_code":"685773744175750647",
			"provider_reference_code":"MOCK595737150100000",
			"response_id":"MOCK595737150100000",
			"status_code":"OK000",
			"status_description":"Success",
			"manual_reconciliation":false
		}
	],
	"workflow_state":{
		"capture":"NA",
		"charge":"NA",
		"credit":"NA",
		"3ds":"NA",
		"piv":"NA",
		"sca":"PENDING",
		"docs":"NA",
		"kyc":"NA"
	},
	"state":"PENDING",
	"compound_state":"PENDING.CONTACTING_USER",
	"identity":{
		"id":"_b103fc0_158a2f3a950__7e12",
		"download_url":"https://gateway.isignthis.com/v1/identity/_b103fc0_158a2f3a950__7e12",
		"ledger_lifetime_amount":"63828",
		"ledger_lifetime_currency":"EUR",
		"credit_ledger_lifetime_amount":"14625",
		"credit_ledger_lifetime_currency":"EUR",
		"kyc_state":"NONE",
		"created_at":"2016-11-26T23:34:51.301Z"
	},
	"response_code":"IS0101",
	"response_code_description":"Transaction in progress",
	"test_transaction":false
}

2. Get Transactions and States per RID

RID (Remote id): is the Customer ID that the merchants assign to the customers.

Each customer should have their own assigned ID, if required, use the customer ID to retrace all of transactions the customer has made.

The RID is the the identifier in the Account object.

The GET request consists of two steps: Method and URL.

Get transactions and their states per RID by GET request.

Request URL: GET /v1/transaction/states/[Merchant-ID]/[ identifier]

Method

URL

Request URL: “/v1/transaction/states/[Merchant-ID]/[ identifier]“.

Response Body

Field	Type	Description

Field	Type	Description
transaction_uid	String	Unique transaction identification code.
transaction_state	String	Compound State of the transaction. Refer to Transaction Errors & States.
state	String	State of the transaction. Refer to Transaction Errors & States.
workflow	Object	Workflow name.

"data":[
	{
		"transaction_uid":"9da124d5-69a5-485e-b657-f77add4063x1",
		"transaction_state":"OK",
		"state":"SUCCESS",
		"workflow":"PAYDENTITY"
	},
	{
		"transaction_uid":"e16dd641-490a-4e7a-9998-0154ebe2f5x2",
		"transaction_state":"MANUAL_REVIEW",
		"state":"PENDING",
		"workflow":"PAYDENTITY"
	},
	{
		"transaction_uid":"cb80b2cf-6ce8-47db-b2fe-13da00ee5dx3",
		"transaction_state":"TRANSACTION_EXPIRED",
		"state":"EXPIRED",
		"workflow":"PAYDENTITY"
	}
]

3. Get Transaction Notifications

Get Notification by Transaction ID.

The GET request consists of two steps: Method and URL.

Request URL: GET /v1/transaction/iSignthis-transaction-ID/notifications

Method

URL

Request URL: /v1/transaction/iSignthis-transaction-ID/notifications

Response Body

Refer to Notifications for more information.

4. Get Identity Details

The GET request consists of three steps: Method, URL, and Header

To find the unique isignthis-identity-id, check in the Identity Object of the notification that you received.

Method

URL

URL For Prod Environment:

Header

Complete the appropriate header information.

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

Example:

Field Name	Field Value

Field Name	Field Value
From	API client name
Authorization	Bearer API token

Example:

Field Name	Field Value

Field Name	Field Value
From	Test_APIClient
Authorization	Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE

Response Body

The response to transactions and states per unique ISX customer identity request.

Field	Type	Reference

Field	Type	Reference
profile	Object	KYC profile information. Refer to Profile Object.
supporting_documents	Array	KYC supporting documents. Refer to Supporting Documents Object.
id	String	The unique identifier for the identity, provided by ISX.

{
	"profile":{
		"title":"MR",
		"first_name":"Tester",
		"middle_name":"Tester",
		"last_name":"Tester",
		"fullname":"Tester Michelle Tester",
		"dob":"1995-03-30",
		"gender":"male",
		"citizen_country":"GB",
		"birth_country":"GB",
		"resident_country":"GB",
		"billing_address_secondary":"Test",
		"billing_address_street":"Test St",
		"billing_address_city":"Test",
		"billing_address_postal_code":"Test 0JT",
		"billing_address_country":"GB",
		"residential_address_secondary":"Test Room 5",
		"residential_address_street_number":"1",
		"residential_address_street":"Test St",
		"residential_address_city":"Test",
		"residential_address_postal_code":"Test 0JT",
		"residential_address_country":"GB",
		"email":"shana.barrows@isignthis.com",
		"remote_user_id":"TestID "
	},
	"supporting_documents":[
		
	],
	"id":"3614fdb9_3a39",
	"uid":"3614fdb9_16cf0fab35b_3a39",
	"ledger_lifetime_amount":"1182688",
	"ledger_lifetime_currency":"EUR",
	"kyc_state":"NONE",
	"created_at":"2019-09-02T08:19:18.205Z"
}