Get Payin Details
GEThttps://api.cleverhub.co/api/v2/payins/detail
This API allows you to fetch the details of a specific payin request. You can use the UUID to retrieve the details of a specific payment request.
Request
Query Parameters
uuid any
Unique ID in system.
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (auto)
- AUD PayID
- PHP Bank Maya
- PHP EWallet GCash
- PHP Bank Transfer
- IDR Bank QRIS
- IDR EWallet DANA
- VND Viet QR
- VND Momo Ewallet
- MYR Bank Duitnow
- MYR Bank FPX
- JPY Bank Transfer
- USDC Bank
- Interac CAD
- NGN Bank Transfer
- ZAR Instant EFT
- GHS Mobile Money
- KES Mobile Money
- XAF Mobile Money
- XOF Mobile Money
- BRL PIX
- THB ThaiQR
Schema
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
currencystring
gstboolean
amountnumber
gst_amountnumber
totalnumber
paid_amountnumber
payment_methodstring
descriptionstring
is_refundableboolean
expired_atdate-time
pay_bydate-time
webhook_notification object
{
"uuid": "string",
"name": "string",
"email": "string",
"external_id": "string",
"status": "string",
"pay_code": {
"redirect_url": "string"
},
"currency": "string",
"gst": true,
"amount": 0,
"gst_amount": 0,
"total": 0,
"paid_amount": 0,
"payment_method": "string",
"description": "string",
"is_refundable": true,
"expired_at": "2024-07-29T15:51:28.071Z",
"pay_by": "2024-07-29T15:51:28.071Z",
"webhook_notification": {
"endpoint_url": "string",
"authorization_header": "string"
}
}
AUD PayID
{
"currency": "AUD",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "au_payid_npp_aud",
"payin_method_params": {
"first_name": "Test",
"last_name": "Clever",
"phone": "+61123456789",
"country_code": "AU",
"state_code": "NSW",
"address": "40 Peel Street",
"city": "Canley Heights",
"zip_code": "2166",
"ip_address": "1.40.183.234"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
PHP Bank Maya
{
"currency": "PHP",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "ph_bank_maya_php",
"payin_method_params": {},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
PHP EWallet GCash
{
"currency": "PHP",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "ph_ewallet_gcash_php",
"payin_method_params": {},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
PHP Bank Transfer
{
"currency": "PHP",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "ph_bank_php",
"payin_method_params": {
"callback_url": "https://helloclever.co",
"bank_code": "ubp"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
IDR Bank QRIS
{
"currency": "IDR",
"amount": 100000,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "id_bank_qris_idr",
"payin_method_params": {},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
IDR EWallet DANA
{
"currency": "IDR",
"amount": 100,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "id_ewallet_dana_idr",
"payin_method_params": {
"callback_url": "https://helloclever.co"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
VND Viet QR
{
"currency": "VND",
"amount": 1000000,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "vn_other_vietqr_vnd",
"payin_method_params": {},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
VND Momo Ewallet
{
"currency": "VND",
"amount": 1000000,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "vn_ewallet_momo_vnd",
"payin_method_params": {},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
MYR Bank Duitnow
{
"currency": "MYR",
"amount": 10000,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "my_bank_duitnow_myr",
"payin_method_params": {
"account_name": "Hello Clever"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
MYR Bank FPX
{
"currency": "MYR",
"amount": 10000,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "my_bank_fpx_myr",
"payin_method_params": {
"bank_type": "01",
"bank_code": "TEST0021",
"callback_url": "https://example.com"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
JPY Bank Transfer
{
"currency": "JPY",
"amount": 10000,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "jp_bank_jpy",
"payin_method_params": {
"user_id": "123",
"ip_address": "134.168.161.19",
"first_name": "チュオン",
"last_name": "チュオン"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
USDC Bank
{
"currency": "USDC",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "usdc_bank",
"payin_method_params": {
"callback_url": "https://helloclever.co",
"original_amount": 100,
"original_currency": "USD"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
Interac CAD
{
"currency": "CAD",
"name": "Hello Clever",
"gst": "false",
"amount": "100",
"email": "test@helloclever.co",
"payin_method_name": "ca_interac_cad",
"payin_method_params": {
"callback_url": "https://helloclever.co"
},
"description": "Payin",
"expired_at": null,
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
}
}
NGN Bank Transfer
{
"currency": "NGN",
"name": "Hello Clever",
"gst": "false",
"amount": 1000,
"email": "test@helloclever.co",
"payin_method_name": "ng_bank_ngn",
"payin_method_params": {},
"description": "Payin",
"expired_at": null,
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
}
}
ZAR Instant EFT
{
"currency": "ZAR",
"name": "Hello Clever",
"gst": "false",
"amount": 1000,
"email": "test@helloclever.co",
"payin_method_name": "sa_eft_zar",
"payin_method_params": {
"bank_code": "0001"
},
"description": "Payin",
"expired_at": null,
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
}
}
GHS Mobile Money
{
"currency": "GHS",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "gh_mobile_money_ghs",
"payin_method_params": {
"account_number": "233240000000"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
KES Mobile Money
{
"currency": "KES",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "ke_mobile_money_kes",
"payin_method_params": {
"account_number": "254700000000"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
XAF Mobile Money
{
"currency": "XAF",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "cm_mobile_money_xaf",
"payin_method_params": {
"account_number": "237600000000"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
XOF Mobile Money
{
"currency": "XOF",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "ci_mobile_money_xof",
"payin_method_params": {
"account_number": "22500000000000"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
BRL PIX
{
"currency": "BRL",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "br_pix_brl",
"payin_method_params": {
"callback_url": "https://localhost.com",
"document_type": "CPF",
"document_number": "12345678901"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
THB ThaiQR
{
"currency": "THB",
"amount": 500,
"name": "Hello Clever",
"gst": false,
"email": "test@helloclever.co",
"payin_method_name": "th_qrpay_thb",
"payin_method_params": {
"callback_url": "https://localhost.com",
"payer_account_no": "12345",
"payer_account_name": "Test",
"payer_bank_code": "KBANK"
},
"description": "Test Payin",
"webhook_notification": {
"endpoint_url": "https://yourserver.co/notifications",
"authorization_header": "****"
},
"expired_at": "2021-12-23T06:00:00.000+0000"
}
Bad Request
Unauthorized
- application/json
- Schema
- Example (auto)
- Example
Schema
errors object
{
"errors": {
"code": "string",
"message": "string"
}
}
{
"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/detail");
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());
ResponseClear