Get Payin Requests in a Period of Time

GET 
https://api.cleverhub.co/api/v2/payins/all

This API allows you to fetch a complete list of payin linked to your app-id. You can filter the results based on multiple query params. This API is paginated. The default is 20 transactions per page.

Request

Query Parameters

from_date string
Start date to query payment requests from, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This datetime would be in UTC timezone
Example: 2022-01-01T00:00:00
to_date string
End date to query payment requests, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. The datetime would be in UTC timezone
Example: 2022-01-01T00:00:00
page string

Page number to query. Currently we support 20 records per page

per_page string

Default 20 records per page

Responses

200

OK

application/json

Schema

Schema

per_pageinteger
pageinteger
total_pageinteger
records object[]
Array [
uuidstring
Unique Id in system.
namestring
Customer name
emailstring
Customer email.
external_idstring
Custom ID.
statuspending | received | expired | return_pending | return_received | return_expired
pay_code object
Code using pay
pay_urlstring
currencystring
gstboolean
amountnumber
gst_amountnumber
totalnumber
paid_amountnumber
payment_methodstring
descriptionstring
is_refundableboolean
expired_atdate-time
pay_bydate-time
webhook_notification object
endpoint_urlstring
authorization_headerstring
]

Example (auto)

{
  "total": 100,
  "page": 1,
  "per_page": 20,
  "records": [
    {
      "uuid": "VMMAOTFQ",
      "name": "Luyx",
      "email": "luyx@helloclever.co",
      "external_id": "123456",
      "status": "pending",
      "pay_code": {
        "pay_url": "https://api.cleverhub.co/v1/shorted_url?hash=ApvZIZ9"
      },
      "currency": "PHP",
      "gst": true,
      "amount": "1000.0",
      "gst_amount": "100.0",
      "total": "1100.0",
      "paid_amount": "0",
      "payment_method": "ph_ewallet_gcash_php",
      "description": "description",
      "is_refundable": "false",
      "expired_at": "2021-12-23T06:00:00.000+0000",
      "pay_by": "2021-12-23T06:00:00.000+0000",
      "webhook_notification": {
        "endpoint_url": "https://helloclever.co",
        "authorization_header": "****"
      }
    }
  ]
}

400

Bad Request

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

{
  "errors": {
    "code": "string",
    "message": "string"
  }
}

Example

{
  "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/payins/all");
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

from_date — query

to_date — query

page — query

per_page — query

ResponseClear

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