Skip to main content
POST
/
detail
Detail
curl --request POST \
  --url https://test.paysight.io/customerapi/detail \
  --header 'Authorization: <api-key>' \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '
{
  "parentCompanyId": 1,
  "userEmail": "care@yourdomain.com",
  "id": "fd6562a1-e0e7-4b8b-b0d4-f20359482dd1",
  "getSearchData": true,
  "getAddressData": true,
  "getSubscription": true,
  "getSessionData": true
}
'
{
  "success": true,
  "message": "",
  "transaction": {
    "gateway": "Decline Defense",
    "messageID": "429b7902-33de-416c-ab98-3d165870bcec",
    "orderId": 191582180,
    "sent": "2024-09-17T14:08:50.257",
    "email": "shanec@paysight.io",
    "application": "Sub Start MID Retry",
    "applicationID": 209,
    "customerID": 38284156,
    "shortcodeID": 1533,
    "billingCode": "FlexCharge - CommerceConnect - Grand Med",
    "data": "19 Day Renewal.Charge FAILED: Do Not Honor - 29.990 NMITransId:9943005219 FlexCharge rescue attempt",
    "status": "Submitted",
    "statusID": 1789,
    "success": false,
    "completed": null,
    "premium": 1,
    "currency": "USD",
    "pricePointID": 31566,
    "pricePoint": "$29.990",
    "priceVal": 29.99,
    "product": "US - RibbedDecor",
    "productID": 8324,
    "campaign": "None/Unassigned",
    "campaignID": 0,
    "shopId": 1300430925,
    "storeName": "Ribbedecor",
    "storeDomain": "www.ribbedecor.com",
    "storeRootDomain": "ribbedecor.com",
    "merchantAccountId": 608,
    "midName": "DeclineDefense - Commerce Connect - Grand Media",
    "mid": "flexComConGrandMedia",
    "companyId": 103,
    "company": "Grand Media Inc.",
    "parentCompanyId": 100,
    "parentCompany": "Commerce Connect",
    "bin": "535456",
    "last4": 1742,
    "sessionId": "20240829140820431062231114683",
    "name": "Shane Connolly",
    "refundable": false,
    "refunded": false,
    "hasAlert": false,
    "chargedBack": false,
    "attempt": 2,
    "authOnly": false,
    "paymentNumber": 1,
    "totalAttempt": 2,
    "refundSource": 0,
    "alertType": 0,
    "alertSource": 0,
    "originalMessageId": null,
    "originalApplicationId": 209,
    "originalApplication": "Sub Start MID Retry",
    "storeCurrency": "USD",
    "blackListing": 0,
    "alertSourceName": "Unassigned",
    "alertTypeName": "Unassigned",
    "refundSourceName": "Unassigned",
    "applePay": false,
    "googlePay": false,
    "paysightSession": "20240829140820431062231114683",
    "partnerSession": "<string>",
    "cardBrandId": 123,
    "cardBrand": "<string>",
    "childTransactions": "<array>"
  },
  "addressData": {
    "addressType": "DEFAULT",
    "email": "joe@bloggs.com",
    "orderId": 1095654254,
    "messageId": "fd6562a1-e0e7-4b8b-b0d4-f20359482dd1",
    "firstName": "Joe",
    "lastName": "Bloggs",
    "address": "Apartment 4a, 387 Central Drive",
    "city": "Pittsburg",
    "postalCode": "90210",
    "state": "CA",
    "countryCode": "US",
    "phone": "212-918-5634"
  },
  "subscriptions": [
    {
      "parentCompanyId": 1,
      "companyId": 1,
      "company": "ACME corp",
      "id": 7990926,
      "customerID": 33722514,
      "subDate": "2024-09-19T15:22:50.973",
      "orderId": 1095654254,
      "active": true,
      "unsubDate": "2024-09-26T15:22:50.973",
      "subscription": "Great Content Service 1",
      "subscriptionDescription": "Great Content Service",
      "realStartDate": "2024-09-20T15:22:50.973",
      "rebillAmount": 29.99,
      "frequency": 30,
      "merchantAccountId": 547,
      "midName": "US - Awesome Brand - Payarc - Axiom",
      "mid": "10000051215420",
      "frozen": false,
      "rebillDate": null
    }
  ],
  "sessionData": {
    "id": "202409191522153660214662",
    "ip": "232.56.99.102",
    "useragent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0",
    "url": "https://yoursite.com/youroffer",
    "timestamp": "2024-09-19T15:22:50.973",
    "ipCity": "Dublin",
    "ipCountryCode": "Ireland"
  },
  "cart": [
    {
      "Quantity": 123,
      "ShopifyVariantId": 123,
      "UnitPrice": 123,
      "ShopifyProductId": 123,
      "MessageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ShopId": 123,
      "CurrencyId": 123,
      "UnitCost": 123,
      "DiscountCodeId": 123,
      "DiscountAmount": 123,
      "SalesStrategyId": 123,
      "CustomDiscountAmount": 123
    }
  ],
  "shopifyProducts": [
    {
      "id": 123,
      "shop_id": 123,
      "title": "<string>",
      "vendor": "<string>",
      "product_type": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "handle": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "imageid": 123,
      "status": "<string>",
      "last_refresh": "2023-11-07T05:31:56Z",
      "options": [
        {
          "id": 123,
          "product_id": 123,
          "name": "<string>",
          "position": 123,
          "values": "<string>"
        }
      ],
      "variants": [
        {
          "id": 123,
          "product_id": 123,
          "title": "<string>",
          "price": 123,
          "sku": "<string>",
          "position": 123,
          "compare_at_price": 123,
          "fulfillment_service": "<string>",
          "option1": "<string>",
          "option2": "<string>",
          "option3": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "requires_shipping": true,
          "inventory_item_id": 123,
          "image_id": 123,
          "cost": 123
        }
      ],
      "images": [
        {
          "id": 123,
          "product_id": 123,
          "width": 123,
          "height": 123,
          "src": "<string>",
          "position": 123
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.paysight.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Your Paysight API key. You can find it in your Paysight account at https://app.paysight.io/settings/account

Headers

​
ClientId
string
required

Your Paysight Tenant/Client Id. This is the id of the parent company listed in https://app.paysight.io/management/companies. Alternatively, this will be provided by Paysight

​
UserEmail
string
required

The email address of the party or group making the request

Body

application/json

Payload

​
parentCompanyId
integer
required

Your Paysight tenant id. This will be provided by Paysight.

Example:

1

​
userEmail
string<email>
required

An email associated with the party/agent making the request

Example:

"care@yourdomain.com"

​
id
string<uuid>
required

The unique Paysight transaction id

Example:

"fd6562a1-e0e7-4b8b-b0d4-f20359482dd1"

​
getSearchData
boolean

If true, then response includes the transaction object, i.e the same data that is returned in the /search endpoint (for this transaction). Set to false to minimize response payload if not needed

Example:

true

​
getAddressData
boolean

If true, response includes addressData array, which contains default address and shipping address (if entered)

Example:

true

​
getSubscription
boolean

If true, response includes subcription array of subscription(s) related to this transaction

Example:

true

​
getSessionData
boolean

If true, response includes sessionData object, which includes user's Paysight sessionid, IP address and device information

Example:

true

Response

200 - application/json

Valid Request. More detailed info will be in the JSON body

​
success
boolean

This indicates if this request was processed successfully, no validation issues etc.

Example:

true

​
message
string

Debug information

Example:

""

​
transaction
object
​
addressData
object
​
subscriptions
object[]

Array of subscription objects (generally 1 or max 2) that relate to this transaction

​
sessionData
object
​
cart
object[]

List of line items associated with this transaction (refund or original order).

​
shopifyProducts
object[]

List of Shopify products related to this transaction.