curl --request POST \
--url https://test.paysight.io/customerapi/search \
--header 'Authorization: <api-key>' \
--header 'ClientId: <clientid>' \
--header 'Content-Type: application/json' \
--header 'UserEmail: <useremail>' \
--data '
{
"parentCompanyId": 1,
"userEmail": "care@yourdomain.com",
"email": "joe@bloggs.com",
"cardNumber": "535456******1742",
"name": "Joe Bloggs",
"orderId": 1095654254
}
'import requests
url = "https://test.paysight.io/customerapi/search"
payload = {
"parentCompanyId": 1,
"userEmail": "care@yourdomain.com",
"email": "joe@bloggs.com",
"cardNumber": "535456******1742",
"name": "Joe Bloggs",
"orderId": 1095654254
}
headers = {
"ClientId": "<clientid>",
"UserEmail": "<useremail>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
ClientId: '<clientid>',
UserEmail: '<useremail>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
parentCompanyId: 1,
userEmail: 'care@yourdomain.com',
email: 'joe@bloggs.com',
cardNumber: '535456******1742',
name: 'Joe Bloggs',
orderId: 1095654254
})
};
fetch('https://test.paysight.io/customerapi/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://test.paysight.io/customerapi/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parentCompanyId' => 1,
'userEmail' => 'care@yourdomain.com',
'email' => 'joe@bloggs.com',
'cardNumber' => '535456******1742',
'name' => 'Joe Bloggs',
'orderId' => 1095654254
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"ClientId: <clientid>",
"Content-Type: application/json",
"UserEmail: <useremail>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://test.paysight.io/customerapi/search"
payload := strings.NewReader("{\n \"parentCompanyId\": 1,\n \"userEmail\": \"care@yourdomain.com\",\n \"email\": \"joe@bloggs.com\",\n \"cardNumber\": \"535456******1742\",\n \"name\": \"Joe Bloggs\",\n \"orderId\": 1095654254\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ClientId", "<clientid>")
req.Header.Add("UserEmail", "<useremail>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://test.paysight.io/customerapi/search")
.header("ClientId", "<clientid>")
.header("UserEmail", "<useremail>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parentCompanyId\": 1,\n \"userEmail\": \"care@yourdomain.com\",\n \"email\": \"joe@bloggs.com\",\n \"cardNumber\": \"535456******1742\",\n \"name\": \"Joe Bloggs\",\n \"orderId\": 1095654254\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://test.paysight.io/customerapi/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ClientId"] = '<clientid>'
request["UserEmail"] = '<useremail>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentCompanyId\": 1,\n \"userEmail\": \"care@yourdomain.com\",\n \"email\": \"joe@bloggs.com\",\n \"cardNumber\": \"535456******1742\",\n \"name\": \"Joe Bloggs\",\n \"orderId\": 1095654254\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "",
"transactions": [
{
"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>"
}
]
}Search
Submits card details for payment/subscription signup
curl --request POST \
--url https://test.paysight.io/customerapi/search \
--header 'Authorization: <api-key>' \
--header 'ClientId: <clientid>' \
--header 'Content-Type: application/json' \
--header 'UserEmail: <useremail>' \
--data '
{
"parentCompanyId": 1,
"userEmail": "care@yourdomain.com",
"email": "joe@bloggs.com",
"cardNumber": "535456******1742",
"name": "Joe Bloggs",
"orderId": 1095654254
}
'import requests
url = "https://test.paysight.io/customerapi/search"
payload = {
"parentCompanyId": 1,
"userEmail": "care@yourdomain.com",
"email": "joe@bloggs.com",
"cardNumber": "535456******1742",
"name": "Joe Bloggs",
"orderId": 1095654254
}
headers = {
"ClientId": "<clientid>",
"UserEmail": "<useremail>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
ClientId: '<clientid>',
UserEmail: '<useremail>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
parentCompanyId: 1,
userEmail: 'care@yourdomain.com',
email: 'joe@bloggs.com',
cardNumber: '535456******1742',
name: 'Joe Bloggs',
orderId: 1095654254
})
};
fetch('https://test.paysight.io/customerapi/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://test.paysight.io/customerapi/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parentCompanyId' => 1,
'userEmail' => 'care@yourdomain.com',
'email' => 'joe@bloggs.com',
'cardNumber' => '535456******1742',
'name' => 'Joe Bloggs',
'orderId' => 1095654254
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"ClientId: <clientid>",
"Content-Type: application/json",
"UserEmail: <useremail>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://test.paysight.io/customerapi/search"
payload := strings.NewReader("{\n \"parentCompanyId\": 1,\n \"userEmail\": \"care@yourdomain.com\",\n \"email\": \"joe@bloggs.com\",\n \"cardNumber\": \"535456******1742\",\n \"name\": \"Joe Bloggs\",\n \"orderId\": 1095654254\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ClientId", "<clientid>")
req.Header.Add("UserEmail", "<useremail>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://test.paysight.io/customerapi/search")
.header("ClientId", "<clientid>")
.header("UserEmail", "<useremail>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parentCompanyId\": 1,\n \"userEmail\": \"care@yourdomain.com\",\n \"email\": \"joe@bloggs.com\",\n \"cardNumber\": \"535456******1742\",\n \"name\": \"Joe Bloggs\",\n \"orderId\": 1095654254\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://test.paysight.io/customerapi/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ClientId"] = '<clientid>'
request["UserEmail"] = '<useremail>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parentCompanyId\": 1,\n \"userEmail\": \"care@yourdomain.com\",\n \"email\": \"joe@bloggs.com\",\n \"cardNumber\": \"535456******1742\",\n \"name\": \"Joe Bloggs\",\n \"orderId\": 1095654254\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "",
"transactions": [
{
"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>"
}
]
}Authorizations
Your Paysight API key. You can find it in your Paysight account at https://app.paysight.io/settings/account
Headers
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
The email address of the party or group making the request
Body
Payload
Your Paysight tenant id. This will be provided by Paysight.
1
An email associated with the party/agent making the request
"care@yourdomain.com"
The email address of the customer. This is required if no other search parameters (name or card number) is provided
"joe@bloggs.com"
This can be the full 16 digit card number or the card number with the middle 6 digits redacted, as per example.
"535456******1742"
Customer name. This can be entered along with cardNumber. If entered alone then it must be at least 10 characters
"Joe Bloggs"
The unique Paysight orderId
1095654254
Response
Valid Request. More detailed info will be in the JSON body