Verifi Provider Order Search

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

Request Body

Verifi V3 Provider Search

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

insightIdstring · max: 36Required

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

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

sourcestring · max: 3Required

Identifies the source of the Order Lookup Request.

Example: OID

cardBinstring · max: 8Optional

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

Example: 111111

cardLast4string · max: 4Optional

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

Example: 9854

paymentTypestring · max: 20Required

Indicates the payment type of the original purchase.

Example: string

paymentDescriptorstring · max: 25Required

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

Example: string

transactionDatestring · date · max: 20Required

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

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

transactionRequestIdstring · max: 36Required

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

Responses

200

Response

application/json

400

Error

application/json

401

Unauthorized

application/json

404

Order for the given lookup not found

application/json

default

Error Payload

application/json

post

/api/v2/provider/verifi/orders

HTTPcURLJavaScriptPython

POST /api/v2/provider/verifi/orders HTTP/1.1
Host: {baseUrl}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 379

{
  "insightId": "451307df-137b-476c-b5d3-4022df881548",
  "verifiEntityInfo": {
    "partnerId": 1234567890,
    "clientId": 987654321
  },
  "source": "OID",
  "cardBin": "111111",
  "cardLast4": "9854",
  "paymentType": "string",
  "paymentDescriptor": "string",
  "transactionDate": "2023-10-11T04:00:00Z",
  "transactionAmount": {
    "amount": 125.5,
    "currency": "USD"
  },
  "transactionRequestId": "82ce1744-2a85-347c-bd86-6a370d756d24"
}

{
  "merchantInformation": {
    "merchantContactPhone": "[phone]",
    "storeDetails": {
      "storeName": "Verifi Webstore"
    },
    "merchantUrl": "https://www.verifi.com",
    "merchantName": "Verifi, Inc."
  },
  "receipt": {
    "paymentInformation": {
      "paymentTaxDescription": "CA state 8%",
      "paymentTotalAmount": {
        "amount": 499,
        "currency": "USD"
      }
    },
    "productsPurchasedList": [
      {
        "quantity": 1,
        "deliveryDetails": {
          "shippingCarrier": "UPS",
          "dateOfShipment": "2023-01-27T19:11:28Z",
          "trackingNumber": "9Z99999999944444",
          "dateOfDelivery": "2023-01-30T19:11:28Z",
          "deliveryStatus": "DELIVERED"
        },
        "unitPriceAmount": {
          "amount": 147.25,
          "currency": "USD"
        },
        "productUrl": "https://www.verifi.com/product/3737",
        "productType": "TOOLS",
        "productDescription": "Mini Wood Chipper, 7 HP 212cc Gasoline Engine, 3in Max Diameter",
        "artistOrSeller": "BestSupplier"
      }
    ]
  }
}

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