Get Static PayID List

GET 
https://api.cleverhub.co/api/v1/customers/get_static_open_payids

Retrieve a comprehensive list of all Static Open PayIDs registered under your account. This endpoint allows for efficient management of Static PayIDs by providing options to filter the results based on customer-specific identifiers. You can filter by email, PayID, or customer ID to quickly locate and review relevant Static PayIDs.

Static Open PayIDs are reusable identifiers that link directly to customer details, streamlining future payment interactions and providing a persistent payment method. This list can be used to monitor, manage, and organise Static PayIDs within your account.

Request

Query Parameters

email string

Filter the list by the customer’s email address to retrieve associated Static PayIDs.

payid string

Filter the list by a specific PayID to retrieve matching records.

customer_id string

Filter the list by the customer’s unique ID to retrieve associated Static PayIDs.

Responses

200

Static Open PayID list retrieved successfully.

application/json

Schema

Schema

totalinteger
Total number of Static PayID records found.
Example: 20
pageinteger
Current page of the results.
Example: 1
total_pageinteger
Total number of pages available.
Example: 1
records object[]
Array [
idinteger
Unique identifier for the Static PayID record.
Example: 1
namestring
Name associated with the Static PayID.
Example: Sample Name
addressstring
Full address linked with the Static PayID.
Example: 123 Sample Street
emailstring
Email address associated with the Static PayID.
Example: user@example.com
citystring
City of the customer.
Example: Sample City
state_namestring
State of the customer's location.
Example: Sample State
zip_codestring
Postal code of the customer’s location.
Example: 12345
static_payidstring
The Static PayID associated with the customer.
Example: samplepayid@example.com
external_idstring
Custom identifier set by the merchant to reference the Static PayID.
Example: ext-12345
statusstring
Current status of the Static PayID.
Possible values: [active, expired]
Example: active
]

Example (auto)

{
  "total": 20,
  "page": 1,
  "total_page": 1,
  "records": [
    {
      "id": 1,
      "name": "Sample Name",
      "address": "123 Sample Street",
      "email": "user@example.com",
      "city": "Sample City",
      "state_name": "Sample State",
      "zip_code": "12345",
      "static_payid": "samplepayid@example.com",
      "external_id": "ext-12345",
      "status": "active"
    }
  ]
}

400

Bad Request

401

Unauthorized

Authorization: app-id

name: app-idtype: apiKeyin: headerdescription: A unique identifier assigned to each application.

name: secret-keytype: apiKeyin: headerdescription: A secure token associated with the `app-id`.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v1/customers/get_static_open_payids");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

email — query

payid — query

customer_id — query

ResponseClear

Click the Send API Request button above and see the response here!