Skip to main content

​
Find Customer Schemas

API endpoints for helping merchants discover customers on their behalf.

​
Endpoints

MethodEndpointDescription
GET/v1/customer/banksFind banks associated with customer email
POST/v1/customer/device/lookupIdentify customer through device fingerprinting

​
GET /v1/customer/banks

Find which banks a customer is associated with using their email address on behalf of a merchant.

​
Query Parameters

ParameterTypeRequiredDescription
emailstringYesCustomer email address
entityIdstringYesMerchant entity ID

​
Response Schema

{
  "statusCode": 200,
  "success": true,
  "message": "Customer banks retrieved successfully",
  "data": {
    "banks": [
      {
        "bankId": "string",
        "bankName": "string",
        "accountName": "string",
        "phrase": "string",
        "customerName": "string"
      }
    ]
  }
}

​
Response Fields

FieldTypeDescription
bankIdstringUnique bank identifier
bankNamestringBank name
accountNamestringMasked account identifier
phrasestringLookup phrase for transactions
customerNamestringObfuscated customer name

​
POST /v1/customer/device/lookup

Identify customers through device fingerprinting on behalf of a merchant.

​
Request Body

{
  "deviceId": "string",
  "entityId": "string"
}

​
Request Schema

FieldTypeRequiredDescription
deviceIdstringYesDevice identifier for lookup
entityIdstringYesMerchant entity ID

​
Response Schema

{
  "statusCode": 200,
  "success": true,
  "message": "Device lookup successful",
  "data": {
    "bankId": "string",
    "bankName": "string",
    "accountName": "string",
    "phrase": "string",
    "customerName": "string"
  }
}

​
Response Fields

FieldTypeDescription
bankIdstringAssociated bank identifier
bankNamestringBank name
accountNamestringMasked account information
phrasestringLookup phrase for billing
customerNamestringPrivacy protected customer name

​
Error Responses

​
400 Bad Request

{
  "statusCode": 400,
  "success": false,
  "message": "Invalid email format"
}

​
403 Forbidden

{
  "statusCode": 403,
  "success": false,
  "message": "Merchant not authorized for device lookup"
}

​
404 Not Found

{
  "statusCode": 404,
  "success": false,
  "message": "Device not found in system"
}