Get Request
- Home
- Get Request
GET Request can be used for three different situations: “GET Transaction State”, “GET Transactions and States per RID”, “GET User Identity Details”.
The GET request consists of three steps: Method, URL and Header
1.1 Method
Method used: GET
Example: GET /v1/authorization/iSignthis-transaction-ID
1.2 URL
URL For Stage Environment:
https://stage-gateway.isignthis.com/v1/authorization/iSignthis-transaction-ID
URL For Production Environment:
https://gateway.isignthis.com/v1/authorization/iSignthis-transaction-ID
1.3 Header
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 |
Example:
| Field Name | Field Value |
| From | Test_APIClient |
| Authorization | Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE |
1.4 Response Body
The response to a transaction state request.
| Field | Type | Description | Example |
|---|---|---|---|
| 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 iSignthis. | "registration" |
| original_message | Object | Information about your transaction request. | Original Message Object |
| payment_provider_responses | Object | Additional Payment Information | Payment Provider Response Object |
| identity | Object | Information about the identity. | Identity Object |
| workflow_state | Object | State information about the workflow. | Workflow State Object |
| state | “String” | State of the transaction. See Transaction Transaction States. |
"PENDING" |
| compound_state | “String” | Compound State of the transaction. See Transaction States. |
|
| response_code | “String” | Response code of the transaction. See Transaction States. |
"IS0101" |
| response_code_description | “String” | Response code description. |
|
| test_transaction | boolean | Denotes use of Test Card | false |
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
}
RID (Remote id): is the Customer ID that the merchants assign to the customers. Each customer should have their own assigned as, if needed, you will be using that to retrace all of transactions the customer made.
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]
2.1 Method
Method used: GET
Example: GET /v1/identity/isignthis-identity-id
2.2 URL
Request URL: “/v1/transaction/states/[Merchant-ID]/”.
Example: https://test.com/v1/transaction/states/[Merchant-ID]/
2.3 Response Body
The response to transactions and states per RID request. If no data is returned, check if merchantID and RID were properly sent.
| Field | Type | Description | Example |
|---|---|---|---|
| transaction_uid | “String” | Unique transaction identification code. |
|
| transaction_state | “String” | Compound State of the transaction. See Transaction States. |
"MANUAL_REVIEW" |
| state | “String” | State of the transaction. See Transaction States. |
"PENDING" |
| workflow | Object | Workflow name. | "PAYDENTITY" |
Sample JSON Transaction State Response:
"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"
}
]
}
The GET request consists of two steps: Method and URL.
The request is made to get the information of the user it responds with.
| Object name |
|---|
| profile |
| supporting documents |
| identity |
3.1. Method
Method used: GET.
3.2. URL
Request URL: “/v1/identity/isignthis-identity-id”.
Example: “https://stage-gateway.isignthis.com/v1/identity/f1asd4_123dsa/”
