Verifi Provider Search

POST https://uat-txfind.payshield.ai/api/v2/provider/verifi/orders

Request Body

Verifi V3 Provider Search

Search for an Verifi V3 enabled merchant's transaction details.

POST//api/v2/provider/verifi/orders

Authorization

bearerAuth

Body

application/json

The supplied JSON payload from Verifi.

insightIdstring

Verifi's unique identifier for the Order Insight request to the network Format = UUID version 3.

Example: "451307df-137b-476c-b5d3-4022df881548"

verifiEntityInfoobject

Information related to partners and clients in the Verifi system.

sourcestring

Identifies the source of the Order Lookup Request.

Example: "OID"

cardBinstring

The six or eight-digit card Issuer BIN associated with the purchase.

Example: "111111"

cardLast4string

The six or eight-digit card Issuer BIN associated with the purchase.

Example: "9854"

paymentTypestring

Indicates the payment type of the original purchase.

Example: "string"

paymentDescriptorstring

The Merchant name component of the billing descriptor which appears on the customer's transaction statement.

Example: "string"

transactionDatestring (date)

ISO 8601 string format without milliseconds (Example = YYYY-MM-DDThh:mm:ssZ).

Example: "2023-10-11T04:00:00Z"

transactionAmountobject

Transaction Amount Object.

transactionRequestIdstring

Not a unique value, this is a hashed value based on key input fields used to locate a previous request with the same key input fields.

Example: "82ce1744-2a85-347c-bd86-6a370d756d24"

Response

200400401404default

Response

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('//api/v2/provider/verifi/orders', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401404

{
  "msg": "Get transaction details failed"
}

Name	Type	Description
insightId	String	"Please add the description here"
verifiEntityInfo	JSON	"Please add the description here"
verifiEntityInfo.partnerId	Number	"Please add the description here" NOTE: This field is inside the verifiEntityInfo JSON
verifiEntityInfo.clientId	Number	"Please add the description here" NOTE: This field is inside the verifiEntityInfo JSON
paymentType	String	"Please add the description here"
paymentDescriptor	String	"Please add the description here"
transactionDate	Datetime	"Please add the description here" NOTE: Format should be in ISO 8601
transactionAmount	JSON	"Please add the description here"
transactionAmount.amount	Number	"Please add the description here" NOTE: This field is inside the transactionAmount JSON
transactionAmount.currency	String	"Please add the description here" NOTE: This field is inside the transactionAmount JSON
cardLast4	String	The last 4 digits of the card number associated with the purchase.
cardBin	String	The six-digit card Issuer BIN associated with the purchase.
transactionRequestId	String	The hash value based on key input fields used to locate a previous request with the same key input fields. Format: UUID version 3
source	String	Identifies the source of the Order Request: Order Insight request from an Issuer via a Portal or API request (OrderInsight OIP), Order Insight request from a Cardholder via an Issuer Mobile Application or Digital Channel (Order Insight Digital OIM). Enumerated values: OIP, OIM