List Payment

GET 
https://api.cleverhub.co/api/v2/cards/payments

This API allows you to fetch a complete list of card payment transactions linked to your app-id. You can filter the results using optional query parameters such as date range and status. The response is paginated with a default of 20 transactions per page.

Request

Query Parameters

start_date date-time
Filter transactions created after this date (UTC).
Example: 2024-01-01T00:00:00Z
end_date date-time
Filter transactions created before this date (UTC).
Example: 2024-01-31T23:59:59Z
page string

Page number to query. Default is 1.

per_page string

Number of records per page. Default is 20.

status string

Possible values: [pending, authorised, waiting, received, expired, return_pending, return_expired, partially_refunded, return_received, return_rejected, failed, in_dispute, dispute_lost]

Filter by transaction status.

Responses

200

Ok

application/json

Schema

Schema

per_pageinteger
pageinteger
total_pageinteger
records object[]
Array [
uuidstring
Example: 7PPPMXIGH
namestring
Example: Testing
emailstring
Example: test@example.com
external_idstring
Example: wc_order_6C1hcvg4T7Pom
statusstring
Possible values: [pending, authorised, waiting, received, expired, return_pending, return_expired, partially_refunded, return_received, return_rejected, failed, in_dispute, dispute_lost]
Example: waiting
pay_code objectnullable
3ds_urlstring
Example: https://3ds-auth.example.com/verify
currencystring
Example: USD
amountnumber
Example: 10000
totalnumber
Example: 10000
paid_amountnumber
Example: 0
is_refundableboolean
Example: true
payment_methodstring
Example: card
expired_atstring
Example:
webhook_notification object
endpoint_urlstring
Example: https://webhook.site/456adb8f-4407-4bce-90fe-2c431db19696
authorization_headerstring
Example: ****
refund_information object
total_amountnumber
Example: 200
refund_amountnumber
Example: 50
descriptionstring
Example: Testing refund
sender_details object
card object
card_typestring
Example: card
card_brandstring
Example: visa
card_last_4string
Example: 4242
created_atdate-time
Example: 2025-05-28T04:22:21.567+0000
]

Example (auto)

{
  "per_page": 0,
  "page": 0,
  "total_page": 0,
  "records": [
    {
      "uuid": "7PPPMXIGH",
      "name": "Testing",
      "email": "test@example.com",
      "external_id": "wc_order_6C1hcvg4T7Pom",
      "status": "waiting",
      "pay_code": {
        "3ds_url": "https://3ds-auth.example.com/verify"
      },
      "currency": "USD",
      "amount": 10000,
      "total": 10000,
      "paid_amount": 0,
      "is_refundable": true,
      "payment_method": "card",
      "expired_at": "",
      "webhook_notification": {
        "endpoint_url": "https://webhook.site/456adb8f-4407-4bce-90fe-2c431db19696",
        "authorization_header": "****"
      },
      "refund_information": {
        "total_amount": 200,
        "refund_amount": 50,
        "description": "Testing refund"
      },
      "sender_details": {
        "card": {
          "card_type": "card",
          "card_brand": "visa",
          "card_last_4": "4242"
        }
      },
      "created_at": "2025-05-28T04:22:21.567+0000"
    }
  ]
}

Example

{
  "total": 100,
  "page": 1,
  "per_page": 20,
  "records": [
    {
      "uuid": "PSADT5CE",
      "name": "Hello Clever",
      "email": "test@example.com",
      "external_id": "order_test_01",
      "status": "pending",
      "pay_code": null,
      "currency": "USD",
      "amount": "200.0",
      "total": "200.0",
      "paid_amount": "0.0",
      "is_refundable": false,
      "payment_method": "card",
      "expired_at": "",
      "webhook_notification": {
        "endpoint_url": "https://webhook.site/12da7803-c4cf-4f32-812d-aaeaecf20d9d",
        "authorization_header": "****"
      },
      "refund_information": null,
      "sender_details": {
        "card": {
          "card_type": "card",
          "card_brand": "visa",
          "card_last_4": "1111"
        }
      },
      "created_at": "2025-05-29T01:29:16.826+0000"
    }
  ]
}

400

Bad Request

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
Example: REQUIRE_LOGIN
messagestring
Example: Not Authorised

Example (auto)

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

Authorization: app-id

name: app-idtype: apiKeydescription: The app-id is registered and secured inside Hello Clever system and only required when client has initiated or in the middle of the transaction.in: header

name: secret-keytype: apiKeydescription: The secret-key is our client's secret of the source. Required if a publishable key is used to retrieve the source.in: header

• 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/v2/cards/payments");
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

start_date — query

end_date — query

page — query

per_page — query

status — query

---pendingauthorisedwaitingreceivedexpiredreturn_pendingreturn_expiredpartially_refundedreturn_receivedreturn_rejectedfailedin_disputedispute_lost

ResponseClear

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